event.js

/**
 * **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.
 * @namespace
 */
event = {


	/**
	 * IP of the client (if any) making the request that triggered the event.
	 * 
	 * @type {String}
	 */
	clientIP: null,

	/**
	 * Name of the file that the event was triggered on.
	 * 
	 * @type {String}
	 */
	fileName: null,

	/**
	 * Virtual file-system path of the file that the event was triggered on (same as virtualPath).
	 * 
	 * @type {String}
	 */
	filePath: null,

	/**
	 * Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).
	 * 
	 * @type {String}
	 */
	folderPath: null,

	/**
	 * Email of the user making the request.
	 * 
	 * @type {String}
	 */
	loginEmail: null,

	/**
	 * Full name of the user making the request.
	 * 
	 * @type {String}
	 */
	loginFullName: null,

	/**
	 * User-name of the user making the request.
	 * 
	 * @type {String}
	 */
	loginUserName: null,

	/**
	 * Email of the user that is the owner of the folder in which the event was triggered.
	 * 
	 * @type {String}
	 */
	ownerEmail: null,

	/**
	 * Full name of the user that is the owner of the folder in which the event was triggered.
	 * 
	 * @type {String}
	 */
	ownerFullName: null,

	/**
	 * User-name of the user that is the owner of the folder in which the event was triggered.
	 * 
	 * @type {String}
	 */
	ownerUserName: null,

	/**
	 * Name of the process trigger being triggered.
	 * 
	 * @type {String}
	 */
	processRule: null,

	/**
	 * Protocol via which the request was made.
	 * 
	 * @type {String}
	 */
	protocol: null,

	/**
	 * Name of the server to whicht the request was made.
	 * 
	 * @type {String}
	 */
	serverName: null,

	/**
	 * Name of the site to whicht the request was made.
	 * 
	 * @type {String}
	 */
	siteName: null,

	/**
	 * Time at which the request. was made.
	 * 
	 * @type {Date}
	 */
	time: null,

	/**
	 * Transfer status of the request.
	 * 
	 * @type {String}
	 */
	transferStatus: null,

	/**
	 * Type of the process trigger event (e.g. UploadFile or SiteStart).
	 * 
	 * @type {String}
	 */
	type: null,

	/**
	 * Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).
	 * 
	 * @type {String}
	 */
	virtualFolder: null,

	/**
	 * Virtual file-system path of the file that the event was triggered on (same as filePath).
	 * 
	 * @type {String}
	 */
	virtualPath: null,

	/**
	 * Windows file-name of the file or folder that the event was triggered on (usually the same as fileName).
	 * 
	 * @type {String}
	 */
	windowsFileName: null,

	/**
	 * Windows path of the parent folder containing the file or folder that the event was triggered on.
	 * 
	 * @type {String}
	 */
	windowsFolder: null,

	/**
	 * Windows path of the file that the event was triggered on (usually the same as virtualPath).
	 * 
	 * @type {String}
	 */
	windowsPath: null,
}