AWSS3TransferUtilityTask

Objective-C

@interface AWSS3TransferUtilityTask : NSObject

Swift

class AWSS3TransferUtilityTask

The task object to represent a upload or download task.

  • An identifier uniquely identifies the transferID.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull transferID;

    Swift

    var transferID: UnsafeMutablePointer<Int32>! { get }

  • An identifier uniquely identifies the task within a given AWSS3TransferUtility instance.

    Declaration

    Objective-C

    @property (readonly) NSUInteger taskIdentifier;

    Swift

    var taskIdentifier: Int32 { get }

  • The Amazon S3 bucket name associated with the transfer.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull bucket;

    Swift

    var bucket: UnsafeMutablePointer<Int32>! { get }
  • key

    The Amazon S3 object key name associated with the transfer.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull key;

    Swift

    var key: UnsafeMutablePointer<Int32>! { get }

  • The transfer progress.

    Declaration

    Objective-C

    @property (readonly) NSProgress *_Nonnull progress;

    Swift

    var progress: UnsafeMutablePointer<Int32>! { get }

  • the status of the Transfer.

    Declaration

    Objective-C

    @property (readonly) AWSS3TransferUtilityTransferStatusType status;

    Swift

    var status: Int32 { get }

  • The underlying NSURLSessionTask object.

    Declaration

    Objective-C

    @property (readonly) NSURLSessionTask *_Nonnull sessionTask;

    Swift

    var sessionTask: UnsafeMutablePointer<Int32>! { get }

  • The HTTP request object.

    Declaration

    Objective-C

    @property (readonly, nullable) NSURLRequest *request;

    Swift

    var request: UnsafeMutablePointer<Int32>? { get }

  • The HTTP response object. May be nil if no response has been received.

    Declaration

    Objective-C

    @property (readonly, nullable) NSHTTPURLResponse *response;

    Swift

    var response: UnsafeMutablePointer<Int32>? { get }

  • Cancels the task.

    Declaration

    Objective-C

    - (void)cancel;

    Swift

    func cancel()

  • Resumes the task, if it is suspended.

    Declaration

    Objective-C

    - (void)resume;

    Swift

    func resume()

  • Temporarily suspends a task.

    Declaration

    Objective-C

    - (void)suspend;

    Swift

    func suspend()