BoxSharedResourceDetail Type

This type defines details about the shared resource options.

Remarks

The fields specified in this type provide information about the shared resource settings.

Fields

This field specifies the type of access granted to a shared link. The possible values are:


0 (saDefault - default)	The default sharing settings for the account.
1 (saOpen)	Authorized users may access the link.
2 (saCompany)	Users within the same company may access the link.
3 (saCollaborators)	Only collaborators may access the link.

CanDownload
boolean

Whether downloads are allowed. If True (default) users of the link may download the resource.

CanPreview
boolean

Whether the resource can be previewed. If True the resource can be previewed using the link. This is only applicable if Access is set to saOpen or saCompany. The default value is False.

DownloadURL
String

A direct download link. This link allows users to directly download the file without making further calls to the Box service. This is only applicable for paid accounts.

Password
String

The password to protect the resource. If set, a password must be provided by other users when accessing the resource specific by the link. If unspecified no password is required to use the link.

PasswordRequired
boolean

Whether the link is protected by a password. If True a password must be provided to access the resource at the link.

UnsharedDate
String

The date at which the resource will no longer be shared.

This value may optionally be set to specify the day on which the resource will no longer be shared. This setting may only be set if the account is a paid account. Timestamps are rounded off to the provided day.

Dates are formatted as RFC 3399 timestamps. When specifying a date in a request it should be converted to UTC for instance:

2016-04-17T09:12:36-00:00

Dates returned in responses may contain an offset. For instance:

2016-03-02T13:40:24-08:00

URL
String

The URL of the link. This is populated after calling ShareResource or GetSharedResourceInfo. This link may be provided to other users so that they may access the resource.

Constructors

public BoxSharedResourceDetail();