Class PublishOptions

Brief

Publish message option

Hierarchy

PublishOptions

Index

Constructors

constructor

Properties

channelType? customType? messageType? storeInHistory?

Constructors

constructor

new PublishOptions(props?): PublishOptions
Parameters
- Optional props: Partial<{
      channelType?: RtmChannelType;
      customType?: string;
      messageType?: RtmMessageType;
      storeInHistory?: boolean;
  }>
Returns PublishOptions
- Defined in legacy/AgoraRtmBase.ts:1421

Properties

`Optional` channelType

channelType?: RtmChannelType = RtmChannelType.message

The channel type.

`Optional` customType

customType?: string

The custom type of the message, up to 32 bytes for customize

`Optional` messageType

messageType?: RtmMessageType = RtmMessageType.binary

The message type.

`Optional` storeInHistory

storeInHistory?: boolean = false

Whether to store in history, true to enable

Class PublishOptions

Brief

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

`Optional` props: Partial<{
    channelType?: RtmChannelType;
    customType?: string;
    messageType?: RtmMessageType;
    storeInHistory?: boolean;
}>

Returns PublishOptions

Properties

`Optional` channelType

`Optional` customType

`Optional` messageType

`Optional` storeInHistory

Settings

Member Visibility

Theme

On This Page

Class PublishOptions

Brief

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Optional props: Partial<{ channelType?: RtmChannelType; customType?: string; messageType?: RtmMessageType; storeInHistory?: boolean; }>

Returns PublishOptions

Properties

Optional channelType

Optional customType

Optional messageType

Optional storeInHistory

Settings

Member Visibility

Theme

On This Page

`Optional` props: Partial<{
channelType?: RtmChannelType;
customType?: string;
messageType?: RtmMessageType;
storeInHistory?: boolean;
}>

`Optional` channelType

`Optional` customType

`Optional` messageType

`Optional` storeInHistory