DBTEAMMembersGetInfoItem

Objective-C

@interface DBTEAMMembersGetInfoItem : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMembersGetInfoItem : NSObject, DBSerializable, NSCopying

The MembersGetInfoItem union.

Describes a result obtained for a single user whose id was specified in the parameter of membersGetInfo.

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) DBTEAMMembersGetInfoItemTag tag;

    Swift

    var tag: DBTEAMMembersGetInfoItemTag { get }

  • An ID that was provided as a parameter to membersGetInfo or membersGetInfo, and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called. - note: Ensure the isIdNotFound method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var idNotFound: String { get }

  • Info about a team member. - note: Ensure the isMemberInfo method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMTeamMemberInfo *_Nonnull memberInfo;

    Swift

    var memberInfo: DBTEAMTeamMemberInfo { get }

Constructors

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

    Description of the “id_not_found” tag state: An ID that was provided as a parameter to membersGetInfo or membersGetInfo, and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIdNotFound:(nonnull NSString *)idNotFound;

    Swift

    init(idNotFound: String)

    Parameters

    idNotFound

    An ID that was provided as a parameter to membersGetInfo or membersGetInfo, and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

    Return Value

    An initialized instance.

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

    Description of the “member_info” tag state: Info about a team member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMemberInfo:
    (nonnull DBTEAMTeamMemberInfo *)memberInfo;

    Swift

    init(memberInfo: DBTEAMTeamMemberInfo)

    Parameters

    memberInfo

    Info about a team member.

    Return Value

    An initialized instance.

Tag state methods

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isIdNotFound;

    Swift

    func isIdNotFound() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isMemberInfo;

    Swift

    func isMemberInfo() -> Bool

    Return Value

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

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