InterfacePinnedMessageListQueryParams

interface PinnedMessageListQueryParams {
    includeMetaArray?: boolean;
    includeParentMessageInfo?: boolean;
    includePollDetails?: boolean;
    includeReactions?: boolean;
    includeThreadInfo?: boolean;
    limit?: number;
}

Hierarchy

  • BaseListQueryParams
    • PinnedMessageListQueryParams

Properties

includeMetaArray? includeParentMessageInfo? includePollDetails? includeReactions? includeThreadInfo? limit?

Properties

OptionalincludeMetaArray

includeMetaArray?: boolean

Description

Whether the meta arrays should be included in the results. If the value is null, it follows the default value.

OptionalincludeParentMessageInfo

includeParentMessageInfo?: boolean

Description

Whether the information of a parent message should be included in the reply messages included in the results.

OptionalincludePollDetails

includePollDetails?: boolean

Description

Whether the poll details should be included in the results.

OptionalincludeReactions

includeReactions?: boolean

Description

Whether the reaction data should be included in the results. If the value is null, it follows the default value.

OptionalincludeThreadInfo

includeThreadInfo?: boolean

Description

Whether the thread information should be included in the results. If the value is null, it follows the default value.

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

Settings

Member Visibility

On This Page

Properties