M-Files Vault Application Framework
Event
Properties
| ActivityID |
Accessor for the activity id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase) |
| ActivityIDExternal |
Original activity identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| CurrentTransactionID |
Accessor for the transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase) |
| CurrentTransactionIDExternal |
Original transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| CurrentUserID |
The user id who caused the event handler call.
(Inherited from EnvironmentBase) |
| CurrentUserSessionInfo |
Returns the original user SessionInfo if it exists in the current context.
(Inherited from EnvironmentBase) |
| CurrentUserSessionInfoExternal |
The session info that represents the original (invoking) user session.
(Inherited from EnvironmentBase) |
| DisplayID |
The handled object or value list item display id. Relevant only for events that handle objects of value list items.
(Inherited from EnvironmentBase) |
| EventType | Accessor for the event type. |
| FileTransferSessionID | The file transfer session id. Available only for file transfer related events. |
| FileVer | Accessor for the file version. Clones the object to local process on first call. |
| FileVerExternal | Original file version object. The object may be physically located in other process. |
| GroupID | |
| Input | The input string for vault extension method. |
| InputBytes | |
| InputHttpHeaders | |
| InputHttpMethod | |
| InputParams | An array of input parameters passed. (Assumes they were in JSON array format) |
| InputQueryString | |
| IsCancellable | Tells if the operation can be cancelled by throwing an error. |
| IsObjectEvent | Resolves if the event is object version specific event. |
| IsRecordObject | Resolves if the event target is a record object. |
| IsTemplateObject | Resolves if the event target is a template object. |
| LoggedOutUserID | The user id for logged out user. Available only for logout event. |
| LoginAccount | Accessor for the login account. Clones the object to local process on first call. |
| LoginAccountExternal | Original login account object. The object may be physically located in other process. |
| MasterTransactionID |
Accessor for the master transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase) |
| MasterTransactionIDExternal |
Original master transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| MemberID | |
| ObjectAccessControlList | Accessor for the ACL object. Clones the object to local process on first call. |
| ObjectAccessControlListExternal | Original ACL object. The object may be physically located in other process. |
| ObjID | |
| ObjIdExternal | |
| ObjVer |
Accessor for the object version identifier object. Clones the object to local process on first call.
(Inherited from EnvironmentBase) |
| ObjVerEx |
Returns an ObjVerEx for the current environment's ObjVer, if it exists.
(Inherited from EnvironmentBase) |
| ObjVerExternal |
Original object identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| ParentTransactionID |
Accessor for the parent transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase) |
| ParentTransactionIDExternal |
Original parent transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| PropertyValues | Accessor for the property values object. Clones the object to local process on first call. |
| PropertyValuesExternal | Original property values object. The object may be physically located in other process. |
| RestoredVersions | |
| RestoredVersionsExternal | |
| SavepointVariables |
(Inherited from EnvironmentBase) |
| SavepointVariablesExternal |
(Inherited from EnvironmentBase) |
| TransactionCache |
Accessor for the transaction cache.
(Inherited from EnvironmentBase) |
| TransactionCacheExternal |
Original transaction cache object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| Type | The event type for which this event handler environment was built. |
| UserAccount | Accessor for the user account object. Clones the object to local process on first call. |
| UserAccountExternal | Original user account object. The object may be physically located in other process. |
| UserGroupAdmin | Accessor for the user group admin object. Clones the object to local process on first call. |
| UserGroupAdminExternal | Original user group admin object. The object may be physically located in other process. |
| ValueListItem | Accessor for the value list item object. Clones the object to local process on first call. |
| ValueListItemExternal | Original value list item object. The object may be physically located in other process. |
| Vault |
The vault object. The vault object session is bound with the ongoing database transaction.
(Inherited from EnvironmentBase) |
| VaultExtensionMethodName | The vault extension method to call. |
| VaultSharedVariables |
Accessor for the shared variables.
(Inherited from EnvironmentBase) |
| VaultSharedVariablesExternal |
Original vault shared variables object. The object may be physically located in other process.
(Inherited from EnvironmentBase) |
| View | Accessor for the external view object. |
| ViewExternal | Original view object. The object may be physically located in other process. |