aries_cloudagent.protocols.discovery.v1_0 package¶

Subpackages¶

Submodules¶

aries_cloudagent.protocols.discovery.v1_0.manager module¶

Classes to manage discover features.

class aries_cloudagent.protocols.discovery.v1_0.manager.V10DiscoveryMgr(profile: aries_cloudagent.core.profile.Profile)[source]¶

Bases: object

Class for discover feature v1_0 under RFC 31.

check_if_disclosure_received(record_id: str) → aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord[source]¶: Check if disclosures has been received.

create_and_send_query(query: str, comment: str = None, connection_id: str = None) → aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord[source]¶: Create and send a Query message.

lookup_exchange_rec_by_connection(connection_id: str) → Optional[aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord][source]¶: Retrieve V20DiscoveryExchangeRecord by connection_id.

profile¶

Accessor for the current Profile.

Returns:	The Profile for this manager

receive_disclose(disclose_msg: aries_cloudagent.protocols.discovery.v1_0.messages.disclose.Disclose, connection_id: str) → aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord[source]¶: Receive Disclose message and return updated V10DiscoveryExchangeRecord.

receive_query(query_msg: aries_cloudagent.protocols.discovery.v1_0.messages.query.Query) → aries_cloudagent.protocols.discovery.v1_0.messages.disclose.Disclose[source]¶: Process query and return the corresponding disclose message.

exception aries_cloudagent.protocols.discovery.v1_0.manager.V10DiscoveryMgrError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Discover feature v1_0 error.

aries_cloudagent.protocols.discovery.v1_0.message_types module¶

Message type identifiers for Feature Discovery.

aries_cloudagent.protocols.discovery.v1_0.routes module¶

Feature discovery admin routes.

class aries_cloudagent.protocols.discovery.v1_0.routes.QueryDiscoveryExchRecordsSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Query string parameter for Discover Features v1.0 exchange record.

connection_id¶: Used by autodoc_mock_imports.

class aries_cloudagent.protocols.discovery.v1_0.routes.QueryFeaturesQueryStringSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Query string parameters for feature query.

comment¶: Used by autodoc_mock_imports.

connection_id¶: Used by autodoc_mock_imports.

query¶: Used by autodoc_mock_imports.

class aries_cloudagent.protocols.discovery.v1_0.routes.V10DiscoveryExchangeListResultSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for Discover Features v1.0 exchange records.

results¶: Used by autodoc_mock_imports.

aries_cloudagent.protocols.discovery.v1_0.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f42e13a2640>)[source]¶: Amend swagger API.

aries_cloudagent.protocols.discovery.v1_0.routes.query_features(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f42e13a2640>)[source]¶

Request handler for creating and sending feature query.

Parameters:	request – aiohttp request object
Returns:	V10DiscoveryExchangeRecord

aries_cloudagent.protocols.discovery.v1_0.routes.query_records(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f42e13a2640>)[source]¶

Request handler for looking up V10DiscoveryExchangeRecord.

Parameters:	request – aiohttp request object
Returns:	List of V10DiscoveryExchangeRecord

aries_cloudagent.protocols.discovery.v1_0.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f42e13a2640>)[source]¶: Register routes.