DBTEAMGroupsGetInfoItem

Objective-C

@interface DBTEAMGroupsGetInfoItem : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMGroupsGetInfoItem : NSObject, DBSerializable, NSCopying

The GroupsGetInfoItem 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) DBTEAMGroupsGetInfoItemTag tag;

    Swift

    var tag: DBTEAMGroupsGetInfoItemTag { get }

  • An ID that was provided as a parameter to groupsGetInfo, and did not match a corresponding group. The ID can be a group ID, 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 group. - note: Ensure the isGroupInfo method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMGroupFullInfo *_Nonnull groupInfo;

    Swift

    var groupInfo: DBTEAMGroupFullInfo { 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 groupsGetInfo, and did not match a corresponding group. The ID can be a group ID, 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 groupsGetInfo, and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.

    Return Value

    An initialized instance.

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

    Description of the “group_info” tag state: Info about a group.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupInfo:
    (nonnull DBTEAMGroupFullInfo *)groupInfo;

    Swift

    init(groupInfo: DBTEAMGroupFullInfo)

    Parameters

    groupInfo

    Info about a group.

    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 “group_info”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isGroupInfo;

    Swift

    func isGroupInfo() -> Bool

    Return Value

    Whether the union’s current tag state has value “group_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.