SharedLinkData

public struct SharedLinkData : Encodable

Defines shared link data for updating file information. Shared links provide direct, read-only access to files or folder on Box using a URL

  • The access level for the shared link. Can be open (People with the link), company (People in your company), or collaborators (People in this folder). When creating a shared link, if you omit this field then the access level will be set to the default access level specified by the enterprise admin.

    Declaration

    Swift

    public let access: SharedLinkAccess?

  • The password required to access the shared link.

    Declaration

    Swift

    public let password: NullableParameter<String>?

  • The date-time that this link will become disabled.

    Declaration

    Swift

    public let unsharedAt: NullableParameter<Date>?

  • Whether the shared link allows downloads and previews.

    Declaration

    Swift

    public let permissions: [String : Bool]?

  • Initializer.

    Declaration

    Swift

    public init(
    access: SharedLinkAccess? = nil,
    password: NullableParameter<String>? = nil,
    unsharedAt: NullableParameter<Date>? = nil,
    canDownload: Bool? = nil
)

    Parameters

    access

    The access level for the shared link
    password

    The password required to access the shared link. Set to null to remove the password.
    unsharedAt

    The date-time that this link will become disabled. This field can only be set by users with paid accounts.
    canDownload

    Permission specifying whether user can download from the shared link.