S3 Module

Properties   Methods   Events   Config Settings   Errors  

The S3 module provides an easy-to-use interface for Amazon S3 and other S3-compatible services.

Syntax

IPWorks.S3

Remarks

The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using Secure Sockets Layer/Transport Layer Security (TLS/SSL). S3-like services allow you to store arbitrary data objects in various buckets and to access them from anywhere with an internet connection.

A brief synopsis follows, but please refer to Amazon's S3 documentation for more information about the general capabilities of S3.

S3 supports the following providers:

• Amazon S3
• Backblaze B2
• Cloudflare R2
• Digital Ocean Spaces
• Google Cloud Storage
• IBM Cloud Object Storage
• Linode Object Storage
• Oort DSS
• Oracle Cloud Object Storage
• Seagate Lyve Cloud
• Wasabi
• And more!

A "custom provider" option also allows you to interact with any S3-compatible API by specifying its base URL.

Getting Started

To begin, use the ServiceProvider property to select the S3 service provider to use. Then, use the AccessKey and SecretKey properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider.

Working with Buckets

S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account:

• Creating and deleting buckets: CreateBucket and DeleteBucket
• Checking whether a bucket exists, and its location: BucketExists and GetBucketLocation
• Listing buckets: ListBuckets
• Updating a bucket's canned ACL: UpdateBucketACL

Working with Objects

Once the desired buckets are ready, the following methods can be used to interact with objects:

• Creating, downloading, and deleting objects: CreateObject, GetObject, DeleteObject
• Copying objects: CopyObject
• Listing objects, or getting information about a single object: ListObjects, GetObjectInfo
• Updating an object's canned ACL: UpdateObjectACL

Working with Multipart Uploads

For S3 providers that support them, multipart uploads make it possible to upload very large objects in multiple parts.

• Starting, completing, and aborting multipart uploads: StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload
• Listing multipart uploads: ListMultipartUploads
• Uploading and copying parts: UploadPart, CopyPart
• Listing parts: ListParts

Cloudflare R2 Notes

The Cloudflare R2 service provider possesses the following unique requirements and characteristics:

• In addition to needing an AccessKey and SecretKey, a CloudflareAccountID is also required to work with this provider.
• The Region property is automatically set to "auto" when this service provider is selected, which is the only valid value.
• ListParts is not supported natively by Cloudflare R2, which means that the behavior of CompleteMultipartUpload changes when using this provider. Instead, calling UploadPart or CopyPart populates the LastPartInfo and PartInfo[i] configuration settings. CompleteMultipartUpload will then use the values in PartInfo[i] to complete the multipart upload.

Other Features

The S3 class also supports a variety of other features, including the following:

• Versioning support
• Object metadata manipulation
• Presigned link generation

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.

AccessKey Property (S3 Module)

This property includes the access key to use for authentication.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accessKey,setter=setAccessKey:) NSString* accessKey;

- (NSString*)accessKey;
- (void)setAccessKey :(NSString*)newAccessKey;

Default Value

""

Remarks

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

AccessPolicy Property (S3 Module)

This property includes the canned access policy to apply to a bucket or object.

Syntax

• Swift
• Objective-C

public var accessPolicy: S3AccessPolicies {
  get {...}
  set {...}
}

public enum S3AccessPolicies: Int32 {
  case ptPrivate = 0
  case ptPublicRead = 1
  case ptPublicReadWrite = 2
  case ptAuthenticatedRead = 3
  case ptBucketOwnerRead = 4
  case ptBucketOwnerFullControl = 5
  case ptNone = 6
}

@property (nonatomic,readwrite,assign,getter=accessPolicy,setter=setAccessPolicy:) int accessPolicy;

- (int)accessPolicy;
- (void)setAccessPolicy :(int)newAccessPolicy;

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

The valid values are as follows:

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or they have additional restrictions. Refer to the provider's documentation for more information.

Bucket Property (S3 Module)

This property selects a bucket.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=bucket,setter=setBucket:) NSString* bucket;

