Class ChatConversationFetchOptions

The conversation filter class.

Index

Constructors

Properties

cursor? mark? pageSize? pinned?

Methods

default pinned withMark

Constructors

constructor

new ChatConversationFetchOptions(
    params: {
        cursor?: string;
        mark?: ChatConversationMarkType;
        pageSize?: number;
        pinned?: boolean;
    },
): ChatConversationFetchOptions
Parameters
- params: {
      cursor?: string;
      mark?: ChatConversationMarkType;
      pageSize?: number;
      pinned?: boolean;
  }
Returns ChatConversationFetchOptions

Properties

`Optional`cursor

cursor?: string

The cursor to specify where to start retrieving conversations.

`Optional`mark

mark?: ChatConversationMarkType

Whether to get marked conversations.

true: Yes.
false: No.

`Optional`pageSize

pageSize?: number

The number of conversations to retrieve.

If you retrieve marked conversations, the value range is [1,10], with 10 as the default. Otherwise, the value range is [1,50].

`Optional`pinned

pinned?: boolean

Whether to get pinned conversations.

true: Yes.
false: No.

Methods

`Static`default

default(): ChatConversationFetchOptions
Returns ChatConversationFetchOptions

`Static`pinned

pinned(): ChatConversationFetchOptions
Returns ChatConversationFetchOptions

`Static`withMark

withMark(mark: ChatConversationMarkType): ChatConversationFetchOptions
Parameters
- mark: ChatConversationMarkType
Returns ChatConversationFetchOptions