com.box.sdk

Enum BoxWebHook.Trigger

Object

Enum<BoxWebHook.Trigger>

BoxWebHook.Trigger

All Implemented Interfaces:

Serializable, Comparable<BoxWebHook.Trigger>

Enclosing class:

BoxWebHook

public static enum BoxWebHook.Trigger
extends Enum<BoxWebHook.Trigger>

A Box related triggers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLLABORATION_ACCEPTED Triggered when a BoxCollaboration is accepted.
COLLABORATION_CREATED Triggered when a BoxCollaboration is created.
COLLABORATION_REJECTED Triggered when a BoxCollaboration is rejected.
COLLABORATION_REMOVED Triggered when a BoxCollaboration is removed.
COLLABORATION_UPDATED Triggered when a BoxCollaboration is updated.
COMMENT_CREATED Triggered when a BoxComment was created.
COMMENT_DELETED Triggered when a BoxComment was deleted.
COMMENT_UPDATED Triggered when a BoxComment was updated.
FILE_COPIED Triggered when a BoxFile gets copied.
FILE_DELETED Triggered when a BoxFile is permanently deleted.
FILE_DOWNLOADED Triggered when a BoxFile is downloaded.
FILE_LOCKED Triggered when a BoxFile gets locked.
FILE_MOVED Triggered when a BoxFile gets copied.
FILE_PREVIEWED Triggered when a BoxFile is previewed.
FILE_RENAMED Triggered when a BoxFile is renamed.
FILE_RESTORED Triggered when a BoxFile gets restored.
FILE_TRASHED Triggered when a BoxFile is trashed.
FILE_UNLOCKED Triggered when a BoxFile gets unlocked.
FILE_UPLOADED Triggered when a BoxFile gets uploaded.
FOLDER_COPIED Triggered when a BoxFolder gets copied.
FOLDER_CREATED Triggered when a BoxFolder gets created.
FOLDER_DELETED Triggered when a BoxFolder gets deleted.
FOLDER_DOWNLOADED Triggered when a BoxFolder is downloaded.
FOLDER_MOVED Triggered when a BoxFolder gets moved.
FOLDER_RENAMED Triggered when a BoxFolder is renamed.
FOLDER_RESTORED Triggered when a BoxFolder gets restored.
FOLDER_TRASHED Triggered when a BoxFolder is trashed.
METADATA_INSTANCE_CREATED Triggered when a metadata template is associated to a BoxFile or BoxFolder.
METADATA_INSTANCE_DELETED Triggered when a metadata template is removed from a BoxFile or BoxFolder.
METADATA_INSTANCE_UPDATED Triggered when a field is updated in the metadata on a BoxFile or BoxFolder.
SHARED_LINK_CRATED Triggered when a BoxSharedLink is created.
SHARED_LINK_DELETED Triggered when a BoxSharedLink is deleted.
SHARED_LINK_UPDATED Triggered when a BoxSharedLink is updated.
SIGN_REQUEST_COMPLETED Triggered when BoxSignRequest is completed.
SIGN_REQUEST_DECLINED Triggered when BoxFile is declined.
SIGN_REQUEST_ERROR_FINALIZING Triggered when the signature request could not be processed.
SIGN_REQUEST_EXPIRED Triggered when BoxFile is expired.
SIGN_REQUEST_SIGNATURE_REQUESTED Triggered when the signature is requested from the signer.
SIGN_REQUEST_SIGNER_EMAIL_BOUNCED Triggered when a signer's email is bounced.
SIGN_REQUEST_SIGNER_SIGNED Triggered when the signature request is signed.
TASK_ASSIGNMENT_CREATED Triggered when a BoxTaskAssignment is created.
TASK_ASSIGNMENT_UPDATED Triggered when a BoxTaskAssignment is updated.
WEBHOOK_DELETED Triggered when a BoxWebHook is deleted.

Method Summary

Modifier and Type	Method and Description
static BoxWebHook.Trigger	fromValue(String value)
String[]	getTypes()
String	getValue()
static BoxWebHook.Trigger	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxWebHook.Trigger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FOLDER_CREATED

public static final BoxWebHook.Trigger FOLDER_CREATED

Triggered when a BoxFolder gets created.

FOLDER_COPIED

public static final BoxWebHook.Trigger FOLDER_COPIED

Triggered when a BoxFolder gets copied.

FOLDER_MOVED

public static final BoxWebHook.Trigger FOLDER_MOVED

Triggered when a BoxFolder gets moved.

FOLDER_DOWNLOADED

public static final BoxWebHook.Trigger FOLDER_DOWNLOADED

Triggered when a BoxFolder is downloaded.

FOLDER_TRASHED

public static final BoxWebHook.Trigger FOLDER_TRASHED

Triggered when a BoxFolder is trashed.

FOLDER_RESTORED

public static final BoxWebHook.Trigger FOLDER_RESTORED

Triggered when a BoxFolder gets restored.

FOLDER_DELETED

public static final BoxWebHook.Trigger FOLDER_DELETED

Triggered when a BoxFolder gets deleted.

FOLDER_RENAMED

public static final BoxWebHook.Trigger FOLDER_RENAMED

Triggered when a BoxFolder is renamed.

FILE_UPLOADED

public static final BoxWebHook.Trigger FILE_UPLOADED

Triggered when a BoxFile gets uploaded.

FILE_COPIED

public static final BoxWebHook.Trigger FILE_COPIED

Triggered when a BoxFile gets copied.

FILE_MOVED

public static final BoxWebHook.Trigger FILE_MOVED

Triggered when a BoxFile gets copied.

FILE_PREVIEWED

public static final BoxWebHook.Trigger FILE_PREVIEWED

Triggered when a BoxFile is previewed.

FILE_DOWNLOADED

public static final BoxWebHook.Trigger FILE_DOWNLOADED

Triggered when a BoxFile is downloaded.

FILE_LOCKED

public static final BoxWebHook.Trigger FILE_LOCKED

Triggered when a BoxFile gets locked.

FILE_UNLOCKED

public static final BoxWebHook.Trigger FILE_UNLOCKED

Triggered when a BoxFile gets unlocked.

FILE_TRASHED

public static final BoxWebHook.Trigger FILE_TRASHED

Triggered when a BoxFile is trashed. Do not include file versions for now.

FILE_RESTORED

public static final BoxWebHook.Trigger FILE_RESTORED

Triggered when a BoxFile gets restored.

FILE_DELETED

public static final BoxWebHook.Trigger FILE_DELETED

Triggered when a BoxFile is permanently deleted.

FILE_RENAMED

public static final BoxWebHook.Trigger FILE_RENAMED

Triggered when a BoxFile is renamed.

COMMENT_CREATED

public static final BoxWebHook.Trigger COMMENT_CREATED

Triggered when a BoxComment was created.

COMMENT_UPDATED

public static final BoxWebHook.Trigger COMMENT_UPDATED

Triggered when a BoxComment was updated.

COMMENT_DELETED

public static final BoxWebHook.Trigger COMMENT_DELETED

Triggered when a BoxComment was deleted.

TASK_ASSIGNMENT_CREATED

public static final BoxWebHook.Trigger TASK_ASSIGNMENT_CREATED

Triggered when a BoxTaskAssignment is created.

TASK_ASSIGNMENT_UPDATED

public static final BoxWebHook.Trigger TASK_ASSIGNMENT_UPDATED

Triggered when a BoxTaskAssignment is updated.

METADATA_INSTANCE_CREATED

public static final BoxWebHook.Trigger METADATA_INSTANCE_CREATED

Triggered when a metadata template is associated to a BoxFile or BoxFolder.

METADATA_INSTANCE_UPDATED

public static final BoxWebHook.Trigger METADATA_INSTANCE_UPDATED

Triggered when a field is updated in the metadata on a BoxFile or BoxFolder.

METADATA_INSTANCE_DELETED

public static final BoxWebHook.Trigger METADATA_INSTANCE_DELETED

Triggered when a metadata template is removed from a BoxFile or BoxFolder.

WEBHOOK_DELETED

public static final BoxWebHook.Trigger WEBHOOK_DELETED

Triggered when a BoxWebHook is deleted.

COLLABORATION_CREATED

public static final BoxWebHook.Trigger COLLABORATION_CREATED

Triggered when a BoxCollaboration is created.

COLLABORATION_ACCEPTED

public static final BoxWebHook.Trigger COLLABORATION_ACCEPTED

Triggered when a BoxCollaboration is accepted.

COLLABORATION_REJECTED

public static final BoxWebHook.Trigger COLLABORATION_REJECTED

Triggered when a BoxCollaboration is rejected.

COLLABORATION_REMOVED

public static final BoxWebHook.Trigger COLLABORATION_REMOVED

Triggered when a BoxCollaboration is removed.

COLLABORATION_UPDATED

public static final BoxWebHook.Trigger COLLABORATION_UPDATED

Triggered when a BoxCollaboration is updated.

SHARED_LINK_CRATED

public static final BoxWebHook.Trigger SHARED_LINK_CRATED

Triggered when a BoxSharedLink is created.

SHARED_LINK_UPDATED

public static final BoxWebHook.Trigger SHARED_LINK_UPDATED

Triggered when a BoxSharedLink is updated.

SHARED_LINK_DELETED

public static final BoxWebHook.Trigger SHARED_LINK_DELETED

Triggered when a BoxSharedLink is deleted.

SIGN_REQUEST_COMPLETED

public static final BoxWebHook.Trigger SIGN_REQUEST_COMPLETED

Triggered when BoxSignRequest is completed.

SIGN_REQUEST_DECLINED

public static final BoxWebHook.Trigger SIGN_REQUEST_DECLINED

Triggered when BoxFile is declined.

SIGN_REQUEST_EXPIRED

public static final BoxWebHook.Trigger SIGN_REQUEST_EXPIRED

Triggered when BoxFile is expired.

SIGN_REQUEST_SIGNER_EMAIL_BOUNCED

public static final BoxWebHook.Trigger SIGN_REQUEST_SIGNER_EMAIL_BOUNCED

Triggered when a signer's email is bounced.

SIGN_REQUEST_SIGNER_SIGNED

public static final BoxWebHook.Trigger SIGN_REQUEST_SIGNER_SIGNED

Triggered when the signature request is signed.

SIGN_REQUEST_SIGNATURE_REQUESTED

public static final BoxWebHook.Trigger SIGN_REQUEST_SIGNATURE_REQUESTED

Triggered when the signature is requested from the signer.

SIGN_REQUEST_ERROR_FINALIZING

public static final BoxWebHook.Trigger SIGN_REQUEST_ERROR_FINALIZING

Triggered when the signature request could not be processed.

Method Detail

values

public static BoxWebHook.Trigger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BoxWebHook.Trigger c : BoxWebHook.Trigger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoxWebHook.Trigger valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static BoxWebHook.Trigger fromValue(String value)

Parameters:

value - value to get the Trigger enum value for

Returns:

Trigger for given value

getValue

public String getValue()

Returns:

String representation for BoxWebHook.Trigger.

getTypes

public String[] getTypes()

Returns:

Supported types for a web-hook.