did
API
Generated with
did/fmgp/fmgp.did/fmgp.did.comm/fmgp.did.comm.protocol/fmgp.did.comm.protocol.pickup3

fmgp.did.comm.protocol.pickup3

package fmgp.did.comm.protocol.pickup3

Members list

Type members

Classlikes

final case class DeliveryRequest(id: MsgID, from: FROM, to: TO, limit: Int, recipient_did: Option[FROMTO])

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.

Value parameters

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"
}

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeliveryRequest

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class LiveModeChange(id: MsgID, from: FROM, to: TO, live_delivery: Boolean)

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LiveModeChange

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class MessageDelivery(id: MsgID, thid: MsgID, from: FROM, to: TO, recipient_did: Option[FROMTO], attachments: Map[String, Message])

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageDelivery

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class MessagesReceived(id: MsgID, thid: Option[MsgID], from: FROM, to: TO, message_id_list: Seq[String])

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"] },
 "return_route": "all"
}

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessagesReceived

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Status(id: MsgID, thid: MsgID, from: FROM, to: TO, recipient_did: Option[FROMTO], message_count: Int, longest_waited_seconds: Option[Long], newest_received_time: Option[Long], oldest_received_time: Option[Long], total_bytes: Option[Long], live_delivery: Option[Boolean])

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Status

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Status.type
final case class StatusRequest(id: MsgID, from: FROM, to: TO, recipient_did: Option[FROMTO])

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StatusRequest

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Extensions

Extensions

extension (msg: PlaintextMessage)
def toDeliveryRequest: Either[String, DeliveryRequest]
def toLiveModeChange: Either[String, LiveModeChange]
def toMessageDelivery: Either[String, MessageDelivery]
def toMessagesReceived: Either[String, MessagesReceived]
def toStatus: Either[String, Status]
def toStatusRequest: Either[String, StatusRequest]
Generated with