GroupChannel

GroupChannel

Class representing a group channel

Constructor

new GroupChannel(jsonObjectopt)

See:
Parameters:
Name Type Attributes Description
jsonObject Object <optional>

Extends

Members

(static) CountPreference

Properties:
Name Type Description
ALL string

"all"

UNREAD_MESSAGE_COUNT_ONLY string

"unread_message_count_only"

UNREAD_MENTION_COUNT_ONLY string

"unread_mention_count_only"

OFF string

"off"

String enum object for describing count preference

(static) HiddenChannelFilter

Properties:
Name Type Description
UNHIDDEN string

"unhidden_only"

HIDDEN string

"hidden_only"

HIDDEN_ALLOW_AUTO_UNHIDE string

"hidden_allow_auto_unhide"

HIDDEN_PREVENT_AUTO_UNHIDE string

"hidden_prevent_auto_unhide"

String enum object for describing type of hidden channel filter

(static) HiddenState

Properties:
Name Type Description
UNHIDDEN string

"unhidden"

HIDDEN_ALLOW_AUTO_UNHIDE string

"hidden_allow_auto_unhide"

HIDDEN_PREVENT_AUTO_UNHIDE string

"hidden_prevent_auto_unhide"

String enum object for describing hidden state

(static) MemberStateFilter

Properties:
Name Type Description
ALL string

"all"

JOINED string

"joined_only"

INVITED string

"invited_only"

INVITED_BY_FRIEND string

"invited_by_friend"

INVITED_BY_NON_FRIEND string

"invited_by_non_friend"

String enum object for describing type of member state filter

(static) PublicChannelFilter

Properties:
Name Type Description
ALL string

"all"

PUBLIC string

"public"

PRIVATE string

"private"

String enum object for describing type of public channel filter

(static) PushTriggerOption

Properties:
Name Type Description
DEFAULT string

"default"

ALL string

"all"

MENTION_ONLY string

"mention_only"

OFF string

"off"

String enum object for describing push trigger option

(static) Role

Properties:
Name Type Description
OPERATOR string

"operator"

NONE string

"none"

String enum object for describing the role

(static) SuperChannelFilter

Properties:
Name Type Description
ALL string

"all"

SUPER string

"super"

NON_SUPER string

"nonsuper"

String enum object for describing type of super channel filter

(static) UnreadChannelFilter

Properties:
Name Type Description
ALL string

"all"

UNREAD_MESSAGE string

"unread_message"

String enum object for describing type of unread channel filter

(static) UnreadItemKey

Properties:
Name Type Description
GROUP_CHANNEL_UNREAD_MENTION_COUNT string

"group_channel_unread_mention_count"

NONSUPER_UNREAD_MENTION_COUNT string

"non_super_group_channel_unread_mention_count"

SUPER_UNREAD_MENTION_COUNT string

"super_group_channel_unread_mention_count"

GROUP_CHANNEL_UNREAD_MESSAGE_COUNT string

"group_channel_unread_message_count"

NONSUPER_UNREAD_MESSAGE_COUNT string

"non_super_group_channel_unread_message_count"

SUPER_UNREAD_MESSAGE_COUNT string

"super_group_channel_unread_message_count"

GROUP_CHANNEL_INVITATION_COUNT string

"group_channel_invitation_count"

NONSUPER_INVITATION_COUNT string

"non_super_group_channel_invitation_count"

SUPER_INVITATION_COUNT string

"super_group_channel_invitation_count"

String enum object for describing unread item key

cachedDeliveryReceiptStatus :Object

Default Value:
  • null
Type:
  • Object

channelType :string

Overrides:
  • module:model/baseChannel~BaseChannel#channelType
Default Value:
  • "group"
See:
Type:
  • string

coverUrl :string

Overrides:
Default Value:
  • ""
Type:
  • string

createdAt :number

Overrides:
Default Value:
  • 0
Type:
  • number

(nullable) creator :module:model/user~User

Overrides:
Default Value:
  • null
Type:

(nullable) customType :string

Overrides:
Default Value:
  • null
Type:
  • string

(nullable) data :string

Overrides:
Default Value:
  • null
Type:
  • string

hiddenState :string

Default Value:
  • "unhidden"
Type:
  • string

invitedAt :number

Default Value:
  • 0
Type:
  • number

(nullable) inviter :module:model/user~User

Default Value:
  • null
Type:

isBroadcast :boolean

