Documentation
Real-time Messaging
Console Agora.io Community Submit ticket
English
search-icon

Agora RTM Web API Reference

Index AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmEvents RtmErrorCode RtmStatusCode

Interface for setting message sending options.

Hierarchy

  • SendMessageOptions

Index

Properties

Properties

Optional enableHistoricalMessaging

enableHistoricalMessaging: undefined | false | true
deprecated

This method is deprecated. Agora recommends that you do not use it.

Private Beta Save the message to message history.

  • true: Save the message to message history.
  • false: (default) Do not save the message to message history.

Optional enableOfflineMessaging

enableOfflineMessaging: undefined | false | true
deprecated

This method is deprecated. Agora recommends that you do not use it.

Set the message as an offline message (Applies to peer-to-peer message only).

  • true: Set the message as an offline message.
  • false: (default) Do not set the message as an offline message.