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
VideoMsgSetParameters
Interface VideoMsgSetParameters
Hierarchy
VideoMsgSetParameters
VideoMsgBody
Index
Properties
api
Url
body
chat
Type
ext
file
file
Input
Id
file_
length
filename
from
length
room
Type
to
Methods
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
Properties
Optional
api
Url
api
Url
?:
string
Optional
body
body
?:
{
filename
:
string
;
type
:
string
;
url
:
string
}
Type declaration
filename
:
string
type
:
string
url
:
string
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
from
from
?:
string
length
length
:
number
Optional
room
Type
room
Type
?:
boolean
to
to
:
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
Set
Parameters
api
Url
body
chat
Type
ext
file
file
Input
Id
file_
length
filename
from
length
room
Type
to
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
Generated using
TypeDoc