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.

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

create_and_send_query(connection_id: str = None, query_protocol: str = None, query_goal_code: str = None) → aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord[source]¶: Create and send a Query message.

execute_goal_code_query(match: str)[source]¶: Execute goal code match query.

execute_protocol_query(match: str)[source]¶: Execute protocol match query.

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.

proactive_disclose_features(connection_id: str)[source]¶: Proactively dislose features on active connection setup.

profile¶

Accessor for the current Profile.

Returns:	The Profile for this manager

receive_disclose(disclose_msg: aries_cloudagent.protocols.discovery.v2_0.messages.disclosures.Disclosures, connection_id: str = None) → aries_cloudagent.protocols.discovery.v2_0.models.discovery_record.V20DiscoveryExchangeRecord[source]¶: Receive Disclose message and return updated V20DiscoveryExchangeRecord.

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.

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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

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

connection_id¶: Used by autodoc_mock_imports.

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

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Query string parameters for feature query.

connection_id¶: Used by autodoc_mock_imports.

query_goal_code¶: Used by autodoc_mock_imports.

query_protocol¶: Used by autodoc_mock_imports.

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

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for Discover Features v2.0 exchange records.

results¶: Used by autodoc_mock_imports.

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

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Result schema for Discover Features v2.0 exchange record.

results¶: Used by autodoc_mock_imports.

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

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

Request handler for creating and sending feature queries.

Parameters:	request – aiohttp request object
Returns:	V20DiscoveryExchangeRecord

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

Request handler for looking up V20DiscoveryExchangeRecord.

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

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