com.box.sdkgen.managers.sharedlinksfiles

Class AddShareLinkToFileRequestBodySharedLinkField

Object

NullableFieldTracker

SerializableObject

AddShareLinkToFileRequestBodySharedLinkField

All Implemented Interfaces:

Serializable

public class AddShareLinkToFileRequestBodySharedLinkField
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddShareLinkToFileRequestBodySharedLinkField.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumWrapper<AddShareLinkToFileRequestBodySharedLinkAccessField>	access The level of access for the shared link.
protected String	password The password required to access the shared link.
protected AddShareLinkToFileRequestBodySharedLinkPermissionsField	permissions
protected OffsetDateTime	unsharedAt The timestamp at which this shared link will expire.
protected String	vanityName Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	AddShareLinkToFileRequestBodySharedLinkField()
protected	AddShareLinkToFileRequestBodySharedLinkField(AddShareLinkToFileRequestBodySharedLinkField.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
EnumWrapper<AddShareLinkToFileRequestBodySharedLinkAccessField>	getAccess()
String	getPassword()
AddShareLinkToFileRequestBodySharedLinkPermissionsField	getPermissions()
OffsetDateTime	getUnsharedAt()
String	getVanityName()
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

access

protected EnumWrapper<AddShareLinkToFileRequestBodySharedLinkAccessField> access

The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the file (`collaborators`).

If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`.

The `company` access level is only available to paid accounts.

password

protected String password

The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`.

vanityName

protected String vanityName

Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`.

Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.

unsharedAt

protected OffsetDateTime unsharedAt

The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.

permissions

protected AddShareLinkToFileRequestBodySharedLinkPermissionsField permissions

Constructor Detail

AddShareLinkToFileRequestBodySharedLinkField

public AddShareLinkToFileRequestBodySharedLinkField()

AddShareLinkToFileRequestBodySharedLinkField

protected AddShareLinkToFileRequestBodySharedLinkField(AddShareLinkToFileRequestBodySharedLinkField.Builder builder)

Method Detail

getAccess

public EnumWrapper<AddShareLinkToFileRequestBodySharedLinkAccessField> getAccess()

getPassword

public String getPassword()

getVanityName

public String getVanityName()

getUnsharedAt

public OffsetDateTime getUnsharedAt()

getPermissions

public AddShareLinkToFileRequestBodySharedLinkPermissionsField getPermissions()

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