Group

public class Group : BoxModel

Contain a set of users, and can be used in place of users in some operations, such as collaborations.

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String
  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }

Properties

  • id

    The ID of the group object.

    Declaration

    Swift

    public let id: String
  • The name of the group

    Declaration

    Swift

    public let name: String?
  • The type of the group

    Declaration

    Swift

    public let groupType: GroupType?
  • When the group object was created.

    Declaration

    Swift

    public let createdAt: Date?
  • When the group object was last modified.

    Declaration

    Swift

    public let modifiedAt: Date?
  • Keeps track of which external source this group is coming.

    Declaration

    Swift

    public let provenance: String?
  • Human readable description of the group. This can be up to 255 characters long

    Declaration

    Swift

    public let description: String?
  • An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    Declaration

    Swift

    public let externalSyncIdentifier: String?
  • Specifies who can invite the group to collaborate on folders.

    Declaration

    Swift

    public let invitabilityLevel: GroupInvitabilityLevel?
  • Specifies who can view the members of the group.

    Declaration

    Swift

    public let memberViewabilityLevel: GroupMemberViewabilityLevel?
  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON dictionary.