sendText(chat, text, options)sends text with replies, subjects, effects, rich links, data-detector scanning, and formatting.sendAttachment(chat, attachment, options)sends an uploaded attachment by GUID with replies, effects, and audio-message mode.sendMultipart(chat, parts, options)sends multiple text / attachment / mention bubbles atomically.sendCustomizedMiniApp(chat, message, options)sends a mini app card backed by the caller’s own iMessage extension and returns the session needed for updates.updateCustomizedMiniApp(session, message, options)updates a caller-owned mini app card in place.edit(chat, message, newText, options)edits an existing message.unsend(chat, message, options)retracts an existing message.setReaction(chat, message, reaction, isSet, options)adds or removes a tapback / emoji reaction.placeSticker(chat, message, sticker, placement, options)places an uploaded sticker attachment on a message.notifySilenced(chat, message, options)triggers Apple’s Notify Anyway action for a Focus-silenced conversation.get(message)fetches one message by its guid.listRecent(filter)pages through recent messages across chats.listInChat(chat, filter)pages through messages in one chat.getEmbeddedMedia(chat, message)downloads Digital Touch / handwritten embedded media bytes.subscribeEvents(filter)streams live message changes.
Methods
edit()
Parameters
string
required
string
required
string
required
{ backwardCompatText: string; clientMessageId: string; partIndex: number }
Returns
Message
get()
Parameters
string
required
Returns
Message
getEmbeddedMedia()
Parameters
string
required
string
required
Returns
EmbeddedMediaItem
listInChat()
Parameters
string
required
Returns
MessageListPage
listRecent()
Parameters
Returns
MessageListPage
notifySilenced()
Parameters
string
required
string
required
{ clientMessageId: string }
Returns
Promise<void>
placeSticker()
Parameters
string
required
string
required
string
required
required
{ clientMessageId: string; partIndex: number }
Returns
Message
sendAttachment()
Parameters
string
required
string
required
{ clientMessageId: string; effect: MessageEffect; isAudioMessage: boolean; repl…
Type:
MessageEffectReturns
Message
sendCustomizedMiniApp()
Parameters
string
required
required
Returns
MiniAppMessageResult
sendMultipart()
Parameters
string
required
readonly MessagePart[]
required
Type:
MessagePart{ clientMessageId: string; effect: MessageEffect; enableDataDetection: boolean;…
Type:
MessageEffectReturns
Message
sendText()
Parameters
string
required
string
required
Returns
Message
setReaction()
Parameters
string
required
string
required
required
boolean
required
{ clientMessageId: string; partIndex: number }
Returns
Message
subscribeEvents()
Parameters
{ chat: string }
Returns
TypedEventStreamMessageEvent
unsend()
Parameters
string
required
string
required
{ clientMessageId: string; partIndex: number }
Returns
Promise<void>
updateCustomizedMiniApp()
Parameters
required
required
Returns
MiniAppMessageResult