aries_cloudagent.protocols.discovery.v2_0 package

Subpackages

Submodules

aries_cloudagent.protocols.discovery.v2_0.manager module

Classes to manage discover features.

class aries_cloudagent.protocols.discovery.v2_0.manager.V20DiscoveryMgr(profile: aries_cloudagent.core.profile.Profile)[source]

Bases: object

Class for discover feature v1_0 under RFC 31.

async check_if_disclosure_received(record_id: str) → aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord[source]

Check if disclosures has been received.

async create_and_send_query(connection_id: Optional[str] = None, query_protocol: Optional[str] = None, query_goal_code: Optional[str] = None) → aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord[source]

Create and send a Query message.

async execute_goal_code_query(match: str)[source]

Execute goal code match query.

async execute_protocol_query(match: str)[source]

Execute protocol match query.

async lookup_exchange_rec_by_connection(connection_id: str) → Optional[aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord][source]

Retrieve V20DiscoveryExchangeRecord by connection_id.

async proactive_disclose_features(connection_id: str)[source]

Proactively dislose features on active connection setup.

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.v2_0.messages.disclosures.Disclosures, connection_id: Optional[str] = None) → aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord[source]

Receive Disclose message and return updated V20DiscoveryExchangeRecord.

async receive_query(queries_msg: aries_cloudagent.protocols.discovery.v2_0.messages.queries.Queries) → aries_cloudagent.protocols.discovery.v2_0.messages.disclosures.Disclosures[source]

Process query and return the corresponding disclose message.

async return_to_publish_features() → Tuple[Optional[Sequence[str]], Optional[Sequence[str]]][source]

Return to_publish features filter, if specified.

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

Bases: aries_cloudagent.core.error.BaseError

Discover feature v2_0 error.

aries_cloudagent.protocols.discovery.v2_0.message_types module

Message type identifiers for Feature Discovery.

aries_cloudagent.protocols.discovery.v2_0.routes module

Feature discovery v2 admin routes.

class aries_cloudagent.protocols.discovery.v2_0.routes.QueryDiscoveryExchRecordsSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

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

connection_id
class aries_cloudagent.protocols.discovery.v2_0.routes.QueryFeaturesQueryStringSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Query string parameters for feature query.

connection_id
query_goal_code
query_protocol
class aries_cloudagent.protocols.discovery.v2_0.routes.V20DiscoveryExchangeListResultSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Result schema for Discover Features v2.0 exchange records.

results
class aries_cloudagent.protocols.discovery.v2_0.routes.V20DiscoveryExchangeResultSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Result schema for Discover Features v2.0 exchange record.

results
aries_cloudagent.protocols.discovery.v2_0.routes.post_process_routes(app: aiohttp.web.Application)[source]

Amend swagger API.

async aries_cloudagent.protocols.discovery.v2_0.routes.register(app: aiohttp.web.Application)[source]

Register routes.