The Vault class represents the document vault.
Description
Public Methods
 ChangePassword | Changes the password of the current user. |
| DetachSession | Detaches the current session from this vault object without logging out the session. |
| DisconnectDevice | Disconnects the specified device of the logged-in user from the server. |
| DoesLicenseHaveFeature | Checks if the current installed license has features enabled. |
| GetAllTranslations | Gets all vault translations as JSON. |
| GetGUID | Gets the GUID of the vault on the server. |
| GetMetadataStructureItemIDByAlias | Receives the ID of the metadata structure element with the specified alias. |
| GetMetadataStructureItemIDsByAliases | Get the metadata structure item's IDs and aliases. |
| GetMetadataStructureVersionID | Receives the metadata structure version ID of the vault. This ID is incremented when the structure of the vault is changed. |
| GetMFilesURLForVaultRoot | Gets the URL to the vault root. |
| GetServerLicenseStatus | Gets the server license status. |
| GetServerVersionOfVault | Receives the version of the server where the vault resides. |
| GetVaultServerAttachments | Gets the vault server attachments. |
| LogOutSilent | Performs a silent logout. |
| LogOutWithDialogs | Logs out from vault. May display dialog boxes during the logout. |
| Restart | Restarts the vault. |
| TestConnectionToServer | Tests the connection to the server. |
| TestConnectionToVault | Tests the connection to the vault. |
| TestConnectionToVaultWithTimeout | Tests the connection to the vault. |
Public Properties
 ApplicationTaskOperations | Gets the application task queue operations interface. |
| AutomaticMetadataOperations | Gets the automatic metadata operations interface. |
| ClassGroupOperations | Gets the class group operations interface. |
| ClassOperations | Gets the class operations interface. |
| ClientOperations | Gets the client operations interface. |
| CurrentLoggedInUserID | The ID of the current logged-in user. |
| CustomApplicationManagementOperations | Gets the custom application management operations interface. |
| DataSetOperations | Gets the data set export operations interface. |
| ElectronicSignatureOperations | Gets the electronic signature operations interface. |
| EventLogOperations | Gets the event log operations interface. |
| ExtensionAuthenticationOperations | Gets the extension authentication operations interface. |
| ExtensionMethodOperations | Gets the vault extension method operations interface. |
| ExternalObjectOperations | Gets the external object operations interface. |
| LoggedIn | Specifies whether a user has logged into the vault. |
| LoginAccountOperations | Gets the vault login account operations interface. |
| LoginSessionID | The session ID as string. |
| ManagementOperations | Gets the management operations interface. |
| Name | The name of this vault. In client mode, returns the name of the vault connection. In server mode, returns the name of the vault on server. |
| NamedACLOperations | Gets the named access control list operations interface. |
| NamedValueStorageOperations | Gets the named value storage interface. |
| NotificationOperations | Receives the interface for vault notification operations. |
| ObjectFileOperations | Gets the object file operations interface. |
| ObjectOperations | Gets the object operations interface. |
| ObjectPropertyOperations | Gets the object property operations interface. |
| ObjectSearchOperations | Gets the object search operations interface. |
| ObjectTypeOperations | Gets the object type operations interface. |
| PropertyDefOperations | Gets the property definition operations interface. |
| ReadOnlyAccess | Specifies whether the user has read-only access to the vault. |
| ScheduledJobManagementOperations | Gets the scheduled job management operations interface. |
| ServerDataPushOperations | Receives the interface for vault server data push operations. |
| SessionInfo | Information about the current session. |
| SharedLinkOperations | Gets the public link operations interface. |
| TraditionalFolderOperations | Gets the traditional folder operations interface. |
| UserGroupOperations | Gets the user group operations interface. |
| UserOperations | Gets the user operations interface. |
| UserOperationsEx | Gets the advanced user operations interface. |
| UserSettingOperations | Gets the user setting operations interface. |
| ValueListItemOperations | Gets the value list item operations interface. |
| ValueListOperations | Gets the value list operations interface. |
| VaultLanguages | Gets all languages of vault. |
| VaultWOPIOperations | Gets the public link operations interface. |
| ViewOperations | Gets the view operations interface. |
| WorkflowOperations | Gets the workflow operations interface. |
Remarks
The vault class interface contains vault-specific methods and properties. In addition, the vault class contains properties for accessing various operation interfaces. The main functionality of M-Files API is grouped into these operation interfaces. Therefore, it is practical to keep the vault object handy, as the operation interfaces are easily referred through the vault object
See Also