BackblazeB2 Module

Properties   Methods   Events   Config Settings   Errors  

The BackblazeB2 module offers an easy to use interface for Backblaze's B2 Cloud Storage service.

Syntax

CloudStorage.Backblazeb2

Remarks

The BackblazeB2 class provides an easy-to-use API for the Backblaze B2 Cloud Storage service. Capabilities include uploading and downloading files, bucket management, strong encryption support, and more.

Authentication

Authentication works by exchanging a known application key (which consists of a key Id and the key string itself) for an authorization token which is then used to authorize all further requests. The authentication process also returns information about the account, the capabilities and restrictions associated with the application key, and other details that help the class interact with the Backblaze B2 API.

To authenticate the class with the server, supply an application key using the ApplicationKeyId and ApplicationKey properties, and then call Authorize. This will populate the Account* properties with the aforementioned information, including the AccountAuthToken.

Eventually, the authorization token returned during the authentication process will expire, at which point it should be exchanged for a new one by calling Authorize again.

Usage

Once authenticated, you can start interacting with the Backblaze B2 Cloud Storage service. The following list shows some of the methods used to accomplish common tasks:

• Bucket management: ListBuckets, GetBucketInfo, CreateBucket, UpdateBucket, DeleteBucket
• File management: ListFiles, ListFileVersions, GetFileInfo, UploadFile, CopyFile, DownloadFile, DownloadFileById, HideFile, DeleteFile, DeleteFileVersion
• Multipart uploads: ListMultipartUploads, StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload, ListParts, UploadPart, CopyPart
• Application key management: ListAppKeys, CreateAppKey, DeleteAppKey
• Sharing files: GetDownloadAuthToken

Refer to the complete API, below, for more information.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

Account Property (BackblazeB2 Module)

Details about the account and restrictions associated with currently-authenticated application key.

Syntax

• Swift
• Objective-C

public var account: B2Account {
  get {...}
}

@property (nonatomic,readonly,assign,getter=accountId) NSString* accountId;

- (NSString*)accountId;

@property (nonatomic,readonly,assign,getter=accountAllowedBucketId) NSString* accountAllowedBucketId;

- (NSString*)accountAllowedBucketId;

@property (nonatomic,readonly,assign,getter=accountAllowedBucketName) NSString* accountAllowedBucketName;

- (NSString*)accountAllowedBucketName;

@property (nonatomic,readonly,assign,getter=accountAllowedPrefix) NSString* accountAllowedPrefix;

- (NSString*)accountAllowedPrefix;

@property (nonatomic,readonly,assign,getter=accountAuthToken) NSString* accountAuthToken;

- (NSString*)accountAuthToken;

@property (nonatomic,readonly,assign,getter=accountCapabilities) NSString* accountCapabilities;

- (NSString*)accountCapabilities;

@property (nonatomic,readonly,assign,getter=accountMinPartSize) long long accountMinPartSize;

- (long long)accountMinPartSize;

@property (nonatomic,readonly,assign,getter=accountRecPartSize) long long accountRecPartSize;

- (long long)accountRecPartSize;

 

Default Value

""

Remarks

This property holds an B2Account object with information about the account and restrictions associated with the currently-authenticated application key; it's populated after calling Authorize.

AppKeyMarker Property (BackblazeB2 Module)

A marker indicating what page of application keys to return next.

Syntax

• Swift
• Objective-C

public var appKeyMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=appKeyMarker,setter=setAppKeyMarker:) NSString* appKeyMarker;

- (NSString*)appKeyMarker;
- (void)setAppKeyMarker :(NSString*)newAppKeyMarker;

Default Value

""

Remarks

This property will be populated when ListAppKeys is called if the results are paged and there are more pages. To list all application keys, continue to call ListAppKeys until this property returns empty string.

Refer to ListAppKeys for more information.

AppKeys Property (BackblazeB2 Module)

A collection of application keys.

Syntax

• Swift
• Objective-C

public var appKeys: Array<B2AppKey> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=appKeyCount) int appKeyCount;

- (int)appKeyCount;

- (NSString*)appKeyAllowedBucketId:(int)appKeyIndex;

- (NSString*)appKeyAllowedPrefix:(int)appKeyIndex;

- (NSString*)appKeyCapabilities:(int)appKeyIndex;

- (long long)appKeyExpirationTime:(int)appKeyIndex;

- (NSString*)appKeyId:(int)appKeyIndex;

- (NSString*)appKeyName:(int)appKeyIndex;

Default Value

""

Remarks

This collection holds a list of B2AppKey items.

Calling ListAppKeys will populate this collection.

ApplicationKey Property (BackblazeB2 Module)

The application key to use for authentication.

Syntax

• Swift
• Objective-C

public var applicationKey: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=applicationKey,setter=setApplicationKey:) NSString* applicationKey;

- (NSString*)applicationKey;
- (void)setApplicationKey :(NSString*)newApplicationKey;

Default Value

""

Remarks

This property specifies the application key that should be used for authentication. Both this property and ApplicationKeyId must be set before attempting any operations which connect to the server.

ApplicationKeyId Property (BackblazeB2 Module)

The application key Id to use for authentication.

Syntax

• Swift
• Objective-C

public var applicationKeyId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=applicationKeyId,setter=setApplicationKeyId:) NSString* applicationKeyId;

- (NSString*)applicationKeyId;
- (void)setApplicationKeyId :(NSString*)newApplicationKeyId;

Default Value

""

Remarks

This property specifies the application key Id that should be used for authentication. Both this property and ApplicationKey must be set before attempting any operations which connect to the server.

Buckets Property (BackblazeB2 Module)

A collection of buckets.

Syntax

• Swift
• Objective-C

