Skip to main content

Interface: ChannelListOptions

Defined in: src/red-team/network-broker-client.ts:19

Filter options for RedTeamNetworkBrokerClient.listChannels.

Extends​

Properties​

skip?​

optional skip?: number;

Defined in: src/listing.ts:8

Number of records to skip from the start.

Inherited from​

RedTeamListOptions.skip

limit?​

optional limit?: number;

Defined in: src/listing.ts:10

Max records to return.

Inherited from​

RedTeamListOptions.limit
optional search?: string;

Defined in: src/listing.ts:12

Free-text search filter.

Inherited from​

RedTeamListOptions.search

status?​

optional status?: string | string[];

Defined in: src/red-team/network-broker-client.ts:21

Filter by channel status. Pass an array to filter by several statuses at once.

include_all_if_empty?​

optional include_all_if_empty?: boolean;

Defined in: src/red-team/network-broker-client.ts:23

Include all channels when the other filters match nothing.