DBTEAMTokenGetAuthenticatedAdminError

@interface DBTEAMTokenGetAuthenticatedAdminError
    : NSObject <DBSerializable, NSCopying>

The TokenGetAuthenticatedAdminError union.

Error returned by tokenGetAuthenticatedAdmin.

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

    Description of the mapping_not_found tag state: The current token is not associated with a team admin, because mappings were not recorded when the token was created. Consider re-authorizing a new access token to record its authenticating admin.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMappingNotFound;

    Swift

    init(mappingNotFound: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of admin_not_active.

    Description of the admin_not_active tag state: Either the team admin that authorized this token is no longer an active member of the team or no longer a team admin.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAdminNotActive;

    Swift

    init(adminNotActive: ())

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

    Declaration

    Objective-C

    - (BOOL)isMappingNotFound;

    Swift

    func isMappingNotFound() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isAdminNotActive;

    Swift

    func isAdminNotActive() -> Bool

    Return Value

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

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