IRPCWOPIOperationsPublic.GetActiveParticipants
Server integration API / specialized internal: not for applications write no session
Lists the other users who currently have an open co-authoring session on the same file.
| Service | WOPI operations (anonymous) MFiles.IRPCWOPIOperationsPublic |
|---|---|
| gRPC method | /MFiles.IRPCWOPIOperationsPublic/GetActiveParticipants |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-active-participants |
| Request | GetActiveParticipantsRequest |
| Response | GetActiveParticipantsResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. M-Files clients call it during co-authoring. Applications should not call it.
- Works only with a token of a co-authoring session; others fail with access denied.
- Lists the users of the unexpired WOPI user sessions on the same co-authoring link whose creating M-Files session is still valid, leaving out the user who created the link.
Request: GetActiveParticipantsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
wopi_user_session_key | string | The WOPI user session token. |
Response: GetActiveParticipantsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
wopi_active_users[] | repeated WOPIActiveUsers | The user names (username) of the participants. |
wopi_active_users[].username | string | The Username of the user. |