Documentation
Chat (BETA)
Console 官网 Community Technical support
English
search-icon

Agora Chat Web API Reference

Overview ChatSDK Chatroom Connection Contact EventHandler Group Logger Message Presence SilentMode StatusCode Thread Translation Types

Hierarchy

Index

Properties

Methods

Properties

Optional accessToken

accessToken?: string

Optional apiUrl

apiUrl?: string

Optional body

body?: { filename: string; type: string; url: string }

Type declaration

  • filename: string
  • type: string
  • url: string

Optional chatThread

chatThread?: ChatThread

Optional chatThreadOverview

chatThreadOverview?: ChatThreadOverview

chatType

chatType: ChatType

Optional ext

ext?: {}

Type declaration

  • [key: string]: any

file

file: object

Optional fileInputId

fileInputId?: 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 msgConfig

msgConfig?: {}

Type declaration

  • [key: string]: any

Optional onlineState

onlineState?: ONLINESTATETYPE

Optional reactions

reactions?: Reaction

Optional roomType

roomType?: boolean

Optional secret

secret?: string

time

time: number

to

to: string

type

type: "video"

Optional url

url?: string

Methods

Optional fail

  • fail(): void

Optional onFileUploadComplete

  • onFileUploadComplete(data: any): void

Optional onFileUploadError

  • onFileUploadError(err: any): void

Optional onFileUploadProgress

  • onFileUploadProgress(data: ProgressEvent<EventTarget>): void

Optional success

  • success(): void