Default Value:
  • false
Type:
  • boolean

isDiscoverable :boolean

Default Value:
  • true
Type:
  • boolean

isDistinct :boolean

Default Value:
  • false
Type:
  • boolean

isEphemeral :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

isFrozen :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

isHidden :boolean

Default Value:
  • false
Type:
  • boolean

isPublic :boolean

Default Value:
  • false
Type:
  • boolean

isPushEnabled :any

Deprecated:
  • since version v3.0.93, please use myPushTriggerOption instead
Type:
  • any

isSuper :boolean

Default Value:
  • false
Type:
  • boolean

joinedAt :number

Default Value:
  • 0
Type:
  • number

joinedMemberCount :number

Default Value:
  • 0
Type:
  • number

(nullable) lastMessage :module:model/baseMessage~BaseMessage

Default Value:
  • null
Type:

memberCount :number

Default Value:
  • 0
Type:
  • number

members :Array.<module:model/member~Member>

Default Value:
  • []
Type:

messageOffsetTimestamp

messageSurvivalSeconds :number

Default Value:
  • -1
Type:
  • number

myLastRead :number

Default Value:
  • 0
Type:
  • number

myPushTriggerOption :string

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

name :string

Overrides:
Default Value:
  • ""
Type:
  • string

unreadMessageCount :number

Default Value:
  • 0
Type:
  • number

url :string

Overrides:
Default Value:
  • ""
Type:
  • string

Methods

(static) buildFromSerializedData(serializedObject) → {module:model/groupChannel~GroupChannel}

Parameters:
Name Type Description
serializedObject Object
Returns:
Type
module:model/groupChannel~GroupChannel