- (NSString*)bucket;
- (void)setBucket :(NSString*)newBucket;

Default Value

""

Remarks

This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.

Buckets Property (S3 Module)

This property includes the collection of buckets.

Syntax

• Swift
• Objective-C

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

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

- (int)bucketsCount;

- (NSString*)bucketsCreationDate:(int)bucketsIndex;

- (NSString*)bucketsName:(int)bucketsIndex;

- (NSString*)bucketsOwnerDisplayName:(int)bucketsIndex;

- (NSString*)bucketsOwnerId:(int)bucketsIndex;

Default Value

""

Remarks

This collection holds a list of S3Bucket items.

Calling ListBuckets will populate this collection.

ContentDisposition Property (S3 Module)

This property includes content disposition to send for an object.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=contentDisposition,setter=setContentDisposition:) NSString* contentDisposition;

- (NSString*)contentDisposition;
- (void)setContentDisposition :(NSString*)newContentDisposition;

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server any time the object is downloaded.

ContentType Property (S3 Module)

This property includes the content type to send for an object.

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 CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server any time the object is downloaded.

EncryptionAlgorithm Property (S3 Module)

This property includes the encryption algorithm.

Syntax

• Swift
• Objective-C

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

public enum S3EncryptionAlgorithms: 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 as follows:

EncryptionPassword Property (S3 Module)

This property includes 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 CreateObject or GetObject is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the specified value 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.

It is also possible, however, to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, for example, the data need to be encrypted or decrypted by another utility that generates Key and IV values differently.

Firewall Property (S3 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.

FollowRedirects Property (S3 Module)

This property determines what happens when the server issues a redirect.

Syntax

• Swift
• Objective-C

public var followRedirects: S3FollowRedirects {
  get {...}
  set {...}
}

public enum S3FollowRedirects: Int32 {
  case frNever = 0
  case frAlways = 1
  case frSameScheme = 2
}

@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects :(int)newFollowRedirects;

Default Value

0

Remarks

This property specifies how the class should behave when the server returns a redirect response (e.g., "Object Moved"). Valid values are as follows:

Idle Property (S3 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 (S3 Module)

This property includes 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 a disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

LocalHost Property (S3 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 (S3 Module)

This property includes a collection of metadata items.

Syntax

• Swift
• Objective-C

public var metadata: Array<S3Metadata> {
  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 S3Metadata items.

This collection is populated when GetObjectInfo is called; and its items are used any time CreateObject, CopyObject, or StartMultipartUpload is called.

ObjectData Property (S3 Module)

This property includes the data that were downloaded or that should be uploaded.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=objectData,setter=setObjectData:) NSString* objectData;

- (NSString*)objectData;
- (void)setObjectData :(NSString*)newObjectData;

@property (nonatomic,readwrite,assign,getter=objectDataB,setter=setObjectDataB:) NSData* objectDataB;

- (NSData*)objectDataB;
- (void)setObjectDataB :(NSData*)newObjectData;

Default Value

""

Remarks

This property is populated with object data after calling GetObject if LocalFile is not set.

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

ObjectDelimiter Property (S3 Module)

This property includes the delimiter string to use when listing objects.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=objectDelimiter,setter=setObjectDelimiter:) NSString* objectDelimiter;

- (NSString*)objectDelimiter;
- (void)setObjectDelimiter :(NSString*)newObjectDelimiter;

Default Value

""

Remarks

If this property is nonempty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a common prefix element, which is returned in place of the individual objects.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class also will populate the PrefixCount and Prefix[i] configuration settings.

Object Hierarchy Traversal

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

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

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ObjectMarker Property (S3 Module)

This property includes a marker indicating what page of objects to return next.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=objectMarker,setter=setObjectMarker:) NSString* objectMarker;

- (NSString*)objectMarker;
- (void)setObjectMarker :(NSString*)newObjectMarker;

Default Value

""

Remarks

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

Refer to ListObjects for more information.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.

ObjectPrefix Property (S3 Module)

This property includes a prefix used to restrict the results returned when listing objects.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=objectPrefix,setter=setObjectPrefix:) NSString* objectPrefix;

