Search
Preparing search index...
The search index is not available
Sendbird Chat SDK Reference - v4.3.1
Options
All
Public
Public/Protected
All
Inherited
Menu
Sendbird Chat SDK Reference - v4.3.1
@sendbird/chat/groupChannel
GroupChannelHandler
Class GroupChannelHandler
Hierarchy
GroupChannelHandlerParams
GroupChannelHandler
Index
Constructors
constructor
Properties
on
Channel
Changed
on
Channel
Deleted
on
Channel
Frozen
on
Channel
Hidden
on
Channel
Member
Count
Changed
on
Channel
Unfrozen
on
Mention
Received
on
Message
Deleted
on
Message
Received
on
Message
Updated
on
Meta
Counter
Created
on
Meta
Counter
Deleted
on
Meta
Counter
Updated
on
Meta
Data
Created
on
Meta
Data
Deleted
on
Meta
Data
Updated
on
Operator
Updated
on
Pinned
Message
Updated
on
Poll
Deleted
on
Poll
Updated
on
Poll
Voted
on
Reaction
Updated
on
Thread
Info
Updated
on
Typing
Status
Updated
on
Undelivered
Member
Status
Updated
on
Unread
Member
Status
Updated
on
User
Banned
on
User
Declined
Invitation
on
User
Joined
on
User
Left
on
User
Muted
on
User
Received
Invitation
on
User
Unbanned
on
User
Unmuted
Constructors
constructor
new
Group
Channel
Handler
(
params
?:
GroupChannelHandlerParams
)
:
GroupChannelHandler
Parameters
params:
GroupChannelHandlerParams
= {}
Returns
GroupChannelHandler
Properties
Optional
on
Channel
Changed
on
Channel
Changed
?:
(
(
channel
:
BaseChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
)
:
void
Parameters
channel:
BaseChannel
Returns
void
Optional
on
Channel
Deleted
on
Channel
Deleted
?:
(
(
channelUrl
:
string
, channelType
:
ChannelType
)
=>
void
)
= noop
Type declaration
(
channelUrl
:
string
, channelType
:
ChannelType
)
:
void
Parameters
channelUrl:
string
channelType:
ChannelType
Returns
void
Optional
on
Channel
Frozen
on
Channel
Frozen
?:
(
(
channel
:
BaseChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
)
:
void
Parameters
channel:
BaseChannel
Returns
void
Optional
on
Channel
Hidden
on
Channel
Hidden
?:
(
(
channel
:
GroupChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
)
:
void
Parameters
channel:
GroupChannel
Returns
void
Optional
on
Channel
Member
Count
Changed
on
Channel
Member
Count
Changed
?:
(
(
channels
:
BaseChannel
[]
)
=>
void
)
= noop
Type declaration
(
channels
:
BaseChannel
[]
)
:
void
Parameters
channels:
BaseChannel
[]
Returns
void
Optional
on
Channel
Unfrozen
on
Channel
Unfrozen
?:
(
(
channel
:
BaseChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
)
:
void
Parameters
channel:
BaseChannel
Returns
void
Optional
on
Mention
Received
on
Mention
Received
?:
(
(
channel
:
BaseChannel
, message
:
BaseMessage
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, message
:
BaseMessage
)
:
void
Parameters
channel:
BaseChannel
message:
BaseMessage
Returns
void
Optional
on
Message
Deleted
on
Message
Deleted
?:
(
(
channel
:
BaseChannel
, messageId
:
number
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, messageId
:
number
)
:
void
Parameters
channel:
BaseChannel
messageId:
number
Returns
void
Optional
on
Message
Received
on
Message
Received
?:
(
(
channel
:
BaseChannel
, message
:
BaseMessage
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, message
:
BaseMessage
)
:
void
Parameters
channel:
BaseChannel
message:
BaseMessage
Returns
void
Optional
on
Message
Updated
on
Message
Updated
?:
(
(
channel
:
BaseChannel
, message
:
BaseMessage
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, message
:
BaseMessage
)
:
void
Parameters
channel:
BaseChannel
message:
BaseMessage
Returns
void
Optional
on
Meta
Counter
Created
on
Meta
Counter
Created
?:
(
(
channel
:
BaseChannel
, metaCounter
:
MetaCounter
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaCounter
:
MetaCounter
)
:
void
Parameters
channel:
BaseChannel
metaCounter:
MetaCounter
Returns
void
Optional
on
Meta
Counter
Deleted
on
Meta
Counter
Deleted
?:
(
(
channel
:
BaseChannel
, metaCounterKeys
:
string
[]
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaCounterKeys
:
string
[]
)
:
void
Parameters
channel:
BaseChannel
metaCounterKeys:
string
[]
Returns
void
Optional
on
Meta
Counter
Updated
on
Meta
Counter
Updated
?:
(
(
channel
:
BaseChannel
, metaCounter
:
MetaCounter
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaCounter
:
MetaCounter
)
:
void
Parameters
channel:
BaseChannel
metaCounter:
MetaCounter
Returns
void
Optional
on
Meta
Data
Created
on
Meta
Data
Created
?:
(
(
channel
:
BaseChannel
, metaData
:
MetaData
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaData
:
MetaData
)
:
void
Parameters
channel:
BaseChannel
metaData:
MetaData
Returns
void
Optional
on
Meta
Data
Deleted
on
Meta
Data
Deleted
?:
(
(
channel
:
BaseChannel
, metaDataKeys
:
string
[]
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaDataKeys
:
string
[]
)
:
void
Parameters
channel:
BaseChannel
metaDataKeys:
string
[]
Returns
void
Optional
on
Meta
Data
Updated
on
Meta
Data
Updated
?:
(
(
channel
:
BaseChannel
, metaData
:
MetaData
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, metaData
:
MetaData
)
:
void
Parameters
channel:
BaseChannel
metaData:
MetaData
Returns
void
Optional
on
Operator
Updated
on
Operator
Updated
?:
(
(
channel
:
BaseChannel
, users
:
User
[]
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, users
:
User
[]
)
:
void
Parameters
channel:
BaseChannel
users:
User
[]
Returns
void
Optional
on
Pinned
Message
Updated
on
Pinned
Message
Updated
?:
(
(
channel
:
GroupChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
)
:
void
Parameters
channel:
GroupChannel
Returns
void
Optional
on
Poll
Deleted
on
Poll
Deleted
?:
(
(
channel
:
GroupChannel
, id
:
number
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, id
:
number
)
:
void
Parameters
channel:
GroupChannel
id:
number
Returns
void
Optional
on
Poll
Updated
on
Poll
Updated
?:
(
(
channel
:
GroupChannel
, event
:
default
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, event
:
default
)
:
void
Parameters
channel:
GroupChannel
event:
default
Returns
void
Optional
on
Poll
Voted
on
Poll
Voted
?:
(
(
channel
:
GroupChannel
, event
:
default
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, event
:
default
)
:
void
Parameters
channel:
GroupChannel
event:
default
Returns
void
Optional
on
Reaction
Updated
on
Reaction
Updated
?:
(
(
channel
:
BaseChannel
, reactionEvent
:
ReactionEvent
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, reactionEvent
:
ReactionEvent
)
:
void
Parameters
channel:
BaseChannel
reactionEvent:
ReactionEvent
Returns
void
Optional
on
Thread
Info
Updated
on
Thread
Info
Updated
?:
(
(
channel
:
BaseChannel
, threadInfoUpdateEvent
:
ThreadInfoUpdateEvent
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, threadInfoUpdateEvent
:
ThreadInfoUpdateEvent
)
:
void
Parameters
channel:
BaseChannel
threadInfoUpdateEvent:
ThreadInfoUpdateEvent
Returns
void
Optional
on
Typing
Status
Updated
on
Typing
Status
Updated
?:
(
(
channel
:
GroupChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
)
:
void
Parameters
channel:
GroupChannel
Returns
void
Optional
on
Undelivered
Member
Status
Updated
on
Undelivered
Member
Status
Updated
?:
(
(
channel
:
GroupChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
)
:
void
Parameters
channel:
GroupChannel
Returns
void
Optional
on
Unread
Member
Status
Updated
on
Unread
Member
Status
Updated
?:
(
(
channel
:
GroupChannel
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
)
:
void
Parameters
channel:
GroupChannel
Returns
void
Optional
on
User
Banned
on
User
Banned
?:
(
(
channel
:
BaseChannel
, user
:
RestrictedUser
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, user
:
RestrictedUser
)
:
void
Parameters
channel:
BaseChannel
user:
RestrictedUser
Returns
void
Optional
on
User
Declined
Invitation
on
User
Declined
Invitation
?:
(
(
channel
:
GroupChannel
, inviter
:
User
, invitee
:
User
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, inviter
:
User
, invitee
:
User
)
:
void
Parameters
channel:
GroupChannel
inviter:
User
invitee:
User
Returns
void
Optional
on
User
Joined
on
User
Joined
?:
(
(
channel
:
GroupChannel
, user
:
User
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, user
:
User
)
:
void
Parameters
channel:
GroupChannel
user:
User
Returns
void
Optional
on
User
Left
on
User
Left
?:
(
(
channel
:
GroupChannel
, user
:
User
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, user
:
User
)
:
void
Parameters
channel:
GroupChannel
user:
User
Returns
void
Optional
on
User
Muted
on
User
Muted
?:
(
(
channel
:
BaseChannel
, user
:
RestrictedUser
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, user
:
RestrictedUser
)
:
void
Parameters
channel:
BaseChannel
user:
RestrictedUser
Returns
void
Optional
on
User
Received
Invitation
on
User
Received
Invitation
?:
(
(
channel
:
GroupChannel
, inviter
:
User
, invitees
:
User
[]
)
=>
void
)
= noop
Type declaration
(
channel
:
GroupChannel
, inviter
:
User
, invitees
:
User
[]
)
:
void
Parameters
channel:
GroupChannel
inviter:
User
invitees:
User
[]
Returns
void
Optional
on
User
Unbanned
on
User
Unbanned
?:
(
(
channel
:
BaseChannel
, user
:
User
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, user
:
User
)
:
void
Parameters
channel:
BaseChannel
user:
User
Returns
void
Optional
on
User
Unmuted
on
User
Unmuted
?:
(
(
channel
:
BaseChannel
, user
:
User
)
=>
void
)
= noop
Type declaration
(
channel
:
BaseChannel
, user
:
User
)
:
void
Parameters
channel:
BaseChannel
user:
User
Returns
void
Modules
@sendbird/chat
@sendbird/chat/group
Channel
@sendbird/chat/message
@sendbird/chat/open
Channel
Group
Channel
Handler
constructor
on
Channel
Changed
on
Channel
Deleted
on
Channel
Frozen
on
Channel
Hidden
on
Channel
Member
Count
Changed
on
Channel
Unfrozen
on
Mention
Received
on
Message
Deleted
on
Message
Received
on
Message
Updated
on
Meta
Counter
Created
on
Meta
Counter
Deleted
on
Meta
Counter
Updated
on
Meta
Data
Created
on
Meta
Data
Deleted
on
Meta
Data
Updated
on
Operator
Updated
on
Pinned
Message
Updated
on
Poll
Deleted
on
Poll
Updated
on
Poll
Voted
on
Reaction
Updated
on
Thread
Info
Updated
on
Typing
Status
Updated
on
Undelivered
Member
Status
Updated
on
Unread
Member
Status
Updated
on
User
Banned
on
User
Declined
Invitation
on
User
Joined
on
User
Left
on
User
Muted
on
User
Received
Invitation
on
User
Unbanned
on
User
Unmuted
Generated using
TypeDoc