IRPCWebCompanionTaskOperation.AddWebCompanionTask
Server integration API / specialized internal: not for applications write session
Stores a task for M-Files Web Companion and returns the task ID.
| Service | Web companion tasks MFiles.IRPCWebCompanionTaskOperation |
|---|---|
| gRPC method | /MFiles.IRPCWebCompanionTaskOperation/AddWebCompanionTask |
| HTTP (mf-http-grpc) | POST /grpc/v1/add-web-companion-task |
| Request | AddWebCompanionTaskRequest |
| Response | AddWebCompanionTaskResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. M-Files Web calls it before handing a file over to M-Files Web Companion. Applications should not call it.
Request: AddWebCompanionTaskRequest
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 |
|---|---|---|
add_web_companion_request | WebCompanionTask | The Web Companion Task information. |
add_web_companion_request.app_id | string | Web Companion App ID. |
add_web_companion_request.data | string | Display string of the task data. |
add_web_companion_request.action_type | WebCompanionActionType | Web Companion Action type.Values: WEB_COMPANION_ACTION_TYPE_VIEW (0), WEB_COMPANION_ACTION_TYPE_EDIT (1), WEB_COMPANION_ACTION_TYPE_CHECKIN (2), WEB_COMPANION_ACTION_TYPE_SAVE_FILE_EXTENSION (3), WEB_COMPANION_ACTION_TYPE_CO_AUTHOR (4). |
Response: AddWebCompanionTaskResponse
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 |
|---|---|---|
id | int64 | The ID of the stored task. |