- (NSString*)objectPrefix;
- (void)setObjectPrefix :(NSString*)newObjectPrefix;

Default Value

""

Remarks

This property, if nonempty, is used to restrict the results returned by ListObjects (or ListVersions) to only those objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

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

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

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Objects Property (S3 Module)

This property includes a collection of objects.

Syntax

• Swift
• Objective-C

public var objects: Array<S3Object> {
  get {...}
}

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

- (int)objectsCount;

- (BOOL)objectsDeleted:(int)objectsIndex;

- (NSString*)objectsETag:(int)objectsIndex;

- (NSString*)objectsLastModified:(int)objectsIndex;

- (BOOL)objectsLatestVersion:(int)objectsIndex;

- (NSString*)objectsName:(int)objectsIndex;

- (NSString*)objectsOwnerDisplayName:(int)objectsIndex;

- (NSString*)objectsOwnerId:(int)objectsIndex;

- (long long)objectsSize:(int)objectsIndex;

- (NSString*)objectsStorageClass:(int)objectsIndex;

- (NSString*)objectsUploadId:(int)objectsIndex;

- (NSString*)objectsVersionId:(int)objectsIndex;

Default Value

""

Remarks

This collection holds a list of S3Object items.

Calling GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads will populate this collection.

OtherHeaders Property (S3 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 (S3 Module)

This property 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 GetObject. It is applicable only to local files. The default value is .

ParsedHeaders Property (S3 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 (S3 Module)

This property includes 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.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them. Also, this property is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Parts Property (S3 Module)

This property includes a collection of multipart upload parts.

Syntax

• Swift
• Objective-C

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

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

- (int)partsCount;

- (NSString*)partsETag:(int)partsIndex;

- (NSString*)partsLastModified:(int)partsIndex;

- (NSString*)partsObjectName:(int)partsIndex;

- (NSString*)partsOwnerDisplayName:(int)partsIndex;

- (NSString*)partsOwnerId:(int)partsIndex;

- (int)partsNumber:(int)partsIndex;

- (long long)partsSize:(int)partsIndex;

Default Value

""

Remarks

This collection holds a list of S3Part items.

Calling ListParts will populate this collection.

Note: This property is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Proxy Property (S3 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 (S3 Module)

This property includes the additional query parameters to be included in the request.

Syntax

• Swift
• Objective-C

public var queryParams: Array<S3QueryParam> {
  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 using the AddQueryParam method.

Range Property (S3 Module)

This property includes 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 nonempty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

Following are the two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is nonempty, 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 are not downloaded again when the download is resumed.

Region Property (S3 Module)

This property includes the region the module will make requests against.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=region,setter=setRegion:) NSString* region;

- (NSString*)region;
- (void)setRegion :(NSString*)newRegion;

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.

Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime ServiceProvider changes. The custom service provider's "default region" is an empty string (i.e., setting ServiceProvider to spCustom (255) will clear this property).

Note: When the custom service provider is selected, the class uses the base URL specified by the ServiceProviderURL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value any time it generates a request URL. Refer to the ServiceProviderURL setting's documentation for more information.

Amazon S3 Regions

Alibaba Cloud Object Storage Regions

Backblaze B2 Regions

All Backblaze B2 region strings take the form us-west-###, where ### is a three-digit number. By default, the class uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value, which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a nonmaster application key if necessary.

Cloudflare R2 Regions

By default, the class uses auto. This is the only valid value for this service provider.

Digital Ocean Spaces Regions

Google Cloud Storage Regions

Huawei Cloud Object Storage Regions

IBM Cloud Object Storage Regions

Note: Optionally, private. or direct. may be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

Linode Object Storage Regions

Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following nonstandard behaviors:

• Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
• The ListBuckets method will return only those buckets located in the currently selected region; there is no way to retrieve a list of all regions' buckets.
• Similarly, the BucketExists and GetBucketLocation methods consider only those buckets located in the currently selected region.
• The CopyObject method cannot be used to copy objects to a bucket in another region.

Oracle Cloud Object Storage Regions

Wasabi Regions

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently selected ServiceProvider.

SecretKey Property (S3 Module)

This property includes the secret key to use for authentication.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=secretKey,setter=setSecretKey:) NSString* secretKey;

- (NSString*)secretKey;
- (void)setSecretKey :(NSString*)newSecretKey;

Default Value

""

Remarks

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

ServiceProvider Property (S3 Module)

This property includes the S3 service provider to use.

Syntax

• Swift
• Objective-C

public var serviceProvider: S3ServiceProviders {
  get {...}
  set {...}
}

public enum S3ServiceProviders: Int32 {
  case spAmazonS3 = 0
  case spDigitalOcean = 1
  case spGoogleStorage = 2
  case spWasabi = 3
  case spBackblazeB2 = 4
  case spHuawei = 5
  case spAlibaba = 6
  case spIBM = 7
  case spOracle = 8
  case spLinode = 9
  case spCloudflareR2 = 10
  case spSeagateLyveCloud = 11
  case spOortDSS = 12
  case spCustom = 255
}

@property (nonatomic,readwrite,assign,getter=serviceProvider,setter=setServiceProvider:) int serviceProvider;

- (int)serviceProvider;
- (void)setServiceProvider :(int)newServiceProvider;

Default Value

0

Remarks

This property specifies the S3 service provider that the class should use. Possible values are as follows:

Note: The following providers require additional configuration before requests can be made:

• spOracle (8): An Object Storage Namespace must be specified using the OracleNamespace configuration setting.
• spCloudflareR2 (10): An Account ID must be specified using the CloudflareAccountID configuration setting.
• spCustom (255): A base URL must be specified using the ServiceProviderURL configuration setting.

Changing this property will automatically result in the following actions:

• Set the Region property to the default region for the provider (empty string for spCustom (255)).
• Reset the UseSSL property to .
• Reset the StartByte property to 0.
• Clear the ObjectMarker, PartMarker, and VersionMarker properties, as well as the StorageClass and ResumableUploadState configuration settings.

SSLAcceptServerCertEncoded Property (S3 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 (S3 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 (S3 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 (S3 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 (S3 Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum S3SSLCertStoreTypes: 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 (S3 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 (S3 Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum S3SSLProviders: 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 (S3 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 (S3 Module)

This property includes 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 CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.

Note: This property is automatically reset to 0 anytime ServiceProvider changes.

Timeout Property (S3 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.

UseSSL Property (S3 Module)

This method includes whether to use SSL/TLS when connecting.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=useSSL,setter=setUseSSL:) BOOL useSSL;

- (BOOL)useSSL;
- (void)setUseSSL :(BOOL)newUseSSL;

Default Value

True

Remarks

This property specifies whether the class should use Secure Sockets Layer/Transport Layer Security (SSL/TLS) when connecting.

Note: This property is automatically reset to any time ServiceProvider changes. The class will ignore any attempts to change this property if one of the following providers is selected, because they require SSL/TLS to be used:

• spDigitalOcean (1)
• spBackblazeB2 (4)
• spOracle (8)
• spSeagateLyveCloud (11)

UseVirtualHosting Property (S3 Module)

This property determines which URL style to use when making requests.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=useVirtualHosting,setter=setUseVirtualHosting:) BOOL useVirtualHosting;

- (BOOL)useVirtualHosting;
- (void)setUseVirtualHosting :(BOOL)newUseVirtualHosting;

Default Value

True

Remarks

If (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject.

Note: Hosted-style URLs impose more bucket name restrictions because of DNS server naming restrictions. Refer to Amazon's documentation for more information.

If , path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Note: When using the spAmazonS3 (0) service provider, keep in mind that Amazon has publicly announced that buckets created after September 30, 2020, will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020, will continue to support both URL styles.

Note: This property is ignored when ServiceProvider is set to one of the following:

• spAlibaba (6) Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
• spOracle (8) Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.
• spOortDSS (12) Oort DSS does not support virtual-hosted-style URLs, only path-style URLs.

VersionId Property (S3 Module)

This property includes the object version to make requests against.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=versionId,setter=setVersionId:) NSString* versionId;

- (NSString*)versionId;
- (void)setVersionId :(NSString*)newVersionId;

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

Refer to Amazon's Versioning documentation for more information about versioning.

VersioningEnabled Property (S3 Module)

This property includes controls whether versioning is enabled for the currently selected bucket.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=versioningEnabled,setter=setVersioningEnabled:) BOOL versioningEnabled;

- (BOOL)versioningEnabled;
- (void)setVersioningEnabled :(BOOL)newVersioningEnabled;

Default Value

False

Remarks

This property can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.

Note: If Bucket is empty, or refers to a bucket that does not exist, this property will always return when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all.

Refer to Amazon's Versioning documentation for more information about versioning.

Note: When ServiceProvider is spBackblazeB2 (4), this property will always return (assuming Bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.

VersionMarker Property (S3 Module)

This property includes a marker indicating what page of object 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 ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.

AbortMultipartUpload Method (S3 Module)

This method aborts a multipart upload.

Syntax

• Swift
• Objective-C

public func abortMultipartUpload(objectName: String, uploadId: String) throws -> Void

- (void)abortMultipartUpload:(NSString*)objectName :(NSString*)uploadId;

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

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

Note: If any part of the upload is currently in progress, it may be necessary to call this method again after the upload is complete.

If this method is called successfully, the specified UploadId will no longer be valid.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

AddMetadata Method (S3 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 to the Metadata* properties. Name specifies the name of the item, and Value specifies the value of the item. The server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-), it will be stripped off. The class will take care of prepending it when sending metadata to the server.

AddQueryParam Method (S3 Module)

This method 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.

AppendObject Method (S3 Module)

This method appends data to the end of the existing object specified by ObjectName .

Syntax

• Swift
• Objective-C

public func appendObject(objectName: String) throws -> Void

- (void)appendObject:(NSString*)objectName;

Remarks

The data to upload are taken from either or ObjectData (whichever data are found first, when checked in that order).

BucketExists Method (S3 Module)

This method checks whether the bucket exists.

Syntax

• Swift
• Objective-C

public func bucketExists() throws -> Bool

- (BOOL)bucketExists;

Remarks

This method checks whether the bucket specified by Bucket exists, returning if so or if not.

Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.

CheckVersioningEnabled Method (S3 Module)

This method checks whether versioning is enabled for the currently selected bucket.

Syntax

• Swift
• Objective-C

public func checkVersioningEnabled() throws -> Bool

- (BOOL)checkVersioningEnabled;

Remarks

This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.

Note: If Bucket is empty, or refers to a bucket that does not exist, this property will always return when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all.

Refer to Amazon's Versioning documentation for more information about versioning.

Note: When ServiceProvider is spBackblazeB2 (4), this property will always return (assuming Bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.

CompleteMultipartUpload Method (S3 Module)

This method completes a multipart upload by assembling previously uploaded parts.

Syntax

• Swift
• Objective-C

public func completeMultipartUpload(objectName: String, uploadId: String) throws -> Void

- (void)completeMultipartUpload:(NSString*)objectName :(NSString*)uploadId;

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note: 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 spCloudflareR2 (10) ServiceProvider does not support the ListParts S3 operation; thus, when that provider is selected, this method instead relies on the part information contained in the PartInfo[i] configuration setting.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Config Method (S3 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.

CopyObject Method (S3 Module)

This method copies an object.

Syntax

• Swift
• Objective-C

public func copyObject(srcObjectName: String, destBucket: String, destObjectName: String) throws -> Void

- (void)copyObject:(NSString*)srcObjectName :(NSString*)destBucket :(NSString*)destObjectName;

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.

If the VersionId property is nonempty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If any metadata items are present in the Metadata* properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may be copied only to buckets that exist within the same region.
• Objects larger than 5 GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload. Then use the CopyPart method to create parts for that multipart upload using the source object's data.

CopyPart Method (S3 Module)

This method copies the specified object as a part of a multipart upload.

Syntax

• Swift
• Objective-C

public func copyPart(srcObjectName: String, destBucket: String, destObjectName: String, destPartNumber: Int32, destUploadId: String) throws -> Void

- (void)copyPart:(NSString*)srcObjectName :(NSString*)destBucket :(NSString*)destObjectName :(int)destPartNumber :(NSString*)destUploadId;

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

CreateBucket Method (S3 Module)

This method creates a new bucket.

Syntax

• Swift
• Objective-C

public func createBucket() throws -> Void

- (void)createBucket;

Remarks

This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.

CreateObject Method (S3 Module)

This method creates a new object in the currently selected bucket.

Syntax

• Swift
• Objective-C

public func createObject(objectName: String) throws -> Void

- (void)createObject:(NSString*)objectName;

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If any metadata items are present in the Metadata* properties, they will be included in the creation request.

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

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

This method can automatically handle the multipart upload of objects (see below). If it is desired to manually take control of the multipart upload process, see StartMultipartUpload.

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 the upload state information using the ResumableUploadState configuration setting; and tracks how much data have 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.

Note: Automatic multipart uploads are not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

DeleteBucket Method (S3 Module)

This method deletes a bucket.

Syntax

• Swift
• Objective-C

public func deleteBucket() throws -> Void

- (void)deleteBucket;

Remarks

This method deletes the bucket currently selected by Bucket.

Note: For some service providers, bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime. Refer to the provider's documentation for more information.

DeleteObject Method (S3 Module)

This method deletes an object.

Syntax

• Swift
• Objective-C

public func deleteObject(objectName: String) throws -> Void

- (void)deleteObject:(NSString*)objectName;

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.

If the VersionId property is nonempty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If an object's latest version is a delete marker, then the server treats the object as if it did not exist (i.e., it does not appear when listing objects or it cannot be downloaded). If, however, all of the previous versions of the object (including the one that existed just before the delete marker was created) still exist, then they can be listed using ListVersions and explicitly can be interacted with by setting VersionId and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

DisableVersioning Method (S3 Module)

This method disables versioning for the currently selected bucket.

Syntax

• Swift
• Objective-C

public func disableVersioning() throws -> Void

- (void)disableVersioning;

Remarks

This method can be used to disable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

DoEvents Method (S3 Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

EnableVersioning Method (S3 Module)

This method enables versioning for the currently selected bucket.

Syntax

• Swift
• Objective-C

public func enableVersioning() throws -> Void

- (void)enableVersioning;

Remarks

This method can be used to enable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

GetBucketLocation Method (S3 Module)

This method gets a bucket's location.

Syntax

• Swift
• Objective-C

public func getBucketLocation() throws -> String

- (NSString*)getBucketLocation;

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.

Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.

GetLink Method (S3 Module)

This method creates a link that provides access to an object for a specified amount of time.

Syntax

• Swift
• Objective-C

public func getLink(objectName: String, expires: Int32) throws -> String

- (NSString*)getLink:(NSString*)objectName :(int)expires;

Remarks

This method creates and returns a preauthenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is nonempty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note: This method is an offline method that simply generates a presigned URL; no communication with the server takes place.

Note: This method is not supported when ServiceProvider is set to one of the following:

• spGoogleStorage (2)
• spOracle (8)

GetObject Method (S3 Module)

This method downloads an object.

Syntax

• Swift
• Objective-C

public func getObject(objectName: String) throws -> Void

- (void)getObject:(NSString*)objectName;

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is nonempty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.

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

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

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Example 1. 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"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Example 2. Resuming Encrypted File Downloads:

Resuming encrypted file downloads is supported only when LocalFile has been 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 are downloaded, it will be decrypted and written to LocalFile. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

GetObjectInfo Method (S3 Module)

This method gets an object's information and metadata.

Syntax

• Swift
• Objective-C

public func getObjectInfo(objectName: String) throws -> Void

- (void)getObjectInfo:(NSString*)objectName;

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is nonempty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events and also will repopulate the Objects* and Metadata* properties.

Interrupt Method (S3 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.

ListBuckets Method (S3 Module)

This method 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 also will populate the Buckets* properties.

Note: When ServiceProvider is spLinode (9), this method returns only buckets located in the currently selected Region, and it is not possible to retrieve a list of all regions' buckets. Refer to the Linode section of the Region property's documentation for more information.

ListMultipartUploads Method (S3 Module)

This method lists the current multipart uploads.

Syntax

• Swift
• Objective-C

public func listMultipartUploads() throws -> Void

- (void)listMultipartUploads;

Remarks

This method lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload and also will populate the Objects* properties.

If more multipart uploads are still available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all of the pages of results in the Objects* properties.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Note: This method is not supported when ServiceProvider is spOortDSS (12).

Note: When the ServiceProvider is spSeagateLyveCloud (11) the ObjectPrefix property must be specified.

ListObjects Method (S3 Module)

This method lists the objects in a bucket.

Syntax

• Swift
• Objective-C

public func listObjects() throws -> Void

- (void)listObjects;

Remarks

This method lists the objects in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set to restrict the results to only those objects whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object and also will populate the Objects* properties. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

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

Object Hierarchy Traversal

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

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

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ListParts Method (S3 Module)

This method lists the parts in a multipart upload.

Syntax

• Swift
• Objective-C

public func listParts(objectName: String, uploadId: String) throws -> Void

- (void)listParts:(NSString*)objectName :(NSString*)uploadId;

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

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

If more parts are still 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 of the pages of results in the Parts* properties.

This method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the class will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads. Additionally, spCloudflareR2 (10) does not support the ListParts S3 operation.

ListVersions Method (S3 Module)

This method lists the object versions in a bucket.

Syntax

• Swift
• Objective-C

public func listVersions() throws -> Void

- (void)listVersions;

Remarks

This method lists the object versions in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object version and also will populate the Objects* properties. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If more object versions are still 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 Objects* properties.

Object Hierarchy Traversal

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

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

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Reset Method (S3 Module)

This method 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.

ResetHeaders Method (S3 Module)

This method resets all HTTP headers, cookies, and LocalFile.

Syntax

• Swift
• Objective-C

public func resetHeaders() throws -> Void

- (void)resetHeaders;

Remarks

This method resets all HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata* and QueryParam* properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next request.

SendCustomRequest Method (S3 Module)

This method sends a custom request to the server.

Syntax

• Swift
• Objective-C

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

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

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are as follows:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

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

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if ServiceProvider is spCustom (255), the custom URL specified using the ServiceProviderURL configuration setting is used directly, and these properties are ignored.
   • Bucket (if nonempty)
   • ObjectName (if nonempty)
   • VersionId (if both it and ObjectName are nonempty)
   • QueryParam*
2. Adds request headers from the following:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • SessionToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if nonempty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).

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

StartMultipartUpload Method (S3 Module)

This method starts a new manual multipart upload.

Syntax

• Swift
• Objective-C

public func startMultipartUpload(objectName: String) throws -> String

- (NSString*)startMultipartUpload:(NSString*)objectName;

Remarks

This method starts a new manual multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an automatic multipart upload, see the CreateObject method. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If any metadata items are present in the Metadata* properties, they will be included in the creation request and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

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.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

UpdateBucketACL Method (S3 Module)

This method updates a bucket's canned access policy.

Syntax

• Swift
• Objective-C

public func updateBucketACL() throws -> Void

- (void)updateBucketACL;

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

UpdateObjectACL Method (S3 Module)

This method updates an object's canned access policy.

Syntax

• Swift
• Objective-C

public func updateObjectACL(objectName: String) throws -> Void

- (void)updateObjectACL:(NSString*)objectName;

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is nonempty, the canned access policy of the specified version of the object is updated instead.

UploadPart Method (S3 Module)

This method uploads a multipart upload part.

Syntax

• Swift
• Objective-C

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

- (void)uploadPart:(NSString*)objectName :(int)partNumber :(NSString*)uploadId;

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly uploaded part.

The data to upload are taken from either LocalFile or ObjectData (whichever data are found first, when checked in that order). Each part must be at least 5 MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is , the class will include an MD5 digest of its data when sending it to the server. The server then will verify that the data were received without corruption.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

BucketList Event (S3 Module)

This event fires once for each bucket returned when listing buckets.

Syntax

• Swift
• Objective-C

func onBucketList(bucketName: String, creationDate: String, ownerId: String, ownerName: String)

- (void)onBucketList:(NSString*)bucketName :(NSString*)creationDate :(NSString*)ownerId :(NSString*)ownerName;

Remarks

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

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display the name of the bucket's owner, respectively.

EndTransfer Event (S3 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 (S3 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.

FragmentComplete Event (S3 Module)

This event 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 CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically divide the upload data 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 of the upload that has been 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 CreateObject for more information.

Note: This event is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Header Event (S3 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 (S3 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 (S3 Module)

This event fires once for each metadata item returned when object information and metadata are retrieved.

Syntax

• Swift
• Objective-C

func onMetadataList(name: String, value: String)

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

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-).

Note: The server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (S3 Module)

This event fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

• Swift
• Objective-C

func onObjectList(bucketName: String, objectName: String, lastModified: String, size: Int64, eTag: String, ownerId: String, ownerName: String, uploadId: String, versionId: String, latestVersion: Bool, deleted: Bool)

- (void)onObjectList:(NSString*)bucketName :(NSString*)objectName :(NSString*)lastModified :(long long)size :(NSString*)ETag :(NSString*)ownerId :(NSString*)ownerName :(NSString*)uploadId :(NSString*)versionId :(BOOL)latestVersion :(BOOL)deleted;

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. This is not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. This is not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. This is not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. This is not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. This is applicable only when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; is empty in all other cases.

LatestVersion indicates whether this is the latest object version. This is applicable only when ListVersions is called.; is in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; is in all other cases.

PartList Event (S3 Module)

This event fires once for every part returned when listing a multipart upload's parts.

Syntax

• Swift
• Objective-C

func onPartList(partNumber: Int32, objectName: String, lastModified: String, size: Int64, eTag: String, ownerId: String, ownerName: String)

- (void)onPartList:(int)partNumber :(NSString*)objectName :(NSString*)lastModified :(long long)size :(NSString*)ETag :(NSString*)ownerId :(NSString*)ownerName;

Remarks

This event fires once for each part of a multipart upload that is returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

Note: This event is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

PrefixList Event (S3 Module)

This event fires once for each common prefix returned when listing objects.

Syntax

• Swift
• Objective-C

func onPrefixList(bucketName: String, prefix: String)

- (void)onPrefixList:(NSString*)bucketName :(NSString*)prefix;

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is nonempty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (S3 Module)

This event 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. By default, this event will fire each time PercentDone increases by 1 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 the note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown.

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 were transferred before the interruption.

For example, if 10 MB of data were successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10 MB) when the transfer is first resumed, and then will 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 (S3 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 (S3 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 (S3 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 (S3 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.

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: )

S3Bucket Type

This type represents a bucket.

Remarks

This type represents a bucket.

Fields

Constructors

public init()

public init(name: , creationDate: , ownerId: , ownerDisplayName: )

S3Metadata Type

This type represents Amazon's Simple Storage Service (S3) metadata item.

Remarks

This type represents an S3 metadata item.

Fields

Constructors

public init()

public init(name: , value: )

S3Object Type

This type represents an object.

Remarks

This type represents an object.

Fields

Constructors

public init()

public init(name: , lastModified: , size: , storageClass: , eTag: , ownerId: , ownerDisplayName: , uploadId: )

S3Part Type

This type represents a multipart upload part.

Remarks

This type represents a multipart upload part. It is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.

Fields

Constructors

public init()

public init(partNumber: , objectName: , lastModified: , size: , eTag: , ownerId: , ownerDisplayName: )

S3QueryParam Type

This type represents 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 (S3 Module)

S3 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