aries_cloudagent.protocols.discovery.v1_0 package

Subpackages

• aries_cloudagent.protocols.discovery.v1_0.handlers package
  • Submodules
  • aries_cloudagent.protocols.discovery.v1_0.handlers.disclose_handler module
  • aries_cloudagent.protocols.discovery.v1_0.handlers.query_handler module
• aries_cloudagent.protocols.discovery.v1_0.messages package
  • Submodules
  • aries_cloudagent.protocols.discovery.v1_0.messages.disclose module
  • aries_cloudagent.protocols.discovery.v1_0.messages.query module
• aries_cloudagent.protocols.discovery.v1_0.models package
  • Submodules
  • aries_cloudagent.protocols.discovery.v1_0.models.discovery_record module

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)

Bases: object

Class for discover feature v1_0 under RFC 31.

async check_if_disclosure_received(record_id: str) → aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord

Check if disclosures has been received.

async create_and_send_query(query: str, comment: Optional[str] = None, connection_id: Optional[str] = None) → aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord

Create and send a Query message.

async lookup_exchange_rec_by_connection(connection_id: str) → Optional[aries_cloudagent.protocols.discovery.v1_0.models.discovery_record.V10DiscoveryExchangeRecord]

Retrieve V20DiscoveryExchangeRecord by connection_id.

property profile: aries_cloudagent.core.profile.Profile

Accessor for the current Profile.

Returns

The Profile for this manager

async 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

Receive Disclose message and return updated V10DiscoveryExchangeRecord.

async receive_query(query_msg: aries_cloudagent.protocols.discovery.v1_0.messages.query.Query) → aries_cloudagent.protocols.discovery.v1_0.messages.disclose.Disclose

Process query and return the corresponding disclose message.

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

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: Any, **kwargs: Any)

Bases: marshmallow.

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

connection_id

class aries_cloudagent.protocols.discovery.v1_0.routes.QueryFeaturesQueryStringSchema(*args: Any, **kwargs: Any)

Bases: marshmallow.

Query string parameters for feature query.

comment

connection_id

query

class aries_cloudagent.protocols.discovery.v1_0.routes.V10DiscoveryExchangeListResultSchema(*args: Any, **kwargs: Any)

Bases: marshmallow.

Result schema for Discover Features v1.0 exchange records.

results

aries_cloudagent.protocols.discovery.v1_0.routes.post_process_routes(app: aiohttp.web.Application)

Amend swagger API.

async aries_cloudagent.protocols.discovery.v1_0.routes.register(app: aiohttp.web.Application)

Register routes.