VaultConnectionInfo

View as Markdown

Struct for info needed to connect to a vault.

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

Fields

Field	Type	Number	Description
`connection_mode`	`MFilesAPIMode`	1	The connection mode of M-Files API.Values: `MFILES_APIMODE_NORMAL` (0), `MFILES_APIMODE_INTERNAL_SERVER_ACCESS` (1), `MFILES_APIMODE_INTERNAL_SERVER_ACCESS_WITH_VAULT_MANAGEMENT` (2).
`rpc_binding_string`	`string`	2	Binding string to the server.
`minimum_rpc_authentication_level`	`uint32`	3	Ignored if connectionsecuritymode is specified. RPC_C_AUTHN_LEVEL_NONE or RPC_C_AUTHN_LEVEL_PKT_PRIVACY. Specifies the minimum authentication level to use if the protocol sequence is normal RPC, such as ncacn_ip_tcp. Ignored for other protocol sequences.
`server_version`	`string`	4	Server version string (e.g. "10.0.3757" or "10.0.3757.0").
`client_computer_name`	`string`	5	The local computer name override used in the session.
`vault_guid`	`string`	6	The GUID of the vault.
`vault_display_name`	`string`	7	The name of the vault for display purposes.
`locale_for_sorting`	`uint32`	8	Locale used for sorting.
`session_id`	`bytes`	9	The session identifier.
`session_info`	`SessionInfoServer`	10	General session information.
`attachment_guid`	`string`	11	The current attachment GUID of the vault.
`enable_keep_alive`	`bool`	12	True to allow the keep-alive thread to run.
`server_vault_capabilities`	`ServerVaultCapabilities`	13	Capabilities of M-Files Server and the connected document vault.
`client_capabilities`	`ClientCapabilities`	14	Capabilities of M-Files Client that were reported for the server when the connection (session) was established.
`optional_grpc_cookies`	`string`	15	Optional cookie data for gRPC connections. May contain multiple "<cookie_name>=<cookie_value>" cookies separated by newline character.
`server_data`	`ServerData`	16	Server data, including the product serial number and deployment type. Used to populate serial number and deployment type on SessionInfo.
`connection_security_mode`	`ConnectionSecurityMode`	17	Connection security mode. Overrides dwMinimumAuthenticationLevelIfNormalRPC if specified.Values: `CONNECTION_SECURITY_MODE_UNSPECIFIED` (0), `CONNECTION_SECURITY_MODE_NONE` (1), `CONNECTION_SECURITY_MODE_ENCRYPTED` (2), `CONNECTION_SECURITY_MODE_ENCRYPTED_IF_BUILTIN_KEY_AVAILABLE` (3).

Used by methods

IRPCLogin.GetVaultConnectionInfo -- Gets the full connection information of the current vault session, in the form the M-Files COM API uses.

Used in fields

GetVaultConnectionInfoResponse.connection_info -- The vault connection information of the user's session.