GroupChannelListQuery

GroupChannelListQuery

Query class used to get list of group channels. Initialize this class with GroupChannel.createMyGroupChannelListQuery

Constructor

new GroupChannelListQuery()

See:

Members

(static) CHANNEL_NAME_ALPHABETICAL :string

Default Value:
  • "channel_name_alphabetical"
Type:
  • string

(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

(static) QueryType

Properties:
Name Type Description
AND string

"AND"
OR string

"OR"

String enum object for describing type of query

(static) SearchField

Properties:
Name Type Description
MEMBER_NICKNAME string

"member_nickname"
CHANNEL_NAME string

"channel_name"

String enum object for describing type of search field

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

hiddenChannelFilter :string

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

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

memberStateFilter :string

Default Value:
  • "all"
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

nicknameContainsFilter :string

Default Value:
  • ""
Type:
  • string

order :string

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

publicChannelFilter :string

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

superChannelFilter :string

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

unreadChannelFilter :string

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

userIdsExactFilter :Array.<string>

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

userIdsIncludeFilter :Array.<string>

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

userIdsIncludeFilterQueryType :string

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

Methods

(static) buildFromSerializedData(serializedObject)

Parameters:
Name Type Description
serializedObject Object

next(callbackopt) → {Promise|undefined}

Executes the query

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

serialize() → {Object}

Returns:
Type
Object

setSearchFilter(fields, query)

Parameters:
Name Type Description
fields Array.<string>
query string