Collaboration

public class Collaboration : BoxModel

Defines access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role.

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

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

Properties

  • id

    Identifier

    Declaration

    Swift

    public let id: String

  • The user who created the collaboration object.

    Declaration

    Swift

    public let createdBy: User?

  • When the collaboration object was created.

    Declaration

    Swift

    public let createdAt: Date?

  • When the collaboration object was last modified.

    Declaration

    Swift

    public let modifiedAt: Date?

  • When the collaboration will expire.

    Declaration

    Swift

    public let expiresAt: Date?

  • The status of the collaboration invitation.

    Declaration

    Swift

    public let status: CollaborationStatus?

  • The user or group that is granted access.

    Declaration

    Swift

    public let accessibleBy: Collaborator?

  • The level of access granted.

    Declaration

    Swift

    public let role: CollaborationRole?

  • When the status of the collaboration object changed to accepted or rejected.

    Declaration

    Swift

    public let acknowledgedAt: Date?

  • The file or folder that access is granted to

    Declaration

    Swift

    public let item: CollaborationItem?

  • The email address used to invite an un-registered collaborator, if they are not a registered user.

    Declaration

    Swift

    public let inviteEmail: String?

  • Whether the “view path collaboration” feature is enabled or not. View path collaborations allow the invitee to see the entire parent path to the item. View path collaboration does not grant privileges in any parent folder (e.g. cannot see content the user is not collaborated on), other than the permission to view the parent path.

    Declaration

    Swift

    public let canViewPath: Bool?

  • The acceptance requirements for the user or enterprise.

    Declaration

    Swift

    public let acceptanceRequirementsStatus: AcceptanceRequirementsStatus?

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

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

    Parameters

    json

    JSON dictionary.

  • Defines the Acceptance Requirements Status object.

    See more

    Declaration

    Swift

    public class AcceptanceRequirementsStatus : BoxModel

  • Defines the Terms of Service requirement for the Acceptance Requirements object.

    See more

    Declaration

    Swift

    public class TermsOfServiceRequirement : BoxModel

  • Defines the Strong Password requirement for the Acceptance Requirements object.

    See more

    Declaration

    Swift

    public class StrongPasswordRequirement : BoxModel

  • Defines the Two Factor Authentication Requirement for Acceptance Requirements object.

    See more

    Declaration

    Swift

    public class TwoFactorAuthenticationRequirement : BoxModel