DBTEAMTeamFolderGetInfoItem

Objective-C

@interface DBTEAMTeamFolderGetInfoItem : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMTeamFolderGetInfoItem : NSObject, DBSerializable, NSCopying

The TeamFolderGetInfoItem 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) DBTEAMTeamFolderGetInfoItemTag tag;

    Swift

    var tag: DBTEAMTeamFolderGetInfoItemTag { get }

  • An ID that was provided as a parameter to teamFolderGetInfo did not match any of the team’s team folders. - 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 }

  • Properties of a team folder. - note: Ensure the isTeamFolderMetadata method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMTeamFolderMetadata *_Nonnull teamFolderMetadata;

    Swift

    var teamFolderMetadata: DBTEAMTeamFolderMetadata { 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 teamFolderGetInfo did not match any of the team’s team folders.

    Declaration

    Objective-C

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

    Swift

    init(idNotFound: String)

    Parameters

    idNotFound

    An ID that was provided as a parameter to teamFolderGetInfo did not match any of the team’s team folders.

    Return Value

    An initialized instance.

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

    Description of the “team_folder_metadata” tag state: Properties of a team folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamFolderMetadata:
    (nonnull DBTEAMTeamFolderMetadata *)teamFolderMetadata;

    Swift

    init(teamFolderMetadata: DBTEAMTeamFolderMetadata)

    Parameters

    teamFolderMetadata

    Properties of a team folder.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTeamFolderMetadata;

    Swift

    func isTeamFolderMetadata() -> Bool

    Return Value

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

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