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 apiUrl

apiUrl?: string

Optional body

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

Type declaration

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

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 from

from?: string

length

length: number

Optional roomType

roomType?: boolean

to

to: string

Methods

Optional fail

  • fail(): void

  • Returns void

Optional onFileUploadComplete

  • onFileUploadComplete(data: any): void

  • Parameters

    • data: any

    Returns void

Optional onFileUploadError

  • onFileUploadError(err: any): void

  • Parameters

    • err: any

    Returns void

Optional onFileUploadProgress

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

  • Parameters

    • data: ProgressEvent<EventTarget>

    Returns void

Optional success

  • success(): void

  • Returns void