Skip to main content

Constructor

Parameters

Returns

AdvancedIMessageKit

Properties

AttachmentModule
required
ChatModule
required
required
ContactModule
required
FaceTimeModule
required
HandleModule
required
AxiosInstance
required
ICloudModule
required
Logger
required
MessageModule
required
PollModule
required
ScheduledMessageModule
required
ServerModule
required
Socket<DefaultEventsMap>
required

Methods

addListener()

Parameters

K
required
PhotonEventMap[K] extends undefined ? () => void : (data: PhotonEventMap[K]) =>…
required

Returns

this

clearProcessedMessages()

Clear processed message records (prevent memory leaks)

Parameters

number
Maximum number of messages to retain, default 1000

close()

Returns

Promise<void>

connect()

Returns

Promise<void>

emit()

Parameters

K
required
PhotonEventMap[K] extends undefined ? [] : [PhotonEventMap[K]]
required

Returns

boolean

enqueueSend()

Enqueue a send operation to ensure sequential delivery. All send operations (messages, attachments, stickers) should use this method to guarantee order for a single user.

Parameters

() => Promise<T>
required
The async send operation to enqueue

Returns

Promise<T> Promise that resolves with the task result

getInstance()

Parameters

Returns

AdvancedIMessageKit

getProcessedMessageCount()

Get the count of processed messages

Returns

number

off()

Parameters

K
required
PhotonEventMap[K] extends undefined ? () => void : (data: PhotonEventMap[K]) =>…
required

Returns

this

on()

Parameters

K
required
PhotonEventMap[K] extends undefined ? () => void : (data: PhotonEventMap[K]) =>…
required

Returns

this

once()

Parameters

K
required
PhotonEventMap[K] extends undefined ? () => void : (data: PhotonEventMap[K]) =>…
required

Returns

this

removeListener()

Parameters

K
required
PhotonEventMap[K] extends undefined ? () => void : (data: PhotonEventMap[K]) =>…
required

Returns

this