Documentation
Preparing search index...
@kehto/services
CordnDmClient
Interface CordnDmClient
Cordn DM client contract.
interface
CordnDmClient
{
close
?
()
:
void
;
conversations
(
query
?:
DmConversationQuery
,
)
:
DmConversationPage
|
Promise
<
DmConversationPage
>
;
messages
(
query
:
DmMessageQuery
)
:
DmMessagePage
|
Promise
<
DmMessagePage
>
;
send
(
request
:
DmSendRequest
)
:
Promise
<
DmSendResult
>
;
status
?
()
:
Partial
<
DmStatus
>
|
Promise
<
Partial
<
DmStatus
>
>
;
subscribe
(
request
:
DmSubscribeRequest
,
onMessage
:
(
message
:
DmMessage
)
=>
void
,
)
:
DmSubscription
|
Promise
<
DmSubscription
>
;
unsubscribe
(
subscriptionId
:
string
,
)
:
Promise
<
{
ok
:
boolean
}
>
|
{
ok
:
boolean
}
;
}
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
>
Optional
status
status
?
()
:
Partial
<
DmStatus
>
|
Promise
<
Partial
<
DmStatus
>
>
Returns
Partial
<
DmStatus
>
|
Promise
<
Partial
<
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
)
:
Promise
<
{
ok
:
boolean
}
>
|
{
ok
:
boolean
}
Parameters
subscriptionId
:
string
Returns
Promise
<
{
ok
:
boolean
}
>
|
{
ok
:
boolean
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
close
conversations
messages
send
status
subscribe
unsubscribe
Documentation
Loading...
Cordn DM client contract.