SCSFileTransferRequest

@interface SCSFileTransferRequest : NSObject

Information about a file transfer request.

  • Determines if the request is still active. This property returns false/NO after the file transfer has completed regardless of whether the transfer was successful.

    Declaration

    Objective-C

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

    Swift

    var isActive: Bool { get }

  • UIImage that has been attached to this request.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) UIImage *image;

    Swift

    var image: UIImage! { get }

  • Sends the specified image to the agent.

    Declaration

    Objective-C

    - (void)sendImage:(UIImage *)image;

    Swift

    func sendImage(_ image: UIImage!)

    Parameters

    image

    UIImage we are sending through this request.

  • Adds an instance of an id implementing the SCSFileTransferDelegate protocol to the list of delegates to notify.

    Declaration

    Objective-C

    - (void)addDelegate:(id<SCSFileTransferDelegate>)delegate;

    Parameters

    delegate

    id instance to add.

  • Adds an instance of an id implementing the SCSFileTransferDelegate protocol to the list of delegates to notify.

    Declaration

    Objective-C

    - (void)addDelegate:(id<SCSFileTransferDelegate>)delegate
              queue:(dispatch_queue_t)queue;

    Parameters

    delegate

    id instance to add.
    queue

    dispatch_queue_t you wish your events to be called back on.

  • Removes the specified delegate from receiving events in the future.

    Note

    Once the file transfer receives a message that it is expired, completed or failed. All delegates will be removed automatically

    Declaration

    Objective-C

    - (void)removeDelegate:(id<SCSFileTransferDelegate>)delegate;

    Parameters

    delegate

    The SCSFileTransferDelegate which will be removed.