Documentation
Preparing search index...
@kehto/services
DmAdapter
Interface DmAdapter
DM adapter contract consumed by createDmService.
interface
DmAdapter
{
close
?
()
:
void
;
conversations
(
query
?:
DmConversationQuery
,
)
:
DmConversationPage
|
Promise
<
DmConversationPage
>
;
messages
(
query
:
DmMessageQuery
)
:
DmMessagePage
|
Promise
<
DmMessagePage
>
;
send
(
request
:
DmSendRequest
)
:
Promise
<
DmSendResult
>
;
status
()
:
DmStatus
|
Promise
<
DmStatus
>
;
subscribe
(
request
:
DmSubscribeRequest
,
onMessage
:
(
message
:
DmMessage
)
=>
void
,
)
:
DmSubscription
|
Promise
<
DmSubscription
>
;
unsubscribe
(
subscriptionId
:
string
)
:
DmOk
|
Promise
<
DmOk
>
;
}
Index
Methods
close?
conversations
messages
send
status
subscribe
unsubscribe
Methods
Optional
close
close
?
()
:
void
Returns
void
conversations
conversations
(
query
?:
DmConversationQuery
,
)
:
DmConversationPage
|
Promise
<
DmConversationPage
>
Parameters
Optional
query
:
DmConversationQuery
Returns
DmConversationPage
|
Promise
<
DmConversationPage
>
messages
messages
(
query
:
DmMessageQuery
)
:
DmMessagePage
|
Promise
<
DmMessagePage
>
Parameters
query
:
DmMessageQuery
Returns
DmMessagePage
|
Promise
<
DmMessagePage
>
send
send
(
request
:
DmSendRequest
)
:
Promise
<
DmSendResult
>
Parameters
request
:
DmSendRequest
Returns
Promise
<
DmSendResult
>
status
status
()
:
DmStatus
|
Promise
<
DmStatus
>
Returns
DmStatus
|
Promise
<
DmStatus
>
subscribe
subscribe
(
request
:
DmSubscribeRequest
,
onMessage
:
(
message
:
DmMessage
)
=>
void
,
)
:
DmSubscription
|
Promise
<
DmSubscription
>
Parameters
request
:
DmSubscribeRequest
onMessage
:
(
message
:
DmMessage
)
=>
void
Returns
DmSubscription
|
Promise
<
DmSubscription
>
unsubscribe
unsubscribe
(
subscriptionId
:
string
)
:
DmOk
|
Promise
<
DmOk
>
Parameters
subscriptionId
:
string
Returns
DmOk
|
Promise
<
DmOk
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
close
conversations
messages
send
status
subscribe
unsubscribe
Documentation
Loading...
DM adapter contract consumed by createDmService.