ClientData

View as Markdown

Describes the client software that logs in.

Full name	`MFiles.ClientData`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`version`	`uint64`	1	The client's version, packed like `QueryVersionResponse.server_version` (`major << 48 \| minor << 32 \| build << 16 \| patch`). May be 0. If the server administrator has set a minimum client version, older clients are refused with `E_MFILES_INCOMPATIBLE_SERVER_VERSION`.
`capabilities`	`ClientCapabilities`	2	Features the client software handles. The server adapts some responses to them, so set only the flags your code implements; leave the rest false.
`language`	`string`	3	The client's language, for example `en`. For LogInWithSession, empty means the language of the existing session.
`type`	`ClientType`	4	The kind of client. Applications use `CLIENT_TYPE_SERVER_API`.
`type_specifier`	`string`	5	Optional free-form name of the client application.

Used by methods

IRPCLogin.LogIn -- Authenticates the caller and opens a session to a vault, or to the server when the vault GUID is all zeros.
IRPCLogin.LogInRemote -- Logs in (with authentication) to a remote server.
IRPCLogin.LogInWithSession -- Opens a new session to a vault (or the server) for the user of an existing session, without authenticating again.
IRPCLogin.Relogin -- Logs in again by using the current session ID. Used by M-Files' own clients.

Used in fields

LogInWithSessionRequest.client_data -- Describes the client software, as in LogIn.
LogInRemoteRequest.client_data -- Description of the client.
ReloginRequest.client_data -- Describes the client software, as in LogIn.
LogInRequest.client_data -- Describes the client software. Set type (for example CLIENT_TYPE_SERVER_API) and language; set capabilities only for features your code handles.