(static) createChannel(groupChannelParams, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
groupChannelParams module:model/params/groupChannelParams~GroupChannelParams
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannel(users, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
users Array.<module:model/user~User>
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannel(users, isDistinct, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
users Array.<module:model/user~User>
isDistinct boolean
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannel(users, isDistinct, customType, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
users Array.<module:model/user~User>
isDistinct boolean
customType string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannelWithUserIds(userIds, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannelWithUserIds(userIds, isDistinct, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
isDistinct boolean
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannelWithUserIds(userIds, isDistinct, customType, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
isDistinct boolean
customType string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannelWithUserIds(userIds, isDistinct, name, coverUrlOrImageFile, data, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
isDistinct boolean
name string
coverUrlOrImageFile string | File
data string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createChannelWithUserIds(userIds, isDistinct, name, coverUrlOrImageFile, data, customType, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
isDistinct boolean
name string
coverUrlOrImageFile string | File
data string
customType string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createDistinctChannelIfNotExist(params, callbackopt) → {Promise|undefined}

Parameters:
Name Type Attributes Description
params module:model/params/groupChannelParams~GroupChannelParams
callback distinctGroupChannelCallback <optional>
Returns:
Type
Promise | undefined

(static) createMyGroupChannelListQuery() → {module:model/query/groupChannelListQuery~GroupChannelListQuery}

Returns:
Type
module:model/query/groupChannelListQuery~GroupChannelListQuery

(static) createPublicGroupChannelListQuery() → {module:model/query/publicGroupChannelListQuery~PublicGroupChannelListQuery}

Returns:
Type
module:model/query/publicGroupChannelListQuery~PublicGroupChannelListQuery

(static) getChannel(channelUrl, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
channelUrl string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) getChannelWithoutCache(channelUrl, callbackopt, nullable) → {Promise|undefined}

Gets uncached version of channel

Parameters:
Name Type Attributes Description
channelUrl string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) getTotalUnreadChannelCount(callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.80, please use SendBirdInstance.getTotalUnreadChannelCount() instead
Parameters:
Name Type Attributes Description
callback groupChannelCountCallback <optional>
Returns:
Type
Promise | undefined

(static) getTotalUnreadMessageCount(groupChannelTotalUnreadMessageCountParams, callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.80, please use SendBirdInstance.getTotalUnreadMessageCount() instead
Parameters:
Name Type Attributes Description
groupChannelTotalUnreadMessageCountParams module:model/params/groupChannelTotalUnreadMessageCountParams~GroupChannelTotalUnreadMessageCountParams
callback groupChannelCountCallback <optional>
Returns:
Type
Promise | undefined

(static) getTotalUnreadMessageCount(callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.80, please use SendBirdInstance.getTotalUnreadMessageCount() instead
Parameters:
Name Type Attributes Description
callback groupChannelCountCallback <optional>
Returns:
Type
Promise | undefined

(static) getTotalUnreadMessageCount(channelCustomTypes, callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.80, please use SendBirdInstance.getTotalUnreadMessageCount() instead
Parameters:
Name Type Attributes Description
channelCustomTypes Array.<string>
callback groupChannelCountCallback <optional>
Returns:
Type
Promise | undefined

(static) getUnreadItemCount(keys, callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.80, please use SendBirdInstance.getUnreadItemCount() instead
Parameters:
Name Type Attributes Description
keys Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

acceptInvitation(accessCode, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
accessCode string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

acceptInvitation(callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

addMessageMetaArrayValues(baseMessage, metaArrays, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
baseMessage module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
metaArrays Array.<module:model/messageMetaArray~MessageMetaArray>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

addOperators(operatorUserIds, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
operatorUserIds Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

addReaction(message, key, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
key string
callback messageCallback <optional>
Returns:
Type
Promise | undefined

banUser(user, seconds, description, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
seconds number
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

banUserWithUserId(userId, secondsopt, description, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Default Description
userId string
seconds number <optional>
-1
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

cancelUploadingFileMessage(reqId, callback) → {boolean}

Overrides:
See:
Parameters:
Name Type Description
reqId string
callback cancelUploadingFileMessageCallback
Returns:
Type
boolean

copyFileMessage(channel, message, callbackopt) → {module:model/fileMessage~FileMessage|null}

Overrides:
Parameters:
Name Type Attributes Description
channel module:model/baseChannel~BaseChannel
message module:model/fileMessage~FileMessage
callback messageCallback <optional>
Returns:
Type
module:model/fileMessage~FileMessage | null

copyUserMessage(channel, message, callbackopt) → {module:model/userMessage~UserMessage|null}

Overrides:
Parameters:
Name Type Attributes Description
channel module:model/baseChannel~BaseChannel
message module:model/userMessage~UserMessage
callback messageCallback <optional>
Returns:
Type
module:model/userMessage~UserMessage | null

createBannedUserListQuery() → {module:model/query/bannedUserListQuery~BannedUserListQuery}

Returns:
Type
module:model/query/bannedUserListQuery~BannedUserListQuery

createMemberListQuery() → {module:model/query/memberListQuery~MemberListQuery}

Returns:
Type
module:model/query/memberListQuery~MemberListQuery

createMessageListQuery() → {module:compat/legacy/messageListQuery~MessageListQuery}

Overrides:
Deprecated:
  • since version v3.0.36, please use createPreviousMessageListQuery() instead
Returns:
Type
module:compat/legacy/messageListQuery~MessageListQuery

createMessageMetaArrayKeys(baseMessage, keys, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
baseMessage module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
keys Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

createMetaCounters(metaCounter, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaCounter Object
callback commonCallback <optional>
Returns:
Type
Promise | undefined

createMetaData(metaData, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaData Object
callback commonCallback <optional>
Returns:
Type
Promise | undefined

createOperatorListQuery() → {module:model/query/operatorListQuery~OperatorListQuery}

Overrides:
Returns:
Type
module:model/query/operatorListQuery~OperatorListQuery

createPreviousMessageListQuery() → {module:model/query/previousMessageListQuery~PreviousMessageListQuery}

Overrides:
Returns:
Type
module:model/query/previousMessageListQuery~PreviousMessageListQuery

declineInvitation(callbackopt) → {Promise|undefined}

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

decreaseMetaCounters(metaCounter, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaCounter Object
callback commonCallback <optional>
Returns:
Type
Promise | undefined

delete(callbackopt) → {Promise|undefined}

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

deleteAllMetaCounters(callbackopt) → {Promise|undefined}

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

deleteAllMetaData(callbackopt) → {Promise|undefined}

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

deleteMessage(message, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage
callback commonCallback <optional>
Returns:
Type
Promise | undefined

deleteMessageMetaArrayKeys(baseMessage, keys, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
baseMessage module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
keys Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

deleteMetaCounter(key, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
key string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

deleteMetaData(key, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
key string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

deleteReaction(message, key, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
key string
callback messageCallback <optional>
Returns:
Type
Promise | undefined

endTyping()

See:

freeze(callbackopt) → {Promise|undefined}

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

getAllMetaCounters(callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
callback commonCallback <optional>
Returns:
Type
Promise | undefined

getAllMetaData(callbackopt) → {Promise|undefined}

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

getCachedMetaData() → {object}

Overrides:

Retrieve cached metadata of a channel.

Returns:
Type
object

getDeliveryReceipt(message) → {number}

Deprecated:
  • since version v3.0.127, please use getUndeliveredMemberCount() instead
Parameters:
Name Type Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
Returns:
Type
number

getMessageChangeLogsByTimestamp(ts, includeMetaArrayopt, callbackopt) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessageChangeLogsSinceTimestamp() instead
Parameters:
Name Type Attributes Default Description
ts number
includeMetaArray boolean <optional>
false
callback getMessageChangeLogsHandler <optional>
Returns:
Type
Promise | undefined

getMessageChangeLogsByToken(token, includeMetaArrayopt, includeReactionsopt, callbackopt) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessageChangeLogsSinceToken() instead
Parameters:
Name Type Attributes Default Description
token string
includeMetaArray boolean <optional>
false
includeReactions boolean <optional>
false
callback getMessageChangeLogsHandler <optional>
Returns:
Type
Promise | undefined

getMessageChangeLogsSinceTimestamp(token, params, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
token string
params module:model/params/messageChangeLogsParams~MessageChangeLogsParams
callback getMessageChangeLogsHandler <optional>
Returns:
Type
Promise | undefined

getMessageChangeLogsSinceToken(token, params, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
token string
params module:model/params/messageChangeLogsParams~MessageChangeLogsParams
callback getMessageChangeLogsHandler <optional>
Returns:
Type
Promise | undefined

getMessagesByMessageId(messageId, params, callbackopt, nullable) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
messageId number
params module:model/params/messageListParams~MessageListParams
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getMessagesByTimestamp(timestamp, params, callbackopt, nullable) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
timestamp number
params module:model/params/messageListParams~MessageListParams
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getMetaCounters(keys, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
keys Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

getMetaData(keys, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
keys Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

getMyMutedInfo(callbackopt) → {Promise|undefined}

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

getMyPushTriggerOption(callbackopt) → {Promise|undefined}

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

getNextMessagesByID(messageId, isInclusive, nextResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt, nullable) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByMessageId() instead
Parameters:
Name Type Attributes Description
messageId number
isInclusive boolean
nextResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getNextMessagesByTimestamp(ts, isInclusive, prevResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt, nullable) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByTimestamp() instead
Parameters:
Name Type Attributes Description
ts number
isInclusive boolean
prevResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getPreviousAndNextMessagesByID(messageId, prevResultSize, nextResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt) → {*}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByMessageId() instead
Parameters:
Name Type Attributes Description
messageId number
prevResultSize number
nextResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
Returns:
Type
*

getPreviousAndNextMessagesByTimestamp(ts, prevResultSize, nextResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt, nullable) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByTimestamp() instead
Parameters:
Name Type Attributes Description
ts number
prevResultSize number
nextResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getPreviousMessagesByID(messageId, isInclusive, prevResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt, nullable) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByMessageId() instead
Parameters:
Name Type Attributes Description
messageId number
isInclusive boolean
prevResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getPreviousMessagesByTimestamp(ts, isInclusive, prevResultSize, shouldReverse, messageType, customType, senderUserIds, includeMetaArray, includeReactions, callbackopt, nullable) → {Promise|undefined}

Overrides:
Deprecated:
  • since version v3.0.123, please use getMessagesByTimestamp() instead
Parameters:
Name Type Attributes Description
ts number
isInclusive boolean
prevResultSize number
shouldReverse boolean
messageType string
customType string
senderUserIds Array.<string>
includeMetaArray boolean
includeReactions boolean
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getPushPreference(callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.93, please use getMyPushTriggerOption() instead
Parameters:
Name Type Attributes Description
callback getPushPreferenceCallback <optional>
Returns:
Type
Promise | undefined

getReadMembers(message, includeAllMembersopt) → {Array.<module:model/member~Member>}

See:
Parameters:
Name Type Attributes Default Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage
includeAllMembers boolean <optional>
false
Returns:
Type
Array.<module:model/member~Member>

getReadReceipt(message) → {number}

Deprecated:
  • since version v3.0.127, please use getUnreadMemberCount() instead
See:
Parameters:
Name Type Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
Returns:
Type
number

getReadStatus(includeAllMembersopt) → {Object}

See:
Parameters:
Name Type Attributes Default Description
includeAllMembers boolean <optional>
false
Returns:
Type
Object

getTypingMembers() → {Array.<module:model/member~Member>}

Deprecated:
  • Yes
See:
Returns:
Type
Array.<module:model/member~Member>

getTypingUsers() → {Array.<module:model/member~Member>}

See:
Returns:
Type
Array.<module:model/member~Member>

getUndeliveredMemberCount(message) → {number}

Parameters:
Name Type Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
Returns:
Type
number

getUnreadMemberCount(message) → {number}

Parameters:
Name Type Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
Returns:
Type
number

getUnreadMembers(message, includeAllMembersopt) → {Array.<module:model/member~Member>}

See:
Parameters:
Name Type Attributes Default Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage
includeAllMembers boolean <optional>
false
Returns:
Type
Array.<module:model/member~Member>

hide(hidePreviousMessagesopt, allowAutoUnhideopt, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Default Description
hidePreviousMessages boolean <optional>
false
allowAutoUnhide boolean <optional>
true
callback commonCallback <optional>
Returns:
Type
Promise | undefined

hide(callbackopt) → {Promise|undefined}

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

hide(hidePreviousMessagesopt, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Default Description
hidePreviousMessages boolean <optional>
false
callback commonCallback <optional>
Returns:
Type
Promise | undefined

increaseMetaCounters(metaCounter, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaCounter Object
callback commonCallback <optional>
Returns:
Type
Promise | undefined

invite(users, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
users Array.<module:model/user~User>
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

inviteWithUserIds(userIds, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userIds Array.<string>
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

isEqual(channel) → {boolean}

Parameters:
Name Type Description
channel module:model/baseChannel~BaseChannel
Returns:
Type
boolean

isGroupChannel() → {boolean}

Overrides:
Returns:
Type
boolean

isIdentical(channel) → {boolean}

Parameters:
Name Type Description
channel module:model/baseChannel~BaseChannel
Returns:
Type
boolean

isOpenChannel() → {boolean}

Overrides:
Returns:
Type
boolean

isTyping() → {boolean}

Returns:
Type
boolean

join(accessCodeopt, nullable, callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Default Description
accessCode string <optional>
<nullable>
null
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

join(callbackopt, nullable) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

leave(callbackopt) → {Promise|undefined}

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

markAsDelivered()

Deprecated:
  • since version v3.0.143, please use SendBirdInstance.markAsDelivered() instead

markAsRead()

See:

Marks channel messages as read

muteUser(user, seconds, description, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
seconds number
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

muteUser(user, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
callback commonCallback <optional>
Returns:
Type
Promise | undefined

muteUserWithUserId(userId, secondsopt, descriptionopt, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Default Description
userId string
seconds number <optional>
-1
description string <optional>
""
callback commonCallback <optional>
Returns:
Type
Promise | undefined

muteUserWithUserId(userId, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userId string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

refresh(callbackopt, nullable) → {Promise|undefined}

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

registerScheduledUserMessage(groupChannelParams, callbackopt) → {Promise|undefined}

Parameters:
Name Type Attributes Description
groupChannelParams module:model/params/scheduledUserMessageParams~ScheduledUserMessageParams
callback scheduledUserMessageCallback <optional>
Returns:
Type
Promise | undefined

removeMessageMetaArrayValues(baseMessage, metaArrays, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
baseMessage module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
metaArrays Array.<module:model/messageMetaArray~MessageMetaArray>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

removeOperators(operatorUserIds, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
operatorUserIds Array.<string>
callback commonCallback <optional>
Returns:
Type
Promise | undefined

report(category, description, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
category string
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

reportMessage(message, category, description, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage | module:model/adminMessage~AdminMessage
category string
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

reportUser(user, category, description, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
user module:model/user~User
category string
description string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

resendFileMessage(failedMessage, callbackopt) → {Promise|undefined}

Overrides:

API to resend failed file messages

Parameters:
Name Type Attributes Description
failedMessage module:model/fileMessage~FileMessage
callback messageCallback <optional>
Returns:
Type
Promise | undefined

resendUserMessage(failedMessage, callbackopt) → {Promise|undefined}

Overrides:
Parameters:
Name Type Attributes Description
failedMessage module:model/userMessage~UserMessage
callback messageCallback <optional>
Returns:
Type
Promise | undefined

resetMyHistory(callbackopt) → {Promise|undefined}

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

sendFileMessage(fileMessageParams, callbackopt) → {module:model/fileMessage~FileMessage|null}

Overrides:
See:
Parameters:
Name Type Attributes Description
fileMessageParams module:model/params/fileMessageParams~FileMessageParams
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessages(fileMessageParamsList, handlersopt) → {Array.<module:model/fileMessage~FileMessage>|null}

Overrides:

Send multiple file messages

Parameters:
Name Type Attributes Default Description
fileMessageParamsList Array.<module:model/params/fileMessageParams~FileMessageParams>
handlers fileMessagesCallbackObject <optional>
{}
Returns:
Type
Array.<module:model/fileMessage~FileMessage> | null

sendUserMessage(userMessageParams, callbackopt) → {module:model/userMessage~UserMessage|null}

Overrides:
Parameters:
Name Type Attributes Description
userMessageParams module:model/params/userMessageParams~UserMessageParams
callback messageCallback <optional>
Returns:
  • returns pending message on success
Type
module:model/userMessage~UserMessage | null

serialize() → {Object}

Overrides:
Returns:
Type
Object

setLatestMemberCount(count, joinedCount, ts) → {boolean}

Set member count when event falls on super/broadcast group channel as super/broadcast group channel doesn't manage members by its own. The member count of super/broadcast group channel is managed by event, and the member list is acquired by member list query.

Parameters:
Name Type Description
count number
joinedCount number
ts number
Returns:
Type
boolean

setMyCountPreference(countPreference, callbackopt) → {Promise|undefined}

Parameters:
Name Type Attributes Description
countPreference string

One of "all" | "unread_message_count_only" | "unread_mention_count_only" | "off"

callback commonCallback <optional>
Returns:
Type
Promise | undefined

setMyPushTriggerOption(pushTriggerOption, callbackopt) → {Promise|undefined}

Parameters:
Name Type Attributes Description
pushTriggerOption string
callback getPushTriggerOptionCallback <optional>
Returns:
Type
Promise | undefined

setPushPreference(enable, callbackopt) → {Promise|undefined}

Deprecated:
  • since version v3.0.93, please use getMyPushTriggerOption() instead
Parameters:
Name Type Attributes Description
enable boolean
callback commonCallback <optional>
Returns:
Type
Promise | undefined

startTyping()

See:

translateUserMessage(message, translationTargetLanguages, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
message module:model/userMessage~UserMessage
translationTargetLanguages Array.<string>
callback messageCallback <optional>
Returns:
Type
Promise | undefined

unbanUser(user, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
callback commonCallback <optional>
Returns:
Type
Promise | undefined

unbanUserWithUserId(userId, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userId string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

unfreeze(callbackopt) → {Promise|undefined}

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

unhide(callbackopt) → {Promise|undefined}

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

unmuteUser(user, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
callback commonCallback <optional>
Returns:
Type
Promise | undefined

unmuteUserWithUserId(userId, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
userId string
callback commonCallback <optional>
Returns:
Type
Promise | undefined

updateChannel(groupChannelParams, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
groupChannelParams module:model/params/groupChannelParams~GroupChannelParams
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

updateChannel(name, coverUrlOrImageFile, data, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
name string
coverUrlOrImageFile string | File
data string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

updateChannel(isDistinct, name, coverUrlOrImageFile, data, callbackopt, nullable) → {Promise|undefined}

Deprecated:
  • Yes
Parameters:
Name Type Attributes Description
isDistinct boolean
name string
coverUrlOrImageFile string | File
data string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

updateChannel(isDistinct, name, coverUrlOrImageFile, data, customType, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
isDistinct boolean
name string
coverUrlOrImageFile string | File
data string
customType string
callback groupChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

updateFileMessage(messageId, datanullable, customTypenullable, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
messageId number
data string <nullable>
customType string <nullable>
callback messageCallback <optional>
Returns:
Type
Promise | undefined

updateMetaCounters(metaCounter, upsertopt, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Default Description
metaCounter Object
upsert boolean <optional>
false
callback commonCallback <optional>
Returns:
Type
Promise | undefined

updateMetaData(metaData, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaData Object
callback commonCallback <optional>
Returns:
Type
Promise | undefined

updateUserMessage(messageId, messagenullable, datanullable, customTypenullable, callbackopt) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
messageId number
message string <nullable>
data string <nullable>
customType string <nullable>
callback messageCallback <optional>
Returns:
Type
Promise | undefined