IRPCServerDataPush.SendDataPushResponse
Vault API / standard write session
Sends the client's answer to a push request received from OpenServerDataPush.
| Service | Server push MFiles.IRPCServerDataPush |
|---|---|
| gRPC method | /MFiles.IRPCServerDataPush/SendDataPushResponse |
| HTTP (mf-http-grpc) | POST /grpc/v1/send-data-push-response |
| Request | SendDataPushResponseRequest |
| Response | SendDataPushResponseResponse |
| Book and level | Vault API, standard |
| 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
- Requires the same vault session that received the request.
idmust be theresponse_idof a request that the server is still waiting for. Any other ID, including 0, an ID of a notification, or an ID whose wait has timed out, fails with "The parameter is incorrect. (<id>)".- Has the same effect as SendPushDataResponse.
Request: SendDataPushResponseRequest
The request of SendDataPushResponse: the client's answer to a push request.
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 | int32 | The response_id of the ServerDataPushItem being answered. |
response_data | ServerDataPushResponse | The answer: set type to the type of the request and fill the matching member of data, or report a failure in error. See ServerDataPushResponse. |
response_data.type | ServerDataPushRequestType | Response type.Values: SERVER_DATA_PUSH_REQUEST_TYPE_UNINITIALIZED (0), SERVER_DATA_PUSH_REQUEST_TYPE_ELECTRONIC_SIGNATURE_REQUEST (1), SERVER_DATA_PUSH_REQUEST_TYPE_EXTENSION_AUTHENTICATION_REQUEST (2), SERVER_DATA_PUSH_REQUEST_TYPE_OBJECTS_CHANGED_NOTIFICATION (3). |
response_data.data | ServerDataPushResponseUnion | The actual message data. |
response_data.data.electronic_signature_request | ElectronicSignatureResponse (oneof data) | Electronic signature response. |
response_data.data.extension_authentication_request | ExtensionAuthenticationResponseFromClient (oneof data) | Extension authentication response. Encrypted with the server public key. |
response_data.error | RPCErrorInfoArray | Possible error encountered when serving the request. |
response_data.error.value[] | repeated RPCErrorInfo | Array of errors. |
Response: SendDataPushResponseResponse
Response for the SendDataPushResponse call.
No fields.
Related methods
- OpenServerDataPush -- Opens the session's push channel: a stream of requests and notifications from the server.
- IRPCVault.SendPushDataResponse -- Sends a response for server data push. This is a response for request received with RequestPushDataAsync call (with non-zero request id). This call completes the push data cycle.