aries_cloudagent.protocols.out_of_band.v1_0.models package

Submodules

aries_cloudagent.protocols.out_of_band.v1_0.models.invitation module

Record for out of band invitations.

class aries_cloudagent.protocols.out_of_band.v1_0.models.invitation.InvitationRecord(*, invitation_id: Optional[str] = None, state: Optional[str] = None, invi_msg_id: Optional[str] = None, invitation: Optional[Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage, Mapping]] = None, invitation_url: Optional[str] = None, oob_id: Optional[str] = None, public_did: Optional[str] = None, trace: bool = False, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents an out of band invitation record.

class Meta[source]

Bases: object

InvitationRecord metadata.

schema_class = 'InvitationRecordSchema'
RECORD_ID_NAME = 'invitation_id'
RECORD_TOPIC: Optional[str] = 'oob_invitation'
RECORD_TYPE = 'oob_invitation'
STATE_AWAIT_RESPONSE = 'await_response'
STATE_DONE = 'done'
STATE_INITIAL = 'initial'
TAG_NAMES = {'invi_msg_id'}
property invitation: aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage

Accessor; get deserialized view.

property invitation_id: str

Accessor for the ID associated with this exchange.

property record_value: dict

Accessor for the JSON record value generated for this invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.models.invitation.InvitationRecordSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema to allow serialization/deserialization of invitation records.

class Meta[source]

Bases: object

InvitationRecordSchema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.models.invitation.InvitationRecord

invi_msg_id
invitation
invitation_id
invitation_url
oob_id
state

aries_cloudagent.protocols.out_of_band.v1_0.models.oob_record module

Record for out of band invitations.

class aries_cloudagent.protocols.out_of_band.v1_0.models.oob_record.OobRecord(*, state: str, invi_msg_id: str, role: str, invitation: Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage, Mapping[str, Any]], their_service: Optional[aries_cloudagent.messaging.decorators.service_decorator.ServiceDecorator] = None, connection_id: Optional[str] = None, reuse_msg_id: Optional[str] = None, oob_id: Optional[str] = None, attach_thread_id: Optional[str] = None, our_recipient_key: Optional[str] = None, our_service: Optional[aries_cloudagent.messaging.decorators.service_decorator.ServiceDecorator] = None, multi_use: bool = False, trace: bool = False, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents an out of band record.

class Meta[source]

Bases: object

OobRecord metadata.

schema_class = 'OobRecordSchema'
RECORD_ID_NAME = 'oob_id'
RECORD_TOPIC: Optional[str] = 'out_of_band'
RECORD_TYPE = 'oob_record'
RECORD_TYPE_METADATA = 'connection_metadata'
ROLE_RECEIVER = 'receiver'
ROLE_SENDER = 'sender'
STATE_ACCEPTED = 'reuse-accepted'
STATE_AWAIT_RESPONSE = 'await-response'
STATE_DONE = 'done'
STATE_INITIAL = 'initial'
STATE_NOT_ACCEPTED = 'reuse-not-accepted'
STATE_PREPARE_RESPONSE = 'prepare-response'
TAG_NAMES = {'attach_thread_id', 'connection_id', 'invi_msg_id', 'our_recipient_key', 'reuse_msg_id'}
async delete_record(session: aries_cloudagent.core.profile.ProfileSession)[source]

Perform connection record deletion actions.

Parameters

session (ProfileSession) – session

property invitation: aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage

Accessor; get deserialized view.

async metadata_delete(session: aries_cloudagent.core.profile.ProfileSession, key: str)[source]

Delete custom metadata associated with this connection.

Parameters

  • session (ProfileSession) – session used for storage

  • key (str) – key of metadata to delete

async metadata_get(session: aries_cloudagent.core.profile.ProfileSession, key: str, default: Optional[Any] = None) → Any[source]

Retrieve arbitrary metadata associated with this connection.

Parameters

  • session (ProfileSession) – session used for storage

  • key (str) – key identifying metadata

  • default (Any) – default value to get; type should be a JSON compatible value.

Returns

metadata stored by key

Return type

Any

async metadata_get_all(session: aries_cloudagent.core.profile.ProfileSession) → dict[source]

Return all custom metadata associated with this connection.

Parameters

session (ProfileSession) – session used for storage

Returns

dictionary representation of all metadata values

Return type

dict

async metadata_set(session: aries_cloudagent.core.profile.ProfileSession, key: str, value: Any)[source]

Set arbitrary metadata associated with this connection.

Parameters

  • session (ProfileSession) – session used for storage

  • key (str) – key identifying metadata

  • value (Any) – value to set

property oob_id: str

Accessor for the ID associated with this exchange.

property record_value: dict

Accessor for the JSON record value generated for this invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.models.oob_record.OobRecordSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema to allow serialization/deserialization of invitation records.

class Meta[source]

Bases: object

OobRecordSchema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.models.oob_record.OobRecord

attach_thread_id
connection_id
invi_msg_id
invitation
oob_id
our_recipient_key
role
state
their_service