Constructor
Parameters
SDKDependencies
Returns
IMessageSDK
Properties
PluginManager
required
Get plugin manager
Methods
close()
Returns
Promise<void>
getMessages()
Parameters
Returns
MessageQueryResult
getUnreadMessages()
Returns
UnreadMessagesResult
Unread messages with statistics
listChats()
Parameters
number | ListChatsOptions
Type:
ListChatsOptionsFilter and sort options (or a number for backward compatibility)Returns
ChatSummary
Array of chat summaries with unread counts
message()
Parameters
Returns
MessageChain
send()
- A recipient (phone number or email): e.g., ‘+1234567890’, ‘[email protected]’
- A chatId (group or DM): e.g., ‘chat123…’, ‘iMessage;+1234567890’
Parameters
string
required
string | { files: string[]; images: string[]; text: string }
required
Returns
SendResult
sendBatch()
Parameters
{ content: string | { files: string[]; images: string[]; text: string }; to: st…
required
Batch message list
Returns
SendResult
List of send results (including success and failure)
sendFile()
Parameters
string
required
string
required
string
Returns
SendResult
sendFiles()
Parameters
string
required
string[]
required
string
Returns
SendResult
startWatching()
Parameters
Returns
Promise<void>
stopWatching()
use()
Parameters
Returns
this