@bootdesk/js-web-adapter-react
Preparing search index...
WebChatClient
Class WebChatClient
Index
Constructors
constructor
Methods
add
Event
Listener
add
Reaction
connect
delete
Message
disconnect
edit
Message
get
Conversation
Id
get
Current
User
Id
get
Endpoints
get
Features
get
Http
Client
get
Messages
get
Thread
Id
load
Messages
on
Message
Deleted
on
Message
Edited
on
Message
Posted
on
Reaction
Added
on
Reaction
Removed
on
Streaming
Chunk
on
Typing
Started
reconfigure
remove
Reaction
send
Action
send
Message
set
Locale
Header
Constructors
constructor
new
WebChatClient
(
config
:
WebChatClientConfig
)
:
WebChatClient
Parameters
config
:
WebChatClientConfig
Returns
WebChatClient
Methods
add
Event
Listener
addEventListener
<
T
=
unknown
>
(
eventType
:
string
,
handler
:
(
event
:
T
)
=>
void
,
)
:
Unsubscribe
Type Parameters
T
=
unknown
Parameters
eventType
:
string
handler
:
(
event
:
T
)
=>
void
Returns
Unsubscribe
add
Reaction
addReaction
(
messageId
:
string
,
emoji
:
string
)
:
Promise
<
void
>
Parameters
messageId
:
string
emoji
:
string
Returns
Promise
<
void
>
connect
connect
()
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
Message
deleteMessage
(
messageId
:
string
)
:
Promise
<
void
>
Parameters
messageId
:
string
Returns
Promise
<
void
>
disconnect
disconnect
()
:
void
Returns
void
edit
Message
editMessage
(
messageId
:
string
,
newText
:
string
)
:
Promise
<
void
>
Parameters
messageId
:
string
newText
:
string
Returns
Promise
<
void
>
get
Conversation
Id
getConversationId
()
:
string
Returns
string
get
Current
User
Id
getCurrentUserId
()
:
string
Returns
string
get
Endpoints
getEndpoints
()
:
{
addReaction
?:
string
;
deleteMessage
?:
string
;
editMessage
?:
string
;
loadMessages
?:
string
;
removeReaction
?:
string
;
sendMessage
?:
string
;
}
Returns
{
addReaction
?:
string
;
deleteMessage
?:
string
;
editMessage
?:
string
;
loadMessages
?:
string
;
removeReaction
?:
string
;
sendMessage
?:
string
;
}
get
Features
getFeatures
()
:
{
deleteMessages
?:
boolean
;
editMessages
?:
boolean
;
reactions
?:
boolean
;
}
Returns
{
deleteMessages
?:
boolean
;
editMessages
?:
boolean
;
reactions
?:
boolean
}
get
Http
Client
getHttpClient
()
:
HttpClient
Returns
HttpClient
get
Messages
getMessages
()
:
Message
[]
Returns
Message
[]
get
Thread
Id
getThreadId
()
:
string
Returns
string
load
Messages
loadMessages
(
options
?:
LoadMessagesOptions
,
signal
?:
AbortSignal
,
)
:
Promise
<
LoadMessagesResult
>
Parameters
Optional
options
:
LoadMessagesOptions
Optional
signal
:
AbortSignal
Returns
Promise
<
LoadMessagesResult
>
on
Message
Deleted
onMessageDeleted
(
handler
:
(
event
:
MessageDeletedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
MessageDeletedEvent
)
=>
void
Returns
Unsubscribe
on
Message
Edited
onMessageEdited
(
handler
:
(
event
:
MessageEditedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
MessageEditedEvent
)
=>
void
Returns
Unsubscribe
on
Message
Posted
onMessagePosted
(
handler
:
(
event
:
MessagePostedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
MessagePostedEvent
)
=>
void
Returns
Unsubscribe
on
Reaction
Added
onReactionAdded
(
handler
:
(
event
:
ReactionAddedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
ReactionAddedEvent
)
=>
void
Returns
Unsubscribe
on
Reaction
Removed
onReactionRemoved
(
handler
:
(
event
:
ReactionRemovedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
ReactionRemovedEvent
)
=>
void
Returns
Unsubscribe
on
Streaming
Chunk
onStreamingChunk
(
handler
:
(
event
:
StreamingChunkEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
StreamingChunkEvent
)
=>
void
Returns
Unsubscribe
on
Typing
Started
onTypingStarted
(
handler
:
(
event
:
TypingStartedEvent
)
=>
void
)
:
Unsubscribe
Parameters
handler
:
(
event
:
TypingStartedEvent
)
=>
void
Returns
Unsubscribe
reconfigure
reconfigure
(
config
:
ReconfigureConfig
)
:
void
Parameters
config
:
ReconfigureConfig
Returns
void
remove
Reaction
removeReaction
(
messageId
:
string
,
emoji
:
string
)
:
Promise
<
void
>
Parameters
messageId
:
string
emoji
:
string
Returns
Promise
<
void
>
send
Action
sendAction
(
messageId
:
string
,
actionId
:
string
,
value
:
string
)
:
Promise
<
void
>
Parameters
messageId
:
string
actionId
:
string
value
:
string
Returns
Promise
<
void
>
send
Message
sendMessage
(
text
:
string
,
attachments
?:
AttachmentInput
[]
)
:
Promise
<
void
>
Parameters
text
:
string
Optional
attachments
:
AttachmentInput
[]
Returns
Promise
<
void
>
set
Locale
Header
setLocaleHeader
(
locale
:
string
)
:
void
Parameters
locale
:
string
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
add
Event
Listener
add
Reaction
connect
delete
Message
disconnect
edit
Message
get
Conversation
Id
get
Current
User
Id
get
Endpoints
get
Features
get
Http
Client
get
Messages
get
Thread
Id
load
Messages
on
Message
Deleted
on
Message
Edited
on
Message
Posted
on
Reaction
Added
on
Reaction
Removed
on
Streaming
Chunk
on
Typing
Started
reconfigure
remove
Reaction
send
Action
send
Message
set
Locale
Header
@bootdesk/js-web-adapter-react
Loading...