fmgp.did.comm.protocol.pickup3
Members list
Type members
Classlikes
A request from the recipient to the mediator to have pending messages delivered.
A request from the recipient to the mediator to have pending messages delivered.
Attributes
- recipient_did
Optional. When specified, the mediator MUST only return status related to that recipient did. This allows the recipient to discover if any messages are in the queue that were sent to a specific did.
{ "id": "123456780", "type": "ttps://didcomm.org/messagepickup/3.0/delivery-request", "body": { "limit": 10, "recipient_did": "<did for messages>" }, "return_route": "all" }- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- DeliveryRequest.type
Live Mode is changed with a live-delivery-change message.
Live Mode is changed with a live-delivery-change message.
{
"id": "123456780",
"type": "https://didcomm.org/messagepickup/3.0/live-delivery-change",
"body": { "live_delivery": true }
}
Attributes
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- LiveModeChange.type
Batch of messages delivered to the recipient as attachments.
Batch of messages delivered to the recipient as attachments.
{
"id": "123456780",
"thid": "<message id of delivery-request message>",
"type": "https://didcomm.org/messagepickup/3.0/delivery",
"body": { "recipient_did": "<did for messages>" },
"attachments": [ { "id": "<id of message>", "data": { "base64": "<message>" } } ]
}
Attributes
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- MessageDelivery.type
After receiving messages, the recipient sends an acknowledge message indiciating which messages are safe to clear from the queue.
After receiving messages, the recipient sends an acknowledge message indiciating which messages are safe to clear from the queue.
{
"id": "123456780",
"type": "https://didcomm.org/messagepickup/3.0/messages-received",
"body": { "message_id_list": ["123","456"] }
}
Attributes
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- MessagesReceived.type
Status details about waiting messages.
Status details about waiting messages.
{
"id": "123456780",
"type": "https://didcomm.org/messagepickup/3.0/status",
"body": {
"recipient_did": "<did for messages>",
"message_count": 7,
"longest_waited_seconds": 3600,
"newest_received_time": 1658085169,
"oldest_received_time": 1658084293,
"total_bytes": 8096,
"live_delivery": false
}
}
Attributes
- Companion:
- object
- Graph
- Supertypes
Sent by the recipient to the mediator to request a status message.
Sent by the recipient to the mediator to request a status message.
{
"id": "123456780",
"type": "https://didcomm.org/messagepickup/3.0/status-request",
"body" : { "recipient_did": "<did for messages>" },
"return_route": "all"
}
Attributes
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- StatusRequest.type