DBFILESSaveUrlResult

Objective-C

@interface DBFILESSaveUrlResult : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSaveUrlResult : NSObject, DBSerializable, NSCopying

The SaveUrlResult union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESSaveUrlResultTag tag;

    Swift

    var tag: DBFILESSaveUrlResultTag { get }

  • This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job. @note Ensure the isAsyncJobId method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull asyncJobId;

    Swift

    var asyncJobId: String { get }

  • Metadata of the file where the URL is saved to. - note: Ensure the isComplete method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESFileMetadata *_Nonnull complete;

    Swift

    var complete: DBFILESFileMetadata { get }

Constructors

  • Initializes union class with tag state of “async_job_id”.

    Description of the “async_job_id” tag state: This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAsyncJobId:(nonnull NSString *)asyncJobId;

    Swift

    init(asyncJobId: String)

    Parameters

    asyncJobId

    This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “complete”.

    Description of the “complete” tag state: Metadata of the file where the URL is saved to.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithComplete:
    (nonnull DBFILESFileMetadata *)complete;

    Swift

    init(complete: DBFILESFileMetadata)

    Parameters

    complete

    Metadata of the file where the URL is saved to.

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “async_job_id”.

    Note

    Call this method and ensure it returns true before accessing the asyncJobId property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isAsyncJobId;

    Swift

    func isAsyncJobId() -> Bool

    Return Value

    Whether the union’s current tag state has value “async_job_id”.

  • Retrieves whether the union’s current tag state has value “complete”.

    Note

    Call this method and ensure it returns true before accessing the complete property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isComplete;

    Swift

    func isComplete() -> Bool

    Return Value

    Whether the union’s current tag state has value “complete”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.