InterfaceMessageSearchQueryParams

interface MessageSearchQueryParams {
    advancedQuery?: boolean;
    channelCustomType?: string;
    channelUrl?: string;
    exactMatch?: boolean;
    keyword: string;
    limit?: number;
    messageTimestampFrom?: number;
    messageTimestampTo?: number;
    order?: MessageSearchOrder;
    reverse?: boolean;
    targetFields?: null | string[];
}

Hierarchy

  • BaseListQueryParams
    • MessageSearchQueryParams

Properties

advancedQuery? channelCustomType? channelUrl? exactMatch? keyword limit? messageTimestampFrom? messageTimestampTo? order? reverse? targetFields?

Properties

OptionaladvancedQuery

advancedQuery?: boolean

Description

Whether the current search query should be an advanced query or not.

OptionalchannelCustomType

channelCustomType?: string

Description

The current custom type of channel set as the search scope.

OptionalchannelUrl

channelUrl?: string

Description

The current channel url set as the search scope.

OptionalexactMatch

exactMatch?: boolean

Description

Whether the current search query should be an exact match or not.

keyword

keyword: string

Description

The current search keyword.

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

OptionalmessageTimestampFrom

messageTimestampFrom?: number

Description

The start message timestamp set as the search range.

OptionalmessageTimestampTo

messageTimestampTo?: number

Description

The end message timestamp set as the search range.

Optionalorder

order?: MessageSearchOrder

Description

The current order method.

Optionalreverse

reverse?: boolean

Description

Whether the current search result is set to be reversed or not.

OptionaltargetFields

targetFields?: null | string[]

Description

The target fields of the current query as the search scope.

Settings

Member Visibility

On This Page

Properties