M-Files API 23.11.13135.0
MFilesClientApplication Object
Members 
Description
The MFilesClientApplication class represents connection to the client.

The MFilesClientApplication class represents an M-Files Client application.

The MFilesClientApplication class is the high-level object of the M-Files API component. This is the first object you create when writing an application that interacts with Windows Explorer using M-Files API.

Public Methods
Public Method AddVaultConnectionAdds a new vault connection to the collection of vaults configured in M-Files Desktop.
Public Method BindToVaultBinds to a vault with the specified name (e.g., 'Sample Vault'). The default authentication method is used if the login is allowed.
Public Method FindFileGets a file based on the specified path.
Public Method FindObjectVersionAndPropertiesGets an object based on the specified path.
Public Method GetAPIVersionReceives the version of the API.
Public Method GetClientLanguageReturns the current M-Files software language.
Public Method GetClientVersionReceives the version of the client.
Public Method GetDriveLetterGets the drive letter of M-Files Desktop.
Public Method GetVaultConnectionReturns the vault connection with the specified name.
Public Method GetVaultConnectionsReturns a collection of vaults configured in M-Files Desktop.
Public Method GetVaultConnectionsWithGUIDReturns a collection of vaults with the specified GUID configured in M-Files Desktop.
Public Method IsObjectPathInMFilesChecks whether the specified path refers to an object in M-Files.
Public Method LogInAsLogs in to the vault with the specified name (e.g., 'Sample Vault'). Prompts the user for credentials.
Public Method LogInAsUserLogs in to the vault with the specified name (e.g., 'Sample Vault') using the specified credentials.
Public Method RemoveVaultConnectionDeletes the vault connection with the specified name from the collection of vaults configured in M-Files Desktop.
Public Method ShowBalloonTipDisplays a tooltip message over M-Files status icon.
Public Method TestConnectionToServerExTests the connection to the specified server.
Remarks

Accessing M-Files through this interface allows your application to use M-Files client application services. In addition, objects acquired by using this interface use the M-Files client application for their operations. Objects and actions behave similarly when accessed from the M-Files user interface (e.g., the objects use local caches and the actions performed in API are visible from the user interface).

You should use either the client or server application interface, but not both of them. Mixing objects from different interfaces may yield unpredictable results.

Example
Creating an MFilesClientApplication object and accessing the vault (Visual Basic) Copy Code

' Initialize the MFilesClientApplication object.
Dim oClientApp As New MFilesAPI.MFilesClientApplication

' Log in to a vault through document vault connection "Demo". Me refers to the current form
' of the calling application.
Dim oVaultConnection As MFilesAPI.VaultConnection = oClientApp.GetVaultConnection("Demo")
Dim oVault As MFilesAPI.Vault = oVaultConnection.BindToVault(Me.Handle, True, True)
See Also

MFilesClientApplication Members  | MFilesServerApplication Object

 

 

© 2023 M-Files Corporation. All rights reserved.

Send comments