EnvironmentData

View as Markdown

Describes the device the client runs on. All fields are optional.

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

Fields

Field	Type	Number	Description
`client_name`	`string`	1	A name for the client device, such as its host name. Shown as the session's computer name. Must not start with `@{`.
`timezone`	`TimeZoneInformation`	2	The client device's time zone. Leave unset if unknown.
`host_platform`	`string`	3	Free-form description of the platform, for example `Windows 11` or `Python 3.13`.
`device_token`	`string`	4	A stable, globally unique identifier of the device. Used by M-Files clients that register devices; see DisconnectDevice.

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.Relogin -- Logs in again by using the current session ID. Used by M-Files' own clients.

Used in fields

LogInRemoteRequest.environment_data -- Description of the client environment.
ReloginRequest.environment_data -- Describes the client device, as in LogIn.
LogInRequest.environment_data -- Describes the client device. Optional; client_name is shown as the session's computer name.