com.box.sdkgen.schemas.file

Class FileSharedLinkField

Object

NullableFieldTracker

SerializableObject

FileSharedLinkField

All Implemented Interfaces:

Serializable

public class FileSharedLinkField
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSharedLinkField.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumWrapper<FileSharedLinkAccessField>	access The access level for this shared link.
protected long	downloadCount The number of times this item has been downloaded.
protected String	downloadUrl A URL that can be used to download the file.
protected EnumWrapper<FileSharedLinkEffectiveAccessField>	effectiveAccess The effective access level for the shared link.
protected EnumWrapper<FileSharedLinkEffectivePermissionField>	effectivePermission The effective permissions for this shared link.
protected boolean	isPasswordEnabled Defines if the shared link requires a password to access the item.
protected FileSharedLinkPermissionsField	permissions Defines if this link allows a user to preview, edit, and download an item.
protected long	previewCount The number of times this item has been previewed.
protected OffsetDateTime	unsharedAt The date and time when this link will be unshared.
protected String	url The URL that can be used to access the item on Box.
protected String	vanityName The custom name of a shared link, as used in the `vanity_url` field.
protected String	vanityUrl The "Custom URL" that can also be used to preview the item on Box.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSharedLinkField(FileSharedLinkField.Builder builder)
	FileSharedLinkField(String url, EnumWrapper<FileSharedLinkEffectiveAccessField> effectiveAccess, EnumWrapper<FileSharedLinkEffectivePermissionField> effectivePermission, boolean isPasswordEnabled, long downloadCount, long previewCount)
	FileSharedLinkField(String url, EnumWrapper<FileSharedLinkEffectiveAccessField> effectiveAccess, FileSharedLinkEffectivePermissionField effectivePermission, boolean isPasswordEnabled, long downloadCount, long previewCount)
	FileSharedLinkField(String url, FileSharedLinkEffectiveAccessField effectiveAccess, EnumWrapper<FileSharedLinkEffectivePermissionField> effectivePermission, boolean isPasswordEnabled, long downloadCount, long previewCount)
	FileSharedLinkField(String url, FileSharedLinkEffectiveAccessField effectiveAccess, FileSharedLinkEffectivePermissionField effectivePermission, boolean isPasswordEnabled, long downloadCount, long previewCount)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
EnumWrapper<FileSharedLinkAccessField>	getAccess()
long	getDownloadCount()
String	getDownloadUrl()
EnumWrapper<FileSharedLinkEffectiveAccessField>	getEffectiveAccess()
EnumWrapper<FileSharedLinkEffectivePermissionField>	getEffectivePermission()
boolean	getIsPasswordEnabled()
FileSharedLinkPermissionsField	getPermissions()
long	getPreviewCount()
OffsetDateTime	getUnsharedAt()
String	getUrl()
String	getVanityName()
String	getVanityUrl()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

url

protected final String url

The URL that can be used to access the item on Box.

This URL will display the item in Box's preview UI where the file can be downloaded if allowed.

This URL will continue to work even when a custom `vanity_url` has been set for this shared link.

downloadUrl

protected String downloadUrl

A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.

This property will be `null` for folders.

vanityUrl

protected String vanityUrl

The "Custom URL" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.

vanityName

protected String vanityName

The custom name of a shared link, as used in the `vanity_url` field.

access

protected EnumWrapper<FileSharedLinkAccessField> access

The access level for this shared link.

* `open` - provides access to this item to anyone with this link * `company` - only provides access to this item to people the same company * `collaborators` - only provides access to this item to people who are collaborators on this item

If this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin.

effectiveAccess

protected final EnumWrapper<FileSharedLinkEffectiveAccessField> effectiveAccess

The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels.

effectivePermission

protected final EnumWrapper<FileSharedLinkEffectivePermissionField> effectivePermission

The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder.

unsharedAt

protected OffsetDateTime unsharedAt

The date and time when this link will be unshared. This field can only be set by users with paid accounts.

isPasswordEnabled

protected final boolean isPasswordEnabled

Defines if the shared link requires a password to access the item.

permissions

protected FileSharedLinkPermissionsField permissions

Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself.

downloadCount

protected final long downloadCount

The number of times this item has been downloaded.

previewCount

protected final long previewCount

The number of times this item has been previewed.

Constructor Detail

FileSharedLinkField

public FileSharedLinkField(String url,
                           FileSharedLinkEffectiveAccessField effectiveAccess,
                           FileSharedLinkEffectivePermissionField effectivePermission,
                           boolean isPasswordEnabled,
                           long downloadCount,
                           long previewCount)

FileSharedLinkField

public FileSharedLinkField(String url,
                           FileSharedLinkEffectiveAccessField effectiveAccess,
                           EnumWrapper<FileSharedLinkEffectivePermissionField> effectivePermission,
                           boolean isPasswordEnabled,
                           long downloadCount,
                           long previewCount)

FileSharedLinkField

public FileSharedLinkField(String url,
                           EnumWrapper<FileSharedLinkEffectiveAccessField> effectiveAccess,
                           FileSharedLinkEffectivePermissionField effectivePermission,
                           boolean isPasswordEnabled,
                           long downloadCount,
                           long previewCount)

FileSharedLinkField

public FileSharedLinkField(String url,
                           EnumWrapper<FileSharedLinkEffectiveAccessField> effectiveAccess,
                           EnumWrapper<FileSharedLinkEffectivePermissionField> effectivePermission,
                           boolean isPasswordEnabled,
                           long downloadCount,
                           long previewCount)

FileSharedLinkField

protected FileSharedLinkField(FileSharedLinkField.Builder builder)

Method Detail

getUrl

public String getUrl()

getDownloadUrl

public String getDownloadUrl()

getVanityUrl

public String getVanityUrl()

getVanityName

public String getVanityName()

getAccess

public EnumWrapper<FileSharedLinkAccessField> getAccess()

getEffectiveAccess

public EnumWrapper<FileSharedLinkEffectiveAccessField> getEffectiveAccess()

getEffectivePermission

public EnumWrapper<FileSharedLinkEffectivePermissionField> getEffectivePermission()

getUnsharedAt

public OffsetDateTime getUnsharedAt()

getIsPasswordEnabled

public boolean getIsPasswordEnabled()

getPermissions

public FileSharedLinkPermissionsField getPermissions()

getDownloadCount

public long getDownloadCount()

getPreviewCount

public long getPreviewCount()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object