public var buckets: Array<B2Bucket> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=bucketCount) int bucketCount;

- (int)bucketCount;

- (NSString*)bucketId:(int)bucketIndex;

- (NSString*)bucketKind:(int)bucketIndex;

- (NSString*)bucketName:(int)bucketIndex;

- (long long)bucketRevision:(int)bucketIndex;

Default Value

""

Remarks

This collection holds a list of B2Bucket items.

Calling ListBuckets will populate this collection.

ContentType Property (BackblazeB2 Module)

The content type to send for a file.

Syntax

• Swift
• Objective-C

public var contentType: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=contentType,setter=setContentType:) NSString* contentType;

- (NSString*)contentType;
- (void)setContentType :(NSString*)newContentType;

Default Value

""

Remarks

This property can be set before calling UploadFile, StartMultipartUpload, or (if the SendMetadataOnCopy configuration setting is enabled) CopyFile to have its value submitted as the file's Content-Type header value.

If this property is empty, the class will send b2/x-auto, which instructs the server to automatically determine the content type based on the file's extension (or set it to application/octet-stream if it cannot).

Delimiter Property (BackblazeB2 Module)

The delimiter string to use when listing files.

Syntax

• Swift
• Objective-C

public var delimiter: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=delimiter,setter=setDelimiter:) NSString* delimiter;

- (NSString*)delimiter;
- (void)setDelimiter :(NSString*)newDelimiter;

Default Value

""

Remarks

If this property is non-empty when ListFiles or ListFileVersions is called, any items whose names contain the same string between the specified Prefix and the first occurrence of the specified delimiter that follow will be rolled up into a virtual "folder" element, which is returned in place of the individual files themselves.

If a particular item is a "folder" instead of an actual file or file version, then the FilesKind property will be set to folder. The same is also true of the FileList event's Kind parameter.

File Hierarchy Traversal

By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:

EncryptionAlgorithm Property (BackblazeB2 Module)

The encryption algorithm.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: Backblazeb2EncryptionAlgorithms {
  get {...}
  set {...}
}

public enum Backblazeb2EncryptionAlgorithms: Int32 {
  case eaAES = 0
  case eaBlowfish = 1
  case eaCAST = 2
  case eaDES = 3
  case eaIDEA = 4
  case eaRC2 = 5
  case eaRC4 = 6
  case eaTEA = 7
  case eaTripleDES = 8
  case eaTwofish = 9
  case eaRijndael = 10
  case eaChaCha = 11
  case eaXSalsa20 = 12
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) int encryptionAlgorithm;

- (int)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(int)newEncryptionAlgorithm;

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

EncryptionPassword Property (BackblazeB2 Module)

The encryption password.

Syntax

• Swift
• Objective-C

public var encryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionPassword,setter=setEncryptionPassword:) NSString* encryptionPassword;

- (NSString*)encryptionPassword;
- (void)setEncryptionPassword :(NSString*)newEncryptionPassword;

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

FileData Property (BackblazeB2 Module)

The data that was downloaded, or that should be uploaded.

Syntax

• Swift
• Objective-C

public var fileData: String {
  get {...}
  set {...}
}

public var fileDataB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fileData,setter=setFileData:) NSString* fileData;

- (NSString*)fileData;
- (void)setFileData :(NSString*)newFileData;

@property (nonatomic,readwrite,assign,getter=fileDataB,setter=setFileDataB:) NSData* fileDataB;

- (NSData*)fileDataB;
- (void)setFileDataB :(NSData*)newFileData;

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile or DownloadFileById if LocalFile is not set.

This property can also be set before calling UploadFile or UploadPart; its data will be uploaded if LocalFile is not set.

FileMarker Property (BackblazeB2 Module)

A marker indicating what page of files to return next.

Syntax

• Swift
• Objective-C

public var fileMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fileMarker,setter=setFileMarker:) NSString* fileMarker;

- (NSString*)fileMarker;
- (void)setFileMarker :(NSString*)newFileMarker;

Default Value

""

Remarks

This property will be populated when ListFiles or ListMultipartUploads is called if the results are paged and there are more pages. To list all files or multipart uploads, continue to call ListFiles or ListMultipartUploads (respectively) until this property returns empty string.

Refer to ListFiles or ListMultipartUploads for more information.

Files Property (BackblazeB2 Module)

A collection of files.

Syntax

• Swift
• Objective-C

public var files: Array<B2File> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=fileCount) int fileCount;

- (int)fileCount;

- (NSString*)fileBucketId:(int)fileIndex;

- (NSString*)fileContentType:(int)fileIndex;

- (long long)fileCreatedTime:(int)fileIndex;

- (NSString*)fileId:(int)fileIndex;

- (NSString*)fileKind:(int)fileIndex;

- (NSString*)fileMD5Hash:(int)fileIndex;

- (long long)fileModifiedTime:(int)fileIndex;

- (NSString*)fileName:(int)fileIndex;

- (NSString*)fileSHA1Hash:(int)fileIndex;

- (long long)fileSize:(int)fileIndex;

Default Value

""

Remarks

This collection holds a list of B2File items.

Calling GetFileInfo, ListFiles, ListFileVersions, or ListMultipartUploads will populate this collection.

Firewall Property (BackblazeB2 Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Idle Property (BackblazeB2 Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

LocalFile Property (BackblazeB2 Module)

The location of the local file.

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UploadPart; and as the destination file when calling DownloadFile or DownloadFileById.

LocalHost Property (BackblazeB2 Module)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Metadata Property (BackblazeB2 Module)

A collection of metadata items.

Syntax

• Swift
• Objective-C

public var metadata: Array<B2Metadata> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=metadataCount,setter=setMetadataCount:) int metadataCount;

- (int)metadataCount;
- (void)setMetadataCount :(int)newMetadataCount;

- (NSString*)metadataName:(int)metadataIndex;
- (void)setMetadataName:(int)metadataIndex :(NSString*)newMetadataName;

- (NSString*)metadataValue:(int)metadataIndex;
- (void)setMetadataValue:(int)metadataIndex :(NSString*)newMetadataValue;

Default Value

""

Remarks

This collection holds a list of B2Metadata items.

This collection is populated when GetBucketInfo or GetFileInfo is called; and its items are used anytime one of the following methods is called:

• CopyFile (if the SendMetadataOnCopy configuration setting is enabled)
• CreateBucket
• StartMultipartUpload
• UpdateBucket (if the NewMetadata parameter is )
• UploadFile

Note that there is a limit of 10 metadata items per bucket and per file; the class does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation for more information.

OtherHeaders Property (BackblazeB2 Module)

This property includes other headers as determined by the user (optional).

Syntax

• Swift
• Objective-C

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

Overwrite Property (BackblazeB2 Module)

Determines if local files are overwritten.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

This property controls whether local files are overwritten when calling DownloadFile or DownloadFileById. It is only applicable to local files.

ParsedHeaders Property (BackblazeB2 Module)

This property includes a collection of headers returned from the last request.

Syntax

• Swift
• Objective-C

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

Default Value

""

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

PartMarker Property (BackblazeB2 Module)

A marker indicating what page of parts to return next.

Syntax

• Swift
• Objective-C

public var partMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=partMarker,setter=setPartMarker:) NSString* partMarker;

- (NSString*)partMarker;
- (void)setPartMarker :(NSString*)newPartMarker;

Default Value

""

Remarks

This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.

Refer to ListParts for more information.

Parts Property (BackblazeB2 Module)

A collection of multipart upload parts.

Syntax

• Swift
• Objective-C

public var parts: Array<B2Part> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=partCount) int partCount;

- (int)partCount;

- (long long)partCreatedTime:(int)partIndex;

- (NSString*)partMD5Hash:(int)partIndex;

- (int)partNumber:(int)partIndex;

- (NSString*)partSHA1Hash:(int)partIndex;

- (long long)partSize:(int)partIndex;

Default Value

""

Remarks

This collection holds a list of B2Part items.

Calling ListParts will populate this collection.

Prefix Property (BackblazeB2 Module)

A prefix used to restrict the results returned when listing files.

Syntax

• Swift
• Objective-C

public var prefix: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=prefix,setter=setPrefix:) NSString* prefix;

- (NSString*)prefix;
- (void)setPrefix :(NSString*)newPrefix;

Default Value

""

Remarks

This property, if non-empty, is used to restrict the values returned by ListFiles, ListFileVersions, or ListMultipartUploads to only the items whose names begin with the given prefix.

Note: If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the AccountAllowedPrefix property being non-empty), then this property will automatically be set to that prefix if it is empty when one of the aforementioned methods is called.

File Hierarchy Traversal

By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:

Proxy Property (BackblazeB2 Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

QueryParams Property (BackblazeB2 Module)

Additional query parameters to be included in the request.

Syntax

• Swift
• Objective-C

public var queryParams: Array<QueryParam> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=queryParamCount,setter=setQueryParamCount:) int queryParamCount;

- (int)queryParamCount;
- (void)setQueryParamCount :(int)newQueryParamCount;

- (NSString*)queryParamName:(int)queryParamIndex;
- (void)setQueryParamName:(int)queryParamIndex :(NSString*)newQueryParamName;

- (NSString*)queryParamValue:(int)queryParamIndex;
- (void)setQueryParamValue:(int)queryParamIndex :(NSString*)newQueryParamValue;

Default Value

""

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Range Property (BackblazeB2 Module)

The range of bytes to request.

Syntax

• Swift
• Objective-C

public var range: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=range,setter=setRange:) NSString* range;

- (NSString*)range;
- (void)setRange :(NSString*)newRange;

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a DownloadFile or DownloadFileById request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when one of the aforementioned methods is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

SSLAcceptServerCertEncoded Property (BackblazeB2 Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (BackblazeB2 Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (BackblazeB2 Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

SSLCertStorePassword Property (BackblazeB2 Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

SSLCertStoreType Property (BackblazeB2 Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: Backblazeb2SSLCertStoreTypes {
  get {...}
  set {...}
}

public enum Backblazeb2SSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

SSLCertSubject Property (BackblazeB2 Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (BackblazeB2 Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: Backblazeb2SSLProviders {
  get {...}
  set {...}
}

public enum Backblazeb2SSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (BackblazeB2 Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

StartByte Property (BackblazeB2 Module)

The byte offset from which to resume the upload or download.

Syntax

• Swift
• Objective-C

public var startByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;

- (long long)startByte;
- (void)setStartByte :(long long)newStartByte;

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by UploadFile, or a download initiated by DownloadFile or DownloadFileById. Refer to those methods' documentation for more information about resuming uploads and downloads.

Timeout Property (BackblazeB2 Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

VersionMarker Property (BackblazeB2 Module)

A marker indicating what page of file versions to return next.

Syntax

• Swift
• Objective-C

public var versionMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=versionMarker,setter=setVersionMarker:) NSString* versionMarker;

- (NSString*)versionMarker;
- (void)setVersionMarker :(NSString*)newVersionMarker;

Default Value

""

Remarks

This property will be populated when ListFileVersions is called if the results are paged and there are more pages. To list all file versions, continue to call ListFileVersions until this property returns empty string.

Refer to ListFileVersions for more information.

AbortMultipartUpload Method (BackblazeB2 Module)

Aborts a multipart upload.

Syntax

• Swift
• Objective-C

public func abortMultipartUpload(multipartFileId: String) throws -> Void

- (void)abortMultipartUpload:(NSString*)multipartFileId;

Remarks

This method aborts the multipart upload of the file specified by MultipartFileId, and invalidates the given Id.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

AddMetadata Method (BackblazeB2 Module)

Adds a metadata item to the Metadata properties.

Syntax

• Swift
• Objective-C

public func addMetadata(name: String, value: String) throws -> Void

- (void)addMetadata:(NSString*)name :(NSString*)value;

Remarks

This method adds a metadata item with the given Name and Value to the Metadata* properties. Name may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.

A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.

Note that there is a limit of 10 metadata items per bucket and per file; the class does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation for more information.

AddQueryParam Method (BackblazeB2 Module)

Adds a query parameter to the QueryParams properties.

Syntax

• Swift
• Objective-C

public func addQueryParam(name: String, value: String) throws -> Void

- (void)addQueryParam:(NSString*)name :(NSString*)value;

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Authorize Method (BackblazeB2 Module)

Authenticates the component with the server using the current application key and Id.

Syntax

• Swift
• Objective-C

public func authorize() throws -> Void

- (void)authorize;

Remarks

This method authenticates the class with the server using the values held by ApplicationKey and ApplicationKeyId. A successful call to this method will clear and repopulate the following:

• Account* properties
• APIURL configuration setting
• DownloadURL configuration setting
• FragmentSize configuration setting (if necessary; refer to its documentation for more information)
• SimpleUploadLimit configuration setting (if necessary; refer to its documentation for more information)

The class must authenticate with the server before any other requests can be attempted; the class will call it automatically if necessary. As part of the authentication process, the server returns an authorization token which must be used to authorize all further requests; this token is valid for up to 24 hours. When it expires, this method must be called again.

CompleteMultipartUpload Method (BackblazeB2 Module)

Completes a multipart upload by assembling the previously uploaded parts.

Syntax

• Swift
• Objective-C

public func completeMultipartUpload(multipartFileId: String) throws -> Void

- (void)completeMultipartUpload:(NSString*)multipartFileId;

Remarks

This method completes the multipart upload of the file specified by MultipartFileId. The server will assemble all of the parts that have been uploaded into a single file. (Note: The assembled file keeps MultipartFileId as its Id.)

Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts* properties, nor does it cause the PartList event to fire.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Config Method (BackblazeB2 Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyFile Method (BackblazeB2 Module)

Copies a file.

Syntax

• Swift
• Objective-C

public func copyFile(srcFileId: String, destBucketId: String, destFileName: String) throws -> String

- (NSString*)copyFile:(NSString*)srcFileId :(NSString*)destBucketId :(NSString*)destFileName;

Remarks

This method copies the file version specified by SrcFileId to the bucket specified by DestBucketId with the name DestFileName. The Id of the newly-created file is returned. If DestBucketId is empty, the source file's bucket is used as the destination bucket.

DestFileName is subject to the same restrictions described in the UploadFile method's documentation; refer to it for more information. If a file named DestFileName already exists in the destination bucket, a new version of it is created.

If the SendMetadataOnCopy configuration setting is enabled, and the ContentType property, the Metadata* properties, and/or the ClientModifiedTime configuration setting are non-empty, then their values will be applied to the destination file. Otherwise, the server will copy the source file's content type and metadata to the destination file.

Finally, note that this method can only be used to copy files up to 5GB in size (or, if Range is non-empty, a range of up to 5GB of data from a larger file). To copy more than 5GB of data, start a new multipart upload with StartMultipartUpload, and then use the CopyPart method to copy the desired data in parts.

The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

CopyPart Method (BackblazeB2 Module)

Copies the specified file as part of a multipart upload.

Syntax

• Swift
• Objective-C

public func copyPart(srcFileId: String, multipartFileId: String, partNumber: Int32) throws -> Void

- (void)copyPart:(NSString*)srcFileId :(NSString*)multipartFileId :(int)partNumber;

Remarks

This method copies the file version specified by SrcFileId to a new part in the multipart upload of the file specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.

All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte). The Range property can optionally be set before calling this method to copy only a specific range of data from the specified source file.

The currently-authenticated application key must have the writeFiles and (if the source file's bucket kind is allPrivate) readFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

CreateAppKey Method (BackblazeB2 Module)

Creates a new application key.

Syntax

• Swift
• Objective-C

public func createAppKey(keyName: String, capabilities: String, allowedBucketId: String, allowedPrefix: String, validityDuration: Int64) throws -> String

- (NSString*)createAppKey:(NSString*)keyName :(NSString*)capabilities :(NSString*)allowedBucketId :(NSString*)allowedPrefix :(long long)validityDuration;

Remarks

This method creates a new application key named KeyName with the specified Capabilities. If successful, this method returns a string containing the newly-created application key's Id, followed by the key itself, separated by a newline (\n) character; for example:

[application_key_id]
[application_key]

The string passed for Capabilities must be formatted as a comma-separated list of one or more of the following:

To restrict the new application key to a specific bucket, pass the bucket's Id for AllowedBucketId. To further restrict it to files with a specific prefix within that bucket, pass said prefix for AllowedPrefix. It is not possible to apply a prefix restriction without a bucket restriction.

The ValidityDuration parameter specifies how many seconds the new application key will be valid for. The maximum valid value is 86400000 (1000 days); values less than 1 will cause the application key to remain valid indefinitely.

The currently-authenticated application key must have the writeKeys capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

CreateBucket Method (BackblazeB2 Module)

Creates a new bucket.

Syntax

• Swift
• Objective-C

public func createBucket(bucketName: String, kind: String) throws -> String

- (NSString*)createBucket:(NSString*)bucketName :(NSString*)kind;

Remarks

This method creates a new bucket named BucketName of the specified Kind. Valid values for Kind are allPrivate (default if empty) and allPublic. Each account may have up to 100 buckets.

The value passed for BucketName must comply with the following restrictions:

• Must be between 6 and 50 characters long (inclusive).
• Must consist solely of letters, digits, and hyphens (-).
• Cannot start with the string b2-.
• Must be globally unique (i.e., no two accounts may have a bucket with the same name) when compared case-insensitively.

If any items are present in the Metadata* properties, they will also be included in the request and applied to the newly-created bucket. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

DeleteAppKey Method (BackblazeB2 Module)

Deletes an application key.

Syntax

• Swift
• Objective-C

public func deleteAppKey(keyId: String) throws -> Void

- (void)deleteAppKey:(NSString*)keyId;

Remarks

This method deletes the application key specified by KeyId.

The currently-authenticated application key must have the deleteKeys capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

DeleteBucket Method (BackblazeB2 Module)

Deletes a bucket.

Syntax

• Swift
• Objective-C

public func deleteBucket(bucketId: String) throws -> Void

- (void)deleteBucket:(NSString*)bucketId;

Remarks

This method deletes the bucket specified by BucketId. A bucket must be completely empty to be deleted.

Note that bucket names are global, and it may not be possible to recreate a deleted bucket if its name is taken by another user in the meantime.

The currently-authenticated application key must have the deleteBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

DeleteFile Method (BackblazeB2 Module)

Deletes all versions of a file.

Syntax

• Swift
• Objective-C

public func deleteFile(bucketId: String, fileName: String) throws -> Void

- (void)deleteFile:(NSString*)bucketId :(NSString*)fileName;

Remarks

This method deletes all versions of the file named FileName from the bucket specified by BucketId. If the latest "version" of the specified file is an incomplete multipart upload, the multipart upload is aborted.

The currently-authenticated application key must have the listFiles and deleteFiles capabilities to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Note: This method is offered as a convenience, as the Backblaze B2 REST API does not technically provide a way to delete all versions of a file using a single request. When this method is called, the class uses ListFileVersions to obtain a list of all versions of the specified file, and then uses DeleteFileVersion to delete each one, in order from oldest to newest. If any one request made during this process fails, this method will fail immediately. This process does not alter the File* or FileMarker properties, nor does it cause the FileList event to fire.

DeleteFileVersion Method (BackblazeB2 Module)

Deletes a file version.

Syntax

• Swift
• Objective-C

public func deleteFileVersion(fileId: String) throws -> Void

- (void)deleteFileVersion:(NSString*)fileId;

Remarks

This method deletes the file version specified by FileId, regardless of whether said version is an actual file or a hide marker

If the most recent version of a file is deleted, and older versions of the file exist, then the most recent older version will become the "current" version. If said version is a hide marker, then the file will become "hidden"; refer to HideFile for more information.

The currently-authenticated application key must have the deleteFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

DownloadFile Method (BackblazeB2 Module)

Downloads a file by name.

Syntax

• Swift
• Objective-C

public func downloadFile(bucketName: String, fileName: String) throws -> Void

- (void)downloadFile:(NSString*)bucketName :(NSString*)fileName;

Remarks

This method downloads the latest version of the file named FileName from the bucket named BucketName. The Range property can optionally be set before calling this method to download a specific range of data from the file.

This method can be used to download files that are owned by other accounts, so long as an appropriate download authorization token and download URL are supplied using the DownloadAuthToken and DownloadURL configuration settings; refer to their documentation for more information.

If LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: b2.LocalFile = "../MyData.zip"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; b2.LocalFile = downloadFile; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file b2.StartByte = new FileInfo(downloadFile).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. b2.LocalFile = "../MyData.zip"; b2.EncryptionPassword = "password"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded temp file b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

DownloadFileById Method (BackblazeB2 Module)

Downloads a file by Id.

Syntax

• Swift
• Objective-C

public func downloadFileById(fileId: String) throws -> Void

- (void)downloadFileById:(NSString*)fileId;

Remarks

This method downloads the file version specified by FileId. The Range property can optionally be set before calling this method to download a specific range of data from the file.

If LocalFile is set, the file data will be saved to the specified location; otherwise, the file data will be held by FileData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: b2.LocalFile = "../MyData.zip"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; b2.LocalFile = downloadFile; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file b2.StartByte = new FileInfo(downloadFile).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. b2.LocalFile = "../MyData.zip"; b2.EncryptionPassword = "password"; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById(). //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded temp file b2.StartByte = new FileInfo(b2.Config("DownloadTempFile")).Length; b2.DownloadFile("MyBucket", "data.zip"); // Or, DownloadFileById().

The currently-authenticated application key must have the readFiles capability (unless the bucket is public) to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

GetBucketInfo Method (BackblazeB2 Module)

Gets a bucket's information and metadata.

Syntax

• Swift
• Objective-C

public func getBucketInfo(bucketId: String) throws -> Void

- (void)getBucketInfo:(NSString*)bucketId;

Remarks

This method gets information and metadata for the bucket specified by BucketId.

Calling this method will fire the BucketList and MetadataList events, and will re-populate the Bucket* and Metadata* properties.

The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

GetDownloadAuthToken Method (BackblazeB2 Module)

Create a download authorization token for one or more files in a bucket.

Syntax

• Swift
• Objective-C

public func getDownloadAuthToken(allowedBucketId: String, allowedPrefix: String, validityDuration: Int32) throws -> String

- (NSString*)getDownloadAuthToken:(NSString*)allowedBucketId :(NSString*)allowedPrefix :(int)validityDuration;

Remarks

This method creates and returns a download authorization token for the files in the bucket specified by AllowedBucketId whose names start with AllowedPrefix. The newly-created token will remain valid for the number of seconds specified by ValidityDuration, which must be a value in the range 1 to 604800 (1 week), inclusive.

Download authorization tokens created using this method can be used by anybody to download an applicable file by name; they cannot be used to download a file by Id. Refer to the DownloadFile method for more information.

The currently-authenticated application key must have the shareFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

GetFileInfo Method (BackblazeB2 Module)

Gets a file's information and metadata.

Syntax

• Swift
• Objective-C

public func getFileInfo(fileId: String) throws -> Void

- (void)getFileInfo:(NSString*)fileId;

Remarks

This method gets information and metadata for the file version specified by FileId (which must be a real file version, or a hide marker, not a multipart upload).

Calling this method will fire the FileList and MetadataList events, and will re-populate the File* and Metadata* properties.

The currently-authenticated application key must have the readFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

HideFile Method (BackblazeB2 Module)

Hides a file.

Syntax

• Swift
• Objective-C

public func hideFile(bucketId: String, fileName: String) throws -> String

- (NSString*)hideFile:(NSString*)bucketId :(NSString*)fileName;

Remarks

This method hides the file named FileName in the bucket specified by BucketId by creating a special version of the file called a hide marker.

If the latest version of a file is a hide marker, then the file will not appear in the results returned by ListFiles, nor can it be downloaded by name using DownloadFile. However:

• Any version of the file (excluding hide markers) can still be downloaded directly using DownloadFileById.
• All versions of the file can still be deleted, either all at once using DeleteFile, or individually using DeleteFileVersion.
• All versions of the file will still appear in the results returned by ListFileVersions, and can still be queried individually using GetFileInfo.

To unhide a file, simply delete the hide marker using DeleteFileVersion.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Interrupt Method (BackblazeB2 Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListAppKeys Method (BackblazeB2 Module)

Lists the account's application keys.

Syntax

• Swift
• Objective-C

public func listAppKeys() throws -> Void

- (void)listAppKeys;

Remarks

This method lists the application keys associated with the account. Note that the account's master application key is not included in the results.

Calling this method will fire the AppKeyList event once for each application key, and will also populate the AppKey* properties.

If there are still more application keys available to list when this method returns, the AppKeyMarker property will be populated. Continue to call this method until AppKeyMarker is empty to accumulate all pages of results in the AppKey* properties.

The MaxAppKeyResults configuration setting can be used to control the maximum number of results returned each time this method is called.

The currently-authenticated application key must have the listKeys capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

ListBuckets Method (BackblazeB2 Module)

Lists all buckets in the account.

Syntax

• Swift
• Objective-C

public func listBuckets() throws -> Void

- (void)listBuckets;

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Bucket* properties. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each bucket.

If the currently-authenticated application key is restricted to a specific bucket (indicated by the AccountAllowedBucketId property being non-empty), the results will only include information for that bucket.

The currently-authenticated application key must have the listBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

ListFiles Method (BackblazeB2 Module)

Lists the files in a bucket.

Syntax

• Swift
• Objective-C

public func listFiles(bucketId: String) throws -> Void

- (void)listFiles:(NSString*)bucketId;

Remarks

This method lists the files in the bucket specified by BucketId.

Before calling this method, the Prefix property may be set in order to restrict the results to only the files whose names begin with the a given string. The Delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the AccountAllowedPrefix property being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the FileList event once for each file, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each file.

If there are still more files available to list when this method returns, the FileMarker property will be populated. Continue to call this method until FileMarker is empty to accumulate all pages of results in the File* properties.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

File Hierarchy Traversal

By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:

ListFileVersions Method (BackblazeB2 Module)

Lists the file versions in a bucket.

Syntax

• Swift
• Objective-C

public func listFileVersions(bucketId: String) throws -> Void

- (void)listFileVersions:(NSString*)bucketId;

Remarks

This method lists the file versions in the bucket specified by BucketId.

Before calling this method, the Prefix property may be set in order to restrict the results to only the file versions whose names begin with the a given string. The Delimiter property can also be used to further tune the results returned. The MaxResults configuration setting may also be used to limit the number of results returned.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the AccountAllowedPrefix property being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the FileList event once for each file version, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each file version.

If there are still more files versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the File* properties.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

File Hierarchy Traversal

By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:

ListMultipartUploads Method (BackblazeB2 Module)

Lists the in-progress multipart uploads in a bucket.

Syntax

• Swift
• Objective-C

public func listMultipartUploads(bucketId: String) throws -> Void

- (void)listMultipartUploads:(NSString*)bucketId;

Remarks

This method lists the in-progress multipart uploads in the bucket specified by BucketId.

Before calling this method, the Prefix property may be set in order to restrict the results to only the multipart uploads whose file names begin with the a given string.

If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the AccountAllowedPrefix property being non-empty), then the Prefix property will automatically be set to that prefix if it is empty when this method is called.

Calling this method will fire the FileList event once for each multipart upload, and will also populate the File* properties. If the ListWithMetadata configuration setting is enabled, the MetadataList event will also be fired, once for each metadata item associated with each multipart upload.

The currently-authenticated application key must have the listFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

ListParts Method (BackblazeB2 Module)

Lists a multipart upload's parts.

Syntax

• Swift
• Objective-C

public func listParts(multipartFileId: String) throws -> Void

- (void)listParts:(NSString*)multipartFileId;

Remarks

This method lists the parts that have been created for the multipart file upload specified by MultipartFileId.

Calling this method will fire the PartList event once for each part, and will also populate the Part* properties.

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Part* properties.

The MaxPartResults configuration setting can be used to control the maximum number of results returned each time this method is called.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Reset Method (BackblazeB2 Module)

Resets the component to its initial state.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method resets the class to its initial state.

SendCustomRequest Method (BackblazeB2 Module)

Sends a custom request to the Backblaze B2 API.

Syntax

• Swift
• Objective-C

public func sendCustomRequest(httpMethod: String, operation: String, requestBody: String) throws -> Void

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)operation :(NSString*)requestBody;

Remarks

This method can be used to send arbitrary requests to the Backblaze B2 API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST

The value passed for Operation must be one of the API operations described in the Backblaze B2 REST API documentation (e.g., b2_list_buckets).

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified Operation is appended to the base Backblaze B2 API URL (refer to the APIURL configuration setting for more information).
   • All query parameters in the QueryParam* properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL built in step 1, the header information built from AccountAuthToken and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeader* properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

StartMultipartUpload Method (BackblazeB2 Module)

Starts a new multipart upload.

Syntax

• Swift
• Objective-C

public func startMultipartUpload(bucketId: String, fileName: String) throws -> String

- (NSString*)startMultipartUpload:(NSString*)bucketId :(NSString*)fileName;

Remarks

This method starts a new multipart upload for a file named FileName in the bucket specified by BucketId, and returns the Id of the newly-created multipart upload. This Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

FileName is subject to the same restrictions described in the UploadFile method's documentation; refer to it for more information. If a file named FileName already exists in the destination bucket, a new version of it is created.

The following information is also included in the request, and will be applied to the final file when the multipart upload is completed with CompleteMultipartUpload:

• All metadata items present in the Metadata* properties. Keep in mind that the server enforces a limit of 10 metadata items per file.
• If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
• The value of the ContentType property.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

UpdateBucket Method (BackblazeB2 Module)

Updates a bucket's kind and/or metadata.

Syntax

• Swift
• Objective-C

public func updateBucket(bucketId: String, newKind: String, newMetadata: Bool) throws -> Void

- (void)updateBucket:(NSString*)bucketId :(NSString*)newKind :(BOOL)newMetadata;

Remarks

This method updates the kind and/or metadata of the bucket specified by BucketId.

If NewKind is non-empty, it must be allPrivate or allPublic. If NewKind is empty, the bucket's kind remains unchanged.

If NewMetadata is , the bucket's current metadata items are replaced with those in the Metadata* properties (or cleared, if said properties are empty). If NewMetadata is , the bucket's current metadata remains unchanged. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

If NewKind is empty and NewMetadata is false, this method does nothing.

The IfRevision setting can optionally be set before calling this method to ensure that the requested changes are only made if the bucket's current revision matches the given one.

The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

UploadFile Method (BackblazeB2 Module)

Uploads a file.

Syntax

• Swift
• Objective-C

public func uploadFile(bucketId: String, fileName: String) throws -> String

- (NSString*)uploadFile:(NSString*)bucketId :(NSString*)fileName;

Remarks

This method uploads a new file named FileName to the bucket specified by BucketId, and returns the Id of the newly-created file.

The value passed for FileName must comply with the following restrictions:

• Cannot contain non-printable or DEL characters (i.e., character codes below 32 or equal to 127, respectively).
• Cannot contain backslashes (\).
• Cannot begin or end with a slash (/), and cannot contain two subsequent slashes (//).
• No segment (i.e., a part between slashes) can be more than 250 bytes long (when UTF-8 encoded).
• The overall string can be no more than 1024 bytes long overall (when UTF-8 encoded).

If a file with the specified FileName already exists in the destination bucket, a new version of it is created.

The following information is also included in the request, and will be applied to the newly-created file:

• All metadata items present in the Metadata* properties. Keep in mind that the server enforces a limit of 10 metadata items per file.
• If the ClientModifiedTime configuration setting is non-empty: an additional metadata item with its value (which does count towards the 10 item limit).
• The value of the ContentType property.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in FileData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.

UploadPart Method (BackblazeB2 Module)

Uploads a multipart upload part.

Syntax

• Swift
• Objective-C

public func uploadPart(multipartFileId: String, partNumber: Int32) throws -> Void

- (void)uploadPart:(NSString*)multipartFileId :(int)partNumber;

Remarks

This method uploads a new part for the multipart file upload specified by MultipartFileId. The part's number is specified by PartNumber; it must be a value in the range 1 to 10000, inclusive. If the specified multipart upload already has a part with the given PartNumber, it is replaced with the one created by this request.

The data to upload is taken from either LocalFile or FileData (whichever data is found in first, when checked in that order). All parts must be between 5MB and 5GB in size (except for the last part, which can be as small as 1 byte).

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

AppKeyList Event (BackblazeB2 Module)

Fires once for each application key returned when listing application keys.

Syntax

• Swift
• Objective-C

func onAppKeyList(keyId: String, keyName: String, capabilities: String, allowedBucketId: String, allowedPrefix: String, expirationTime: Int64)

- (void)onAppKeyList:(NSString*)keyId :(NSString*)keyName :(NSString*)capabilities :(NSString*)allowedBucketId :(NSString*)allowedPrefix :(long long)expirationTime;

Remarks

This event fires once for each application key returned when ListAppKeys is called.

KeyId reflects the unique Id of the application key.

KeyName reflects the name that was given to the application key when it was created.

Capabilities reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:

AllowedBucketId reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.

AllowedPrefix reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.

ExpirationTime reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.

BucketList Event (BackblazeB2 Module)

Fires once for each bucket returned when listing buckets.

Syntax

• Swift
• Objective-C

func onBucketList(id: String, name: String, kind: String, revision: Int64)

- (void)onBucketList:(NSString*)id :(NSString*)name :(NSString*)kind :(long long)revision;

Remarks

This event fires once for each bucket returned when ListBuckets is called.

Id reflects the unique Id of the bucket.

Name reflects the name of the bucket.

Kind reflects the bucket's kind. Possible values are allPublic, allPrivate, or snapshot.

Revision reflects the bucket's revision number. A bucket's revision number is updated every time the bucket is modified.

EndTransfer Event (BackblazeB2 Module)

This event fires when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)direction;

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (BackblazeB2 Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FileList Event (BackblazeB2 Module)

Fires once for each file returned when listing files.

Syntax

• Swift
• Objective-C

func onFileList(id: String, name: String, bucketId: String, size: Int64, contentType: String, createdTime: Int64, modifiedTime: Int64, kind: String, sha1Hash: String)

- (void)onFileList:(NSString*)id :(NSString*)name :(NSString*)bucketId :(long long)size :(NSString*)contentType :(long long)createdTime :(long long)modifiedTime :(NSString*)kind :(NSString*)SHA1Hash;

Remarks

This event fires once for each file returned when ListFiles, ListFileVersions, or ListMultipartUploads is called.

Id reflects the Id of the file. Always empty when Kind is folder.

Name reflects the name of the file.

BucketId reflects the Id of the bucket that the file is in.

Size reflects the size of the file, in bytes. Always 0 when Kind is folder, hide, or start.

ContentType reflects the content type of the file. Always application/x-bz-hide-marker when Kind is hide; and empty when Kind is folder.

CreatedTime reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when Kind is folder.

ModifiedTime reflects the file's last modified time, in milliseconds relative to the Unix epoch. (Note that this parameter will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.)

Kind reflects the file's kind. Possible values are:

SHA1Hash reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty when Kind is folder or hide.

FragmentComplete Event (BackblazeB2 Module)

Fires after each part in an automatic multipart upload is complete.

Syntax

• Swift
• Objective-C

func onFragmentComplete(fragmentNumber: Int32, fragmentCount: Int32, interrupt: inout Bool)

- (void)onFragmentComplete:(int)fragmentNumber :(int)fragmentCount :(int*)interrupt;

Remarks

If, when UploadFile is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to to interrupt the upload. The upload may be resumed later.

Refer to UploadFile for more information.

Header Event (BackblazeB2 Module)

This event is fired every time a header line comes in.

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)value;

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (BackblazeB2 Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MetadataList Event (BackblazeB2 Module)

Fires once for each metadata item returned when bucket or file information and metadata is retrieved.

Syntax

• Swift
• Objective-C

func onMetadataList(bucketId: String, fileId: String, name: String, value: String)

- (void)onMetadataList:(NSString*)bucketId :(NSString*)fileId :(NSString*)name :(NSString*)value;

Remarks

This event fires once for each metadata item returned when GetBucketInfo or GetFileInfo is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual bucket or file is returned when ListBuckets, ListFiles, ListFileVersions, or ListMultipartUploads is called.

BucketId reflects the Id of the bucket that the file is in (if FileId is non-empty), or that the metadata item is associated with (if FileId is empty).

FileId, if non-empty, reflects the Id of the file that the metadata item is associated with.

Name reflects the name of the metadata item.

Value reflects the value of the metadata item.

PartList Event (BackblazeB2 Module)

Fires once for each part returned when listing a multipart upload's parts.

Syntax

• Swift
• Objective-C

func onPartList(partNumber: Int32, multipartFileId: String, size: Int64, createdTime: Int64, sha1Hash: String)

- (void)onPartList:(int)partNumber :(NSString*)multipartFileId :(long long)size :(long long)createdTime :(NSString*)SHA1Hash;

Remarks

This event fires once for each part returned when ListParts is called.

PartNumber reflects the part's number.

MultipartFileId reflects the Id of the multipart file upload that the part is a part of.

Size reflects the size of the part, in bytes.

CreatedTime reflects the part's creation time (i.e., upload time), in milliseconds relative to the Unix epoch.

SHA1Hash reflects a hex-encoded SHA1 hash of the part's contents.

Progress Event (BackblazeB2 Module)

Fires during an upload or download to indicate transfer progress.

Syntax

• Swift
• Objective-C

func onProgress(direction: Int32, bytesTransferred: Int64, totalBytes: Int64, percentDone: Int32)

- (void)onProgress:(int)direction :(long long)bytesTransferred :(long long)totalBytes :(int)percentDone;

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (BackblazeB2 Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (BackblazeB2 Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (BackblazeB2 Module)

This event fires when a document starts transferring (after the headers).

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)direction;

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (BackblazeB2 Module)

This event is fired while a document transfers (delivers document).

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

B2Account Type

Backblaze B2 account information.

Remarks

This type provides information about a Backblaze B2 account and the currently-authenticated application key.

Fields

B2AppKey Type

A Backblaze B2 application key.

Remarks

This type represents a Backblaze B2 application key.

Fields

B2Bucket Type

A Backblaze B2 bucket.

Remarks

This type represents a Backblaze B2 bucket.

Fields

B2File Type

A Backblaze B2 file.

Remarks

This type represents a Backblaze B2 file.

Fields

B2Metadata Type

A Backblaze B2 metadata item.

Remarks

This type represents a Backblaze B2 metadata item.

Fields

Constructors

public init()

public init(name: , value: )

B2Part Type

A Backblaze B2 multipart upload part.

Remarks

This type represents a Backblaze B2 multipart upload part.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public init()

public init(field: , value: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

public init()

public init(name: , value: )

Config Settings (BackblazeB2 Module)

BackblazeB2 Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (BackblazeB2 Module)

Common Errors

BackblazeB2 Errors

HTTP Errors

TCPClient Errors