Search
Preparing search index...
The search index is not available
Agora Chat SDK API Reference - v1.3.1
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Agora Chat SDK API Reference - v1.3.1
Types
Message
ImgMsgBody
Interface ImgMsgBody
Hierarchy
Message
.
ImgMsgSetParameters
ImgMsgBody
Index
Properties
body
broadcast
chat
Thread
chat
Thread
Overview
chat
Type
deliver
Online
Only
ext
file
file
Input
Id
file_
length
from
group
height
id
is
Content
Replaced
msg
Config
online
State
priority
reactions
room
Type
secret
thumb
thumb_
secret
time
to
type
url
width
Methods
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
upload
Complete
upload
Error
Properties
Optional
body
body
?:
{
filename
:
string
;
type
:
string
;
url
:
string
}
Type declaration
filename
:
string
type
:
string
url
:
string
Optional
broadcast
broadcast
?:
boolean
Optional
chat
Thread
chat
Thread
?:
ChatThread
Optional
chat
Thread
Overview
chat
Thread
Overview
?:
ChatThreadOverview
chat
Type
chat
Type
:
ChatType
Optional
deliver
Online
Only
deliver
Online
Only
?:
boolean
Optional
ext
ext
?:
{}
Type declaration
[
key:
string
]:
any
Optional
file
file
?:
FileObj
Optional
file
Input
Id
file
Input
Id
?:
string
Optional
file_
length
file_
length
?:
number
Optional
from
from
?:
string
Optional
group
group
?:
string
Optional
height
height
?:
number
id
id
:
string
Optional
is
Content
Replaced
is
Content
Replaced
?:
boolean
Optional
msg
Config
msg
Config
?:
{}
Type declaration
[
key:
string
]:
any
Optional
online
State
online
State
?:
ONLINESTATETYPE
Optional
priority
priority
?:
MessagePriority
Optional
reactions
reactions
?:
Reaction
[]
Optional
room
Type
room
Type
?:
boolean
Optional
secret
secret
?:
string
Optional
thumb
thumb
?:
string
Optional
thumb_
secret
thumb_
secret
?:
string
time
time
:
number
to
to
:
string
type
type
:
"img"
Optional
url
url
?:
string
Optional
width
width
?:
number
Methods
Optional
fail
fail
(
)
:
void
Returns
void
Optional
on
File
Upload
Complete
on
File
Upload
Complete
(
data
:
any
)
:
void
Parameters
data:
any
Returns
void
Optional
on
File
Upload
Error
on
File
Upload
Error
(
error
:
any
)
:
void
Parameters
error:
any
Returns
void
Optional
on
File
Upload
Progress
on
File
Upload
Progress
(
data
:
any
)
:
void
Parameters
data:
any
Returns
void
Optional
success
success
(
data
:
Connection
.
SendMsgResult
)
:
void
Parameters
data:
Connection
.
SendMsgResult
Returns
void
Optional
upload
Complete
upload
Complete
(
)
:
void
Returns
void
Optional
upload
Error
upload
Error
(
)
:
void
Returns
void
Modules
ChatSDK
Chatroom
Connection
Contact
Event
Handler
Group
Local
Cache
Logger
Message
Presence
Silent
Mode
Status
Code
Thread
Translation
Types
Chat
Room
Type
Common
Connection
Contact
Type
Error
Event
Handler
Type
Group
Type
Local
Cache
Type
Message
Presence
Type
Reaction
Type
Silent
Mode
Type
Thread
Type
Translation
Type
Utils
message/audio
message/channel
message/cmd
message/combine
message/custom
message/delivery
message/file
message/img
message/location
message/read
message/text
message/video
Img
Msg
Body
body
broadcast
chat
Thread
chat
Thread
Overview
chat
Type
deliver
Online
Only
ext
file
file
Input
Id
file_
length
from
group
height
id
is
Content
Replaced
msg
Config
online
State
priority
reactions
room
Type
secret
thumb
thumb_
secret
time
to
type
url
width
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
upload
Complete
upload
Error
Generated using
TypeDoc