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
ImgMsgSetParameters
Interface ImgMsgSetParameters
Hierarchy
ImgMsgSetParameters
ImgMsgBody
Index
Properties
body
chat
Type
ext
file
file
Input
Id
from
group
height
msg
Config
room
Type
to
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
chat
Type
chat
Type
:
ChatType
Optional
ext
ext
?:
{}
Type declaration
[
key:
string
]:
any
file
file
:
object
Optional
file
Input
Id
file
Input
Id
?:
string
Optional
from
from
?:
string
Optional
group
group
?:
string
Optional
height
height
?:
number
Optional
msg
Config
msg
Config
?:
{}
Type declaration
[
key:
string
]:
any
Optional
room
Type
room
Type
?:
boolean
to
to
:
string
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
(
)
:
void
Returns
void
Optional
upload
Complete
upload
Complete
(
)
:
void
Returns
void
Optional
upload
Error
upload
Error
(
)
:
void
Returns
void
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
Img
Msg
Set
Parameters
body
chat
Type
ext
file
file
Input
Id
from
group
height
msg
Config
room
Type
to
url
width
fail
on
File
Upload
Complete
on
File
Upload
Error
on
File
Upload
Progress
success
upload
Complete
upload
Error
Generated using
TypeDoc