GroupChannelParams

GroupChannelParams

Parameter class for creating group channels. This class is used by GroupChannel.createChannel() and groupChannel.updateChannel()

Members

(nullable) accessCode :string

Default Value:
  • null
Type:
  • string

(nullable) channelUrl :string

Default Value:
  • null
Type:
  • string

coverImage :Blob|Object|null

Default Value:
  • null
Type:
  • Blob | Object | null

(nullable) coverUrl :string

Default Value:
  • null
Type:
  • string

(nullable) customType :string

Default Value:
  • null
Type:
  • string

(nullable) data :string

Default Value:
  • null
Type:
  • string

(nullable) isBroadcast :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isDiscoverable :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isDistinct :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isEphemeral :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isPublic :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isStrict :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) isSuper :boolean

Default Value:
  • null
Type:
  • boolean

(nullable) messageSurvivalSeconds :number

Default Value:
  • null
Type:
  • number

(nullable) name :string

Default Value:
  • null
Type:
  • string

operators :Array.<module:model/user~User>

Setter only

Type:

operatorUserIds :Array.<string>

Default Value:
  • null
Type:
  • Array.<string>

Methods

addUser(user)

Parameters:
Name Type Description
user Array.<module:model/user~User>

addUserId(userId)

Parameters:
Name Type Description
userId string

addUserIds(userIds)

Parameters:
Name Type Description
userIds Array.<string>

addUsers(users)

Parameters:
Name Type Description
users Array.<module:model/user~User>