Class DidExchangeApi

Hierarchy

BaseAPI
- DidExchangeApi

Index

Constructors

Properties

Methods

didexchangeConnIdAcceptInvitationPost didexchangeConnIdAcceptInvitationPostRaw didexchangeConnIdAcceptRequestPost didexchangeConnIdAcceptRequestPostRaw didexchangeConnIdRejectPost didexchangeConnIdRejectPostRaw didexchangeCreateRequestPost didexchangeCreateRequestPostRaw didexchangeReceiveRequestPost didexchangeReceiveRequestPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new DidExchangeApi(configuration?): DidExchangeApi
Parameters
- configuration: Configuration = ...
Returns DidExchangeApi
Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

didexchangeConnIdAcceptInvitationPost

didexchangeConnIdAcceptInvitationPost(requestParameters): Promise<ConnRecord>
Accept a stored connection invitation
Parameters
- requestParameters: DidexchangeConnIdAcceptInvitationPostRequest
Returns Promise<ConnRecord>
- Defined in client/apis/DidExchangeApi.ts:127

didexchangeConnIdAcceptInvitationPostRaw

didexchangeConnIdAcceptInvitationPostRaw(requestParameters): Promise<ApiResponse<ConnRecord>>
Accept a stored connection invitation
Parameters
- requestParameters: DidexchangeConnIdAcceptInvitationPostRequest
Returns Promise<ApiResponse<ConnRecord>>
- Defined in client/apis/DidExchangeApi.ts:76

didexchangeConnIdAcceptRequestPost

didexchangeConnIdAcceptRequestPost(requestParameters): Promise<ConnRecord>
Accept a stored connection request
Parameters
- requestParameters: DidexchangeConnIdAcceptRequestPostRequest
Returns Promise<ConnRecord>
- Defined in client/apis/DidExchangeApi.ts:185

didexchangeConnIdAcceptRequestPostRaw

didexchangeConnIdAcceptRequestPostRaw(requestParameters): Promise<ApiResponse<ConnRecord>>
Accept a stored connection request
Parameters
- requestParameters: DidexchangeConnIdAcceptRequestPostRequest
Returns Promise<ApiResponse<ConnRecord>>
- Defined in client/apis/DidExchangeApi.ts:138

didexchangeConnIdRejectPost

didexchangeConnIdRejectPost(requestParameters): Promise<ConnRecord>
Abandon or reject a DID Exchange
Parameters
- requestParameters: DidexchangeConnIdRejectPostRequest
Returns Promise<ConnRecord>
- Defined in client/apis/DidExchangeApi.ts:234

didexchangeConnIdRejectPostRaw

didexchangeConnIdRejectPostRaw(requestParameters): Promise<ApiResponse<ConnRecord>>
Abandon or reject a DID Exchange
Parameters
- requestParameters: DidexchangeConnIdRejectPostRequest
Returns Promise<ApiResponse<ConnRecord>>
- Defined in client/apis/DidExchangeApi.ts:196

didexchangeCreateRequestPost

didexchangeCreateRequestPost(requestParameters): Promise<ConnRecord>
Create and send a request against public DID's implicit invitation
Parameters
- requestParameters: DidexchangeCreateRequestPostRequest
Returns Promise<ConnRecord>
- Defined in client/apis/DidExchangeApi.ts:325

didexchangeCreateRequestPostRaw

didexchangeCreateRequestPostRaw(requestParameters): Promise<ApiResponse<ConnRecord>>
Create and send a request against public DID's implicit invitation
Parameters
- requestParameters: DidexchangeCreateRequestPostRequest
Returns Promise<ApiResponse<ConnRecord>>
- Defined in client/apis/DidExchangeApi.ts:245

didexchangeReceiveRequestPost

didexchangeReceiveRequestPost(requestParameters): Promise<ConnRecord>
Receive request against public DID's implicit invitation
Parameters
- requestParameters: DidexchangeReceiveRequestPostRequest
Returns Promise<ConnRecord>
- Defined in client/apis/DidExchangeApi.ts:377

didexchangeReceiveRequestPostRaw

didexchangeReceiveRequestPostRaw(requestParameters): Promise<ApiResponse<ConnRecord>>
Receive request against public DID's implicit invitation
Parameters
- requestParameters: DidexchangeReceiveRequestPostRequest
Returns Promise<ApiResponse<ConnRecord>>
- Defined in client/apis/DidExchangeApi.ts:336

`Protected` request

request(context): Promise<Response>
Parameters
- context: RequestOpts
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in client/runtime.ts:50

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34

Generated using TypeDoc