PublicGroupChannelListQuery

PublicGroupChannelListQuery

Query class to get public group channels. Initialize this class with GroupChannel.createPublicGroupChannelListQuery()

Constructor

new PublicGroupChannelListQuery()

See:

Members

(static) CHANNEL_NAME_ALPHABETICAL :string

Default Value:
  • "channel_name_alphabetical"
Type:
  • string

(static) MembershipType

Properties:
Name Type Description
ALL string

"all"
JOINED string

"joined"

String enum object for describing type of membership

(static) METADATA_VALUE_ALPHABETICAL :string

Default Value:
  • "metadata_value_alphabetical"
Type:
  • string

(static) ORDER_CHRONOLOGICAL :string

Default Value:
  • "chronological"
Type:
  • string

(static) ORDER_LATEST_LAST_MESSAGE :string

Default Value:
  • "latest_last_message"
Type:
  • string

channelNameContainsFilter :string

Default Value:
  • ""
Type:
  • string

channelUrlsFilter :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

customTypesFilter :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

(nullable) customTypeStartsWithFilter :string

Default Value:
  • null
Type:
  • string

hasNext :boolean

Type:
  • boolean

includeEmpty :boolean

Default Value:
  • false
Type:
  • boolean

(nullable) includeFrozen :boolean

Default Value:
  • true
Type:
  • boolean

(nullable) includeMetaData :boolean

Default Value:
  • true
Type:
  • boolean

isLoading :boolean

Type:
  • boolean

limit :number

Default Value:
  • 20
Type:
  • number

membershipFilter :string

Default Value:
  • "joined"
See:
Type:
  • string

(nullable) metadataKey :string

Default Value:
  • null
Type:
  • string

(nullable) metadataOrderKeyFilter :string

Default Value:
  • null
Type:
  • string

metadataValues :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

(nullable) metadataValueStartsWith :string

Default Value:
  • null
Type:
  • string

order :string

Default Value:
  • "latest_last_message"
See:
Type:
  • string

superChannelFilter :string

Default Value:
  • "all"
See:
Type:
  • string

Methods

next(callbackopt) → {Promise|undefined}

Executes the query

Parameters:
Name Type Attributes Description
callback groupChannelListQueryCallback <optional>
Returns:
Type
Promise | undefined