aries_cloudagent.protocols.coordinate_mediation.v1_0.models package¶
Submodules¶
aries_cloudagent.protocols.coordinate_mediation.v1_0.models.mediation_record module¶
Store state for Mediation requests.
-
class
aries_cloudagent.protocols.coordinate_mediation.v1_0.models.mediation_record.
MediationRecord
(*, mediation_id: str = None, state: str = None, role: str = None, connection_id: str = None, mediator_terms: Sequence[str] = None, recipient_terms: Sequence[str] = None, routing_keys: Sequence[str] = None, endpoint: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base_record.BaseRecord
Class representing stored mediation information.
-
RECORD_ID_NAME
= 'mediation_id'¶
-
RECORD_TYPE
= 'mediation_requests'¶
-
ROLE_CLIENT
= 'client'¶
-
ROLE_SERVER
= 'server'¶
-
STATE_DENIED
= 'denied'¶
-
STATE_GRANTED
= 'granted'¶
-
STATE_REQUEST
= 'request'¶
-
TAG_NAMES
= {'connection_id', 'role', 'state'}¶
-
classmethod
exists_for_connection_id
(session: aries_cloudagent.core.profile.ProfileSession, connection_id: str) → bool[source]¶ Return whether a mediation record exists for the given connection.
Parameters: - session (ProfileSession) – session
- connection_id (str) – connection_id
Returns: whether record exists
Return type:
-
mediation_id
¶ Get Mediation ID.
-
record_value
¶ Return values of record as dictionary.
-
classmethod
retrieve_by_connection_id
(session: aries_cloudagent.core.profile.ProfileSession, connection_id: str) → aries_cloudagent.protocols.coordinate_mediation.v1_0.models.mediation_record.MediationRecord[source]¶ Retrieve a mediation record by connection ID.
Parameters: - session (ProfileSession) – session
- connection_id (str) – connection_id
Returns: retrieved record
Return type:
-
state
¶ Get Mediation state.
-
-
class
aries_cloudagent.protocols.coordinate_mediation.v1_0.models.mediation_record.
MediationRecordSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base_record.BaseRecordSchema
MediationRecordSchema schema.
-
class
Meta
[source]¶ Bases:
object
MediationRecordSchema metadata.
-
model_class
¶ alias of
MediationRecord
-
unknown
¶ Used by autodoc_mock_imports.
-
-
connection_id
¶ Used by autodoc_mock_imports.
-
endpoint
¶ Used by autodoc_mock_imports.
-
mediation_id
¶ Used by autodoc_mock_imports.
-
mediator_terms
¶ Used by autodoc_mock_imports.
-
recipient_terms
¶ Used by autodoc_mock_imports.
-
role
¶ Used by autodoc_mock_imports.
-
routing_keys
¶ Used by autodoc_mock_imports.
-
class