WOPIUserSession

Struct for WOPI User Session information.

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

Fields

Field	Type	Number	Description
`wopi_user_session_key`	`string`	1	The WOPI vault user session key.
`wopi_accesskey`	`string`	2	The access of the shared file.
`action_type`	`WOPIActionType`	3	The WOPI Action type.Values: `WOPIACTION_TYPE_VIEW` (0), `WOPIACTION_TYPE_EDIT` (1), `WOPIACTION_TYPE_COAUTHORING` (2).
`user_account_id`	`uint32`	4	The user ID.
`user_account_name`	`string`	5	The user Account Name.
`external_username`	`string`	6	The External user name.
`additional_data`	`WOPIClientAdditionalData`	7	WOPI Client Additional data.
`obj_ver`	`ObjVer`	8	The ObjVer of the object.
`file_ver`	`FileVer`	9	The FileVer of the object.
`is_shared_file`	`bool`	10	Specifies the Shared file.
`is_coauthor`	`bool`	11	Specifies the Co-authored file.
`csrftoken`	`string`	12	The CSRF Token.
`onetimetoken`	`string`	13	The One Time Token.
`is_edit_allowed`	`bool`	14	Specifies whether the file can be edited or not.
`client_type`	`ClientType`	15	The client type (user agent) identifier.

IRPCWOPIOperations.CreateWOPIUserSession -- Creates a WOPI user session for one file version and returns its token (or a one-time token that can be exchanged for it).
IRPCWOPIOperationsPublic.GetWOPIUserSession -- Gets the details of a WOPI user session: the shared object and file version, the action, the user and whether editing is allowed.

CreateWOPIUserSessionRequest.wopi_user_session -- The file to open: obj_ver, file_ver, action_type, user_account_id (the session's own user ID), external_username (usually empty) and additional_data (the URLs and culture that the WOPI host passes on to Office for the web; th...
GetWOPIUserSessionResponse.wopi_user_session -- The session. is_edit_allowed is false when the user's license is read-only, the user lacks edit access, the object is deleted or has no editable files, an older version is shared, or the object is checked out to someone else (except in...