aries_cloudagent.transport.inbound package
Submodules
aries_cloudagent.transport.inbound.base module
aries_cloudagent.transport.inbound.delivery_queue module
aries_cloudagent.transport.inbound.http module
aries_cloudagent.transport.inbound.manager module
aries_cloudagent.transport.inbound.message module
Classes representing inbound messages.
- class aries_cloudagent.transport.inbound.message.InboundMessage(payload: Union[str, bytes], receipt: aries_cloudagent.transport.inbound.receipt.MessageReceipt, *, connection_id: Optional[str] = None, session_id: Optional[str] = None, transport_type: Optional[str] = None)[source]
Bases:
object
Container class linking a message payload with its receipt details.
aries_cloudagent.transport.inbound.receipt module
Classes for representing message receipt details.
- class aries_cloudagent.transport.inbound.receipt.MessageReceipt(*, connection_id: Optional[str] = None, direct_response_mode: Optional[str] = None, in_time: Optional[datetime.datetime] = None, raw_message: Optional[str] = None, recipient_verkey: Optional[str] = None, recipient_did: Optional[str] = None, recipient_did_public: Optional[bool] = None, sender_did: Optional[str] = None, sender_verkey: Optional[str] = None, thread_id: Optional[str] = None, parent_thread_id: Optional[str] = None)[source]
Bases:
object
Properties of an agent message’s delivery.
- REPLY_MODE_ALL = 'all'
- REPLY_MODE_NONE = 'none'
- REPLY_MODE_THREAD = 'thread'
- property connection_id: str
Accessor for the pairwise connection identifier.
- Returns
This context’s connection identifier
- property direct_response_mode: str
Accessor for the requested direct response mode.
- Returns
This context’s requested direct response mode
- property direct_response_requested: str
Accessor for the the state of the direct response mode.
- Returns
This context’s requested direct response mode
- property in_time: str
Accessor for the datetime the message was received.
- Returns
This context’s received time
- property parent_thread_id: Optional[str]
Accessor for the identifier of the message parent thread.
- Returns
The delivery parent thread ID
- property recipient_did: str
Accessor for the recipient DID which corresponds with the verkey.
- Returns
The recipient DID
- property recipient_did_public: bool
Check if the recipient did is public.
Indicates whether the message is associated with a public (ledger) recipient DID.
- Returns
True if the recipient’s DID is public, else false
- property recipient_verkey: str
Accessor for the recipient verkey key used to pack the incoming request.
- Returns
The recipient verkey
- property sender_did: str
Accessor for the sender DID which corresponds with the verkey.
- Returns
The sender did