SessionData

View as Markdown

A new session, returned by LogIn and the other login methods.

Full nameMFiles.SessionData
Proto filemfiles/structs.proto

Fields

FieldTypeNumberDescription
session_idbytes1The session ID (48 bytes). Send it unchanged in the mfiles-session-id-bin metadata header of every call that needs a session.
account_namestring2The login account name, with the case stored on the server.
access_rightsSessionAccess3What the session may do on server level and in the vault, regardless of object permissions.
server_vault_capabilitiesServerVaultCapabilities4Capabilities of the server and, for vault sessions, the vault, as they apply to this user. More precise than GetServerCapabilities.
localeuint325The Windows locale ID used for sorting, for example 1033.
keep_alive_interval_in_secondsuint326Call KeepAlive at least this often. It is half of the session's idle timeout.
use_strict_set_equality_comparisonbool7If false, not equal type comparisons are performed in pre-MF11 style in which it is enough that at least one of the left-side values does not match any of the right-side values in order to treat the left and right values unequal. If true, none of the left-side values can match any of the right-side values in order to treat the left and right values unequal i.e. pure set-based exclusion. Prefer using the new comparison style. The old behavior is provided for compatibility reasons.
product_modeProductMode8The edition of the server license.Values: PRODUCT_MODE_FULL (0), PRODUCT_MODE_EXPRESS (1), PRODUCT_MODE_BUSINESS (2).
vault_dataVaultData9The user's identity in the vault. Unset for a server-level session.
account_typeAccountType10Whether the login account is an M-Files or a Windows account.Values: ACCOUNT_TYPE_UNINITIALIZED (0), ACCOUNT_TYPE_MFILES (1), ACCOUNT_TYPE_WINDOWS (2).
server_dataServerData11The server's license serial number and deployment type.
license_typeLicenseType12The license the session uses.Values: LICENSE_TYPE_NONE (0), LICENSE_TYPE_NAMED_USER_LICENSE (1), LICENSE_TYPE_CONCURRENT_USER_LICENSE (2), LICENSE_TYPE_READ_ONLY_LICENSE (3), LICENSE_TYPE_VISITOR_LICENSE (4).
keep_upload_session_alive_interval_in_secondsuint3213Keep a file upload session alive at least this often (half of the upload session timeout).

Used by methods

Used in fields