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: str = None, state: str = None, invi_msg_id: str = None, invitation: Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage, Mapping] = None, invitation_url: str = None, oob_id: str = None, public_did: str = None, trace: bool = False, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents an out of band invitation record.

class Meta

Bases: object

InvitationRecord metadata.

schema_class = 'InvitationRecordSchema'

RECORD_ID_NAME = 'invitation_id'

RECORD_TOPIC = 'oob_invitation'

RECORD_TYPE = 'oob_invitation'

STATE_AWAIT_RESPONSE = 'await_response'

STATE_DONE = 'done'

STATE_INITIAL = 'initial'

TAG_NAMES = {'invi_msg_id'}

invitation

Accessor; get deserialized view.

invitation_id

Accessor for the ID associated with this exchange.

record_value

Accessor for the JSON record value generated for this invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.models.invitation.InvitationRecordSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeSchema

Schema to allow serialization/deserialization of invitation records.

class Meta

Bases: object

InvitationRecordSchema metadata.

model_class

alias of InvitationRecord

invi_msg_id

Used by autodoc_mock_imports.

invitation

Used by autodoc_mock_imports.

invitation_id

Used by autodoc_mock_imports.

invitation_url

Used by autodoc_mock_imports.

oob_id

Used by autodoc_mock_imports.

state

Used by autodoc_mock_imports.

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)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents an out of band record.

class Meta

Bases: object

OobRecord metadata.

schema_class = 'OobRecordSchema'

RECORD_ID_NAME = 'oob_id'

RECORD_TOPIC = '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'}

delete_record(session: aries_cloudagent.core.profile.ProfileSession)

Perform connection record deletion actions.

Parameters:session (ProfileSession) – session

invitation

Accessor; get deserialized view.

metadata_delete(session: aries_cloudagent.core.profile.ProfileSession, key: str)

Delete custom metadata associated with this connection.

Parameters:

• session (ProfileSession) – session used for storage
• key (str) – key of metadata to delete

metadata_get(session: aries_cloudagent.core.profile.ProfileSession, key: str, default: Any = None) → Any

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

metadata_get_all(session: aries_cloudagent.core.profile.ProfileSession) → dict

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

metadata_set(session: aries_cloudagent.core.profile.ProfileSession, key: str, value: Any)

Set arbitrary metadata associated with this connection.

Parameters:

• session (ProfileSession) – session used for storage
• key (str) – key identifying metadata
• value (Any) – value to set

oob_id

Accessor for the ID associated with this exchange.

record_value

Accessor for the JSON record value generated for this invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.models.oob_record.OobRecordSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeSchema

Schema to allow serialization/deserialization of invitation records.

class Meta

Bases: object

OobRecordSchema metadata.

model_class

alias of OobRecord

attach_thread_id

Used by autodoc_mock_imports.

connection_id

Used by autodoc_mock_imports.

invi_msg_id

Used by autodoc_mock_imports.

invitation

Used by autodoc_mock_imports.

oob_id

Used by autodoc_mock_imports.

our_recipient_key

Used by autodoc_mock_imports.

role

Used by autodoc_mock_imports.

state

Used by autodoc_mock_imports.

their_service

Used by autodoc_mock_imports.