Class OutOfBandApi

Hierarchy

BaseAPI
- OutOfBandApi

Index

Constructors

Properties

Methods

outOfBandCreateInvitationPost outOfBandCreateInvitationPostRaw outOfBandInvitationsGet outOfBandInvitationsGetRaw outOfBandInvitationsInviMsgIdDelete outOfBandInvitationsInviMsgIdDeleteRaw outOfBandReceiveInvitationPost outOfBandReceiveInvitationPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

outOfBandCreateInvitationPost

outOfBandCreateInvitationPost(requestParameters): Promise<InvitationRecord>
Create a new connection invitation
Parameters
- requestParameters: OutOfBandCreateInvitationPostRequest
Returns Promise<InvitationRecord>
- Defined in client/apis/OutOfBandApi.ts:96

outOfBandCreateInvitationPostRaw

outOfBandCreateInvitationPostRaw(requestParameters): Promise<ApiResponse<InvitationRecord>>
Create a new connection invitation
Parameters
- requestParameters: OutOfBandCreateInvitationPostRequest
Returns Promise<ApiResponse<InvitationRecord>>
- Defined in client/apis/OutOfBandApi.ts:59

outOfBandInvitationsGet

outOfBandInvitationsGet(requestParameters): Promise<object>
Fetch an existing Out-of-Band invitation.
Parameters
- requestParameters: OutOfBandInvitationsGetRequest
Returns Promise<object>
- Defined in client/apis/OutOfBandApi.ts:141

outOfBandInvitationsGetRaw

outOfBandInvitationsGetRaw(requestParameters): Promise<ApiResponse<object>>
Fetch an existing Out-of-Band invitation.
Parameters
- requestParameters: OutOfBandInvitationsGetRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/OutOfBandApi.ts:107

outOfBandInvitationsInviMsgIdDelete

outOfBandInvitationsInviMsgIdDelete(requestParameters): Promise<object>
Delete records associated with invitation
Parameters
- requestParameters: OutOfBandInvitationsInviMsgIdDeleteRequest
Returns Promise<object>
- Defined in client/apis/OutOfBandApi.ts:184

outOfBandInvitationsInviMsgIdDeleteRaw

outOfBandInvitationsInviMsgIdDeleteRaw(requestParameters): Promise<ApiResponse<object>>
Delete records associated with invitation
Parameters
- requestParameters: OutOfBandInvitationsInviMsgIdDeleteRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/OutOfBandApi.ts:151

outOfBandReceiveInvitationPost

outOfBandReceiveInvitationPost(requestParameters): Promise<OobRecord>
Receive a new connection invitation
Parameters
- requestParameters: OutOfBandReceiveInvitationPostRequest
Returns Promise<OobRecord>
- Defined in client/apis/OutOfBandApi.ts:237

outOfBandReceiveInvitationPostRaw

outOfBandReceiveInvitationPostRaw(requestParameters): Promise<ApiResponse<OobRecord>>
Receive a new connection invitation
Parameters
- requestParameters: OutOfBandReceiveInvitationPostRequest
Returns Promise<ApiResponse<OobRecord>>
- Defined in client/apis/OutOfBandApi.ts:195

`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