Search
Preparing search index...
The search index is not available
Agora Chat SDK API Reference
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Agora Chat SDK API Reference
TYPES
Message
VideoMsgBody
Interface VideoMsgBody
Hierarchy
VideoMsgSetParameters
VideoMsgBody
Index
Properties
access
Token
api
Url
body
chat
Thread
chat
Thread
Overview
chat
Type
ext
file
file
Input
Id
file_
length
filename
filetype
from
group
id
length
msg
Config
online
State
reactions
room
Type
secret
time
to
type
url
Methods
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
Properties
Optional
access
Token
access
Token
?:
string
Optional
api
Url
api
Url
?:
string
Optional
body
body
?:
{
filename
:
string
;
type
:
string
;
url
:
string
}
Type declaration
filename
:
string
type
:
string
url
:
string
Optional
chat
Thread
chat
Thread
?:
ChatThread
Optional
chat
Thread
Overview
chat
Thread
Overview
?:
ChatThreadOverview
chat
Type
chat
Type
:
ChatType
Optional
ext
ext
?:
{}
Type declaration
[
key:
string
]:
any
file
file
:
object
Optional
file
Input
Id
file
Input
Id
?:
string
file_
length
file_
length
:
number
filename
filename
:
string
Optional
filetype
filetype
?:
string
Optional
from
from
?:
string
Optional
group
group
?:
string
id
id
:
string
length
length
:
number
Optional
msg
Config
msg
Config
?:
{}
Type declaration
[
key:
string
]:
any
Optional
online
State
online
State
?:
ONLINESTATETYPE
Optional
reactions
reactions
?:
Reaction
Optional
room
Type
room
Type
?:
boolean
Optional
secret
secret
?:
string
time
time
:
number
to
to
:
string
type
type
:
"video"
Optional
url
url
?:
string
Methods
Optional
fail
fail
(
)
:
any
Returns
any
Optional
on
File
Upload
Complete
on
File
Upload
Complete
(
data
:
any
)
:
any
Parameters
data:
any
Returns
any
Optional
on
File
Upload
Error
on
File
Upload
Error
(
err
:
any
)
:
any
Parameters
err:
any
Returns
any
Optional
on
File
Upload
Progress
on
File
Upload
Progress
(
data
:
ProgressEvent
<
EventTarget
>
)
:
any
Parameters
data:
ProgressEvent
<
EventTarget
>
Returns
any
Optional
success
success
(
)
:
any
Returns
any
Modules
CHATROOM APIS
CHATSDK
CONNECTION
CONTACT APIS
EVENTHANDLER
GROUP APIS
MESSAGE
PRESENCE APIS
SLIENTMODE APIS
THREAD APIS
TRANSLATION APIS
TYPES
Chat
Room
Type
Common
Connection
Contact
Type
Error
Evevt
Handler
Type
Group
Type
Message
Utils
message/audio
message/channel
message/cmd
message/custom
message/delivery
message/file
message/img
message/location
message/read
message/text
message/video
Video
Msg
Body
access
Token
api
Url
body
chat
Thread
chat
Thread
Overview
chat
Type
ext
file
file
Input
Id
file_
length
filename
filetype
from
group
id
length
msg
Config
online
State
reactions
room
Type
secret
time
to
type
url
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
Generated using
TypeDoc