InterfaceOpenChannelListQueryParams

interface OpenChannelListQueryParams {
    customTypes?: string[];
    includeFrozen?: boolean;
    includeMetaData?: boolean;
    limit?: number;
    nameKeyword?: string;
    urlKeyword?: string;
}

Hierarchy

  • BaseListQueryParams
    • OpenChannelListQueryParams

Properties

customTypes? includeFrozen? includeMetaData? limit? nameKeyword? urlKeyword?

Properties

OptionalcustomTypes

customTypes?: string[]

Description

A filter to return only channels with the specified customType.

OptionalincludeFrozen

includeFrozen?: boolean

Description

Indicate whether to include frozen channels or not. (default: true)

OptionalincludeMetaData

includeMetaData?: boolean

Description

Indicate whether to include channel metadata on fetch. (default: true)

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

OptionalnameKeyword

nameKeyword?: string

Description

Indicate search keyword for channel name.

OptionalurlKeyword

urlKeyword?: string

Description

Indicate search keyword for channel URL.

Settings

Member Visibility

On This Page

Properties