Class OutOfBandApi

Hierarchy

BaseAPI
- OutOfBandApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new OutOfBandApi(configuration?: Configuration): OutOfBandApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

outOfBandCreateInvitationPost

outOfBandCreateInvitationPost(requestParameters: OutOfBandCreateInvitationPostRequest): Promise<InvitationRecord>

- Defined in client/apis/OutOfBandApi.ts:83
Create a new connection invitation

Parameters
- requestParameters: OutOfBandCreateInvitationPostRequest
Returns Promise<InvitationRecord>

outOfBandCreateInvitationPostRaw

outOfBandCreateInvitationPostRaw(requestParameters: OutOfBandCreateInvitationPostRequest): Promise<ApiResponse<InvitationRecord>>

- Defined in client/apis/OutOfBandApi.ts:50
Create a new connection invitation

Parameters
- requestParameters: OutOfBandCreateInvitationPostRequest
Returns Promise<ApiResponse<InvitationRecord>>

outOfBandReceiveInvitationPost

outOfBandReceiveInvitationPost(requestParameters: OutOfBandReceiveInvitationPostRequest): Promise<ConnRecord>

- Defined in client/apis/OutOfBandApi.ts:137
Receive a new connection invitation

Parameters
- requestParameters: OutOfBandReceiveInvitationPostRequest
Returns Promise<ConnRecord>

outOfBandReceiveInvitationPostRaw

outOfBandReceiveInvitationPostRaw(requestParameters: OutOfBandReceiveInvitationPostRequest): Promise<ApiResponse<ConnRecord>>

- Defined in client/apis/OutOfBandApi.ts:95
Receive a new connection invitation

Parameters
- requestParameters: OutOfBandReceiveInvitationPostRequest
Returns Promise<ApiResponse<ConnRecord>>

Protected request

request(context: RequestOpts): Promise<Response>

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

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

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

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

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

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

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

Generated using TypeDoc