DBPAPERAddPaperDocUserResult

@interface DBPAPERAddPaperDocUserResult : NSObject <DBSerializable, NSCopying>

The AddPaperDocUserResult union.

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

  • Initializes union class with tag state of success.

    Description of the success tag state: User was successfully added to the Paper doc.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSuccess;

    Swift

    init(success: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of unknown_error.

    Description of the unknown_error tag state: Something unexpected happened when trying to add the user to the Paper doc.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnknownError;

    Swift

    init(unknownError: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of sharing_outside_team_disabled.

    Description of the sharing_outside_team_disabled tag state: The Paper doc can be shared only with team members.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharingOutsideTeamDisabled;

    Swift

    init(sharingOutsideTeamDisabled: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of daily_limit_reached.

    Description of the daily_limit_reached tag state: The daily limit of how many users can be added to the Paper doc was reached.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDailyLimitReached;

    Swift

    init(dailyLimitReached: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of user_is_owner.

    Description of the user_is_owner tag state: Owner’s permissions cannot be changed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserIsOwner;

    Swift

    init(userIsOwner: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of failed_user_data_retrieval.

    Description of the failed_user_data_retrieval tag state: User data could not be retrieved. Clients should retry.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFailedUserDataRetrieval;

    Swift

    init(failedUserDataRetrieval: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of permission_already_granted.

    Description of the permission_already_granted tag state: This user already has the correct permission to the Paper doc.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPermissionAlreadyGranted;

    Swift

    init(permissionAlreadyGranted: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of other.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

  • Retrieves whether the union’s current tag state has value success.

    Declaration

    Objective-C

    - (BOOL)isSuccess;

    Swift

    func isSuccess() -> Bool

    Return Value

    Whether the union’s current tag state has value success.

  • Retrieves whether the union’s current tag state has value unknown_error.

    Declaration

    Objective-C

    - (BOOL)isUnknownError;

    Swift

    func isUnknownError() -> Bool

    Return Value

    Whether the union’s current tag state has value unknown_error.

  • Retrieves whether the union’s current tag state has value sharing_outside_team_disabled.

    Declaration

    Objective-C

    - (BOOL)isSharingOutsideTeamDisabled;

    Swift

    func isSharingOutsideTeamDisabled() -> Bool

    Return Value

    Whether the union’s current tag state has value sharing_outside_team_disabled.

  • Retrieves whether the union’s current tag state has value daily_limit_reached.

    Declaration

    Objective-C

    - (BOOL)isDailyLimitReached;

    Swift

    func isDailyLimitReached() -> Bool

    Return Value

    Whether the union’s current tag state has value daily_limit_reached.

  • Retrieves whether the union’s current tag state has value user_is_owner.

    Declaration

    Objective-C

    - (BOOL)isUserIsOwner;

    Swift

    func isUserIsOwner() -> Bool

    Return Value

    Whether the union’s current tag state has value user_is_owner.

  • Retrieves whether the union’s current tag state has value failed_user_data_retrieval.

    Declaration

    Objective-C

    - (BOOL)isFailedUserDataRetrieval;

    Swift

    func isFailedUserDataRetrieval() -> Bool

    Return Value

    Whether the union’s current tag state has value failed_user_data_retrieval.

  • Retrieves whether the union’s current tag state has value permission_already_granted.

    Declaration

    Objective-C

    - (BOOL)isPermissionAlreadyGranted;

    Swift

    func isPermissionAlreadyGranted() -> Bool

    Return Value

    Whether the union’s current tag state has value permission_already_granted.

  • Retrieves whether the union’s current tag state has value other.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value other.

  • 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.