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
BasicmessageApi
Class BasicmessageApi
Hierarchy
BaseAPI
BasicmessageApi
Index
Constructors
constructor
Properties
configuration
Methods
connections
Conn
Id
Send
Message
Post
connections
Conn
Id
Send
Message
Post
Raw
request
with
Middleware
with
Post
Middleware
with
Pre
Middleware
Constructors
constructor
new
Basicmessage
Api
(
configuration
?:
Configuration
)
:
BasicmessageApi
Parameters
configuration:
Configuration
= ...
Returns
BasicmessageApi
Properties
Protected
configuration
configuration
:
Configuration
= ...
Methods
connections
Conn
Id
Send
Message
Post
connections
Conn
Id
Send
Message
Post
(
requestParameters
:
ConnectionsConnIdSendMessagePostRequest
)
:
Promise
<
object
>
Send a basic message to a connection
Parameters
requestParameters:
ConnectionsConnIdSendMessagePostRequest
Returns
Promise
<
object
>
connections
Conn
Id
Send
Message
Post
Raw
connections
Conn
Id
Send
Message
Post
Raw
(
requestParameters
:
ConnectionsConnIdSendMessagePostRequest
)
:
Promise
<
ApiResponse
<
object
>
>
Send a basic message to a connection
Parameters
requestParameters:
ConnectionsConnIdSendMessagePostRequest
Returns
Promise
<
ApiResponse
<
object
>
>
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
Basicmessage
Api
constructor
configuration
connections
Conn
Id
Send
Message
Post
connections
Conn
Id
Send
Message
Post
Raw
request
with
Middleware
with
Post
Middleware
with
Pre
Middleware
Generated using
TypeDoc
Send a basic message to a connection