event

Namespace

event

Description:

  • Process triggers only

    Gives access to information about the current event. Accessed via the global variable event. This variable is only available when the script has been invoked by a process trigger.

Source:

Members

(static) clientIP :String

Description:

  • IP of the client (if any) making the request that triggered the event.

Source:

IP of the client (if any) making the request that triggered the event.

Type:
  • String

(static) fileName :String

Description:

  • Name of the file that the event was triggered on.

Source:

Name of the file that the event was triggered on.

Type:
  • String

(static) filePath :String

Description:

  • Virtual file-system path of the file that the event was triggered on (same as virtualPath).

Source:

Virtual file-system path of the file that the event was triggered on (same as virtualPath).

Type:
  • String

(static) folderPath :String

Description:

  • Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).

Source:

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).

Type:
  • String

(static) loginEmail :String

Description:

  • Email of the user making the request.

Source:

Email of the user making the request.

Type:
  • String

(static) loginFullName :String

Description:

  • Full name of the user making the request.

Source:

Full name of the user making the request.

Type:
  • String

(static) loginUserName :String

Description:

  • User-name of the user making the request.

Source:

User-name of the user making the request.

Type:
  • String

(static) ownerEmail :String

Description:

  • Email of the user that is the owner of the folder in which the event was triggered.

Source:

Email of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) ownerFullName :String

Description:

  • Full name of the user that is the owner of the folder in which the event was triggered.

Source:

Full name of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) ownerUserName :String

Description:

  • User-name of the user that is the owner of the folder in which the event was triggered.

Source:

User-name of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) processRule :String

Description:

  • Name of the process trigger being triggered.

Source:

Name of the process trigger being triggered.

Type:
  • String

(static) protocol :String

Description:

  • Protocol via which the request was made.

Source:

Protocol via which the request was made.

Type:
  • String

(static) serverName :String

Description:

  • Name of the server to whicht the request was made.

Source:

Name of the server to whicht the request was made.

Type:
  • String

(static) siteName :String

Description:

  • Name of the site to whicht the request was made.

Source:

Name of the site to whicht the request was made.

Type:
  • String

(static) time :Date

Description:

  • Time at which the request. was made.

Source:

Time at which the request. was made.

Type:
  • Date

(static) transferStatus :String

Description:

  • Transfer status of the request.

Source:

Transfer status of the request.

Type:
  • String

(static) type :String

Description:

  • Type of the process trigger event (e.g. UploadFile or SiteStart).

Source:

Type of the process trigger event (e.g. UploadFile or SiteStart).

Type:
  • String

(static) virtualFolder :String

Description:

  • Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).

Source:

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).

Type:
  • String

(static) virtualPath :String

Description:

  • Virtual file-system path of the file that the event was triggered on (same as filePath).

Source:

Virtual file-system path of the file that the event was triggered on (same as filePath).

Type:
  • String

(static) windowsFileName :String

Description:

  • Windows file-name of the file or folder that the event was triggered on (usually the same as fileName).

Source:

Windows file-name of the file or folder that the event was triggered on (usually the same as fileName).

Type:
  • String

(static) windowsFolder :String

Description:

  • Windows path of the parent folder containing the file or folder that the event was triggered on.

Source:

Windows path of the parent folder containing the file or folder that the event was triggered on.

Type:
  • String

(static) windowsPath :String

Description:

  • Windows path of the file that the event was triggered on (usually the same as virtualPath).

Source:

Windows path of the file that the event was triggered on (usually the same as virtualPath).

Type:
  • String