Search
Preparing search index...
The search index is not available
@sudoplatform-labs/sudo-di-cloud-agent
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@sudoplatform-labs/sudo-di-cloud-agent
OutOfBandApi
Class OutOfBandApi
Hierarchy
BaseAPI
OutOfBandApi
Index
Constructors
constructor
Properties
configuration
Methods
out
Of
Band
Create
Invitation
Post
out
Of
Band
Create
Invitation
Post
Raw
out
Of
Band
Receive
Invitation
Post
out
Of
Band
Receive
Invitation
Post
Raw
request
with
Middleware
with
Post
Middleware
with
Pre
Middleware
Constructors
constructor
new
Out
Of
Band
Api
(
configuration
?:
Configuration
)
:
OutOfBandApi
Parameters
configuration:
Configuration
= ...
Returns
OutOfBandApi
Properties
Protected
configuration
configuration
:
Configuration
= ...
Methods
out
Of
Band
Create
Invitation
Post
out
Of
Band
Create
Invitation
Post
(
requestParameters
:
OutOfBandCreateInvitationPostRequest
)
:
Promise
<
InvitationRecord
>
Create a new connection invitation
Parameters
requestParameters:
OutOfBandCreateInvitationPostRequest
Returns
Promise
<
InvitationRecord
>
out
Of
Band
Create
Invitation
Post
Raw
out
Of
Band
Create
Invitation
Post
Raw
(
requestParameters
:
OutOfBandCreateInvitationPostRequest
)
:
Promise
<
ApiResponse
<
InvitationRecord
>
>
Create a new connection invitation
Parameters
requestParameters:
OutOfBandCreateInvitationPostRequest
Returns
Promise
<
ApiResponse
<
InvitationRecord
>
>
out
Of
Band
Receive
Invitation
Post
out
Of
Band
Receive
Invitation
Post
(
requestParameters
:
OutOfBandReceiveInvitationPostRequest
)
:
Promise
<
ConnRecord
>
Receive a new connection invitation
Parameters
requestParameters:
OutOfBandReceiveInvitationPostRequest
Returns
Promise
<
ConnRecord
>
out
Of
Band
Receive
Invitation
Post
Raw
out
Of
Band
Receive
Invitation
Post
Raw
(
requestParameters
:
OutOfBandReceiveInvitationPostRequest
)
:
Promise
<
ApiResponse
<
ConnRecord
>
>
Receive a new connection invitation
Parameters
requestParameters:
OutOfBandReceiveInvitationPostRequest
Returns
Promise
<
ApiResponse
<
ConnRecord
>
>
Protected
request
request
(
context
:
RequestOpts
)
:
Promise
<
Response
>
Parameters
context:
RequestOpts
Returns
Promise
<
Response
>
with
Middleware
with
Middleware
<
T
>
(
...
middlewares
:
Middleware
[]
)
:
T
Type parameters
T
:
BaseAPI
<
T
>
Parameters
Rest
...
middlewares:
Middleware
[]
Returns
T
with
Post
Middleware
with
Post
Middleware
<
T
>
(
...
postMiddlewares
:
(
undefined
|
(
(
context
:
ResponseContext
)
=>
Promise
<
void
|
Response
>
)
)
[]
)
:
T
Type parameters
T
:
BaseAPI
<
T
>
Parameters
Rest
...
postMiddlewares:
(
undefined
|
(
(
context
:
ResponseContext
)
=>
Promise
<
void
|
Response
>
)
)
[]
Returns
T
with
Pre
Middleware
with
Pre
Middleware
<
T
>
(
...
preMiddlewares
:
(
undefined
|
(
(
context
:
RequestContext
)
=>
Promise
<
void
|
FetchParams
>
)
)
[]
)
:
T
Type parameters
T
:
BaseAPI
<
T
>
Parameters
Rest
...
preMiddlewares:
(
undefined
|
(
(
context
:
RequestContext
)
=>
Promise
<
void
|
FetchParams
>
)
)
[]
Returns
T
Exports
Out
Of
Band
Api
constructor
configuration
out
Of
Band
Create
Invitation
Post
out
Of
Band
Create
Invitation
Post
Raw
out
Of
Band
Receive
Invitation
Post
out
Of
Band
Receive
Invitation
Post
Raw
request
with
Middleware
with
Post
Middleware
with
Pre
Middleware
Generated using
TypeDoc
Create a new connection invitation