Global

Members

(constant) supportNumberCompatibility

See:

Compatibility patch for IE11.

(constant) supportObjectCompatibility

See:

Compatibility patch for IE11.

Type Definitions

cancelUploadingFileMessageCallback(isSuccess, error)

See:

Callback called after cancelling uploading file request callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
isSuccess boolean
error module:exception~SendBirdException

commonCallback(response, error)

See:

Common callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
response Object
error module:exception~SendBirdException

DiscoveryObject

Properties:
Name Type Attributes Description
friendDiscoveryKey string
friendName string <optional>
Type:
  • Object

distinctGroupChannelCallback(response, error)

See:

Create distinct group channel callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
response DistinctGroupChannelResponse
error module:exception~SendBirdException

DistinctGroupChannelResponse

Properties:
Name Type Description
channel module:model/groupChannel~GroupChannel
isCreated boolean
Type:
  • Object

EmojiCallback(error, emoji)

Parameters:
Name Type Description
error module:exception~SendBirdException
emoji Emoji

EmojiCategoryCallback(error, emojis)

Parameters:
Name Type Description
error module:exception~SendBirdException
emojis EmojiCategory

EmojiContainerCallback(error, emojiCategories)

Parameters:
Name Type Description
error module:exception~SendBirdException
emojiCategories EmojiContainer

fileCompletedCallback(error)

File sending completion notifier callback

Parameters:
Name Type Description
error module:exception~SendBirdException

fileMessagesCallbackObject

Properties:
Name Type Description
progress fileProgressHandlerCallback
sent fileSentCallback
complete fileCompletedCallback
Type:
  • Object

fileProgressHandlerCallback(event, reqId)

File upload progress handler callback

Parameters:
Name Type Description
event
reqId string

fileSentCallback(message, error)

File send operation notifier callback

Parameters:
Name Type Description
message module:model/fileMessage~FileMessage
error module:exception~SendBirdException

getFriendChangeLogs

Properties:
Name Type Description
updatedUsers Array.<module:model/user~User>
deletedUserIds Array.<string>
hasMore boolean
token string
Type:
  • Object

getFriendChangeLogsByTokenHandler(data, error)

See:

Friend change logs callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
data getFriendChangeLogs
error module:exception~SendBirdException

getGroupChannelChangeLogsHandler(data, error)

See:

Change logs callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
data groupChannelChangeLogs
error module:exception~SendBirdException

getMessageChangeLogsHandler(data, error)

See:

Message change logs handler query callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
data messageChangeLogs
error module:exception~SendBirdException

getMyMutedInfoHandler(info, error)

See:

Muted info handler callback request callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
info mutedInfo
error module:exception~SendBirdException

getMyPushTokensHandler(data, error)

See:

Push notifications tokens callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
data pushTokens
error module:exception~SendBirdException

getPushPreferenceCallback(isPushOn, error)

See:

Push preference callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
isPushOn boolean
error module:exception~SendBirdException

getPushTriggerOptionCallback(pushTriggerOption, error)

See:

Push trigger option callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
pushTriggerOption string

one of "all" | "mention_only" | "off" | "default"

error module:exception~SendBirdException

groupChannelCallback(groupChannel, error)

See:

Group channel callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
groupChannel module:model/groupChannel~GroupChannel
error module:exception~SendBirdException

groupChannelChangeLogs

Properties:
Name Type Description
updatedChannels Array.<module:model/groupChannel~GroupChannel>
deletedChannelUrls Array.<string>
hasMore boolean
token string
Type:
  • Object

groupChannelCountCallback(count, error)

See:

Group channel count callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
count number
error module:exception~SendBirdException

groupChannelCountCallback(count, error)

See:

Count of group channels callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
count number
error module:exception~SendBirdException

groupChannelListQueryCallback(groupChannelList, error)

See:

Group channel list query callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
groupChannelList Array.<module:model/groupChannel~GroupChannel>
error module:exception~SendBirdException

groupChannelMemberListQueryCallback(groupChannelList, error)

See:

Group channel member list query callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
groupChannelList Array.<module:model/member~Member>
error module:exception~SendBirdException

messageCallback(message, error)

See:

Message callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
message module:model/userMessage~UserMessage | module:model/fileMessage~FileMessage
error module:exception~SendBirdException

messageChangeLogs

Properties:
Name Type Description
updatedMessages Array.<module:model/userMessage~UserMessage> | Array.<module:model/fileMessage~FileMessage> | Array.<module:model/adminMessage~AdminMessage>
deletedMessageIds Array.<string>
hasMore boolean
token string
Type:
  • Object

messageListCallback(messageList, error)

See:

Message list callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
messageList Array.<module:model/userMessage~UserMessage> | Array.<module:model/fileMessage~FileMessage> | Array.<module:model/adminMessage~AdminMessage>
error module:exception~SendBirdException

mutedInfo

Properties:
Name Type Description
isMuted boolean
startAt number
endAt number
remainingDuration number
description string
Type:
  • Object

openChannelCallback(openChannel, error)

See:

Open channel callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
openChannel module:model/openChannel~OpenChannel
error module:exception~SendBirdException

openChannelListQueryCallback(openChannelList, error)

See:

Open channel list query callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
openChannelList Array.<module:model/openChannel~OpenChannel>
error module:exception~SendBirdException

Options

Properties:
Name Type Description
useMemberAsMessageSender boolean
typingIndicatorThrottle number
Type:
  • Object

pushSettingCallback(response, error)

See:

Push notifications settings callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
response string
error module:exception~SendBirdException

pushTokens

Properties:
Name Type Description
deviceTokens Array.<string>
type string

one of "gcm" | "apns" | "apns_voip"

hasMore boolean
token string
Type:
  • Object

scheduledUserMessageCallback(scheduledUserMessage, error)

See:

Scheduled user message callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
scheduledUserMessage module:model/scheduledUserMessage~ScheduledUserMessage
error module:exception~SendBirdException

ThumbnailObject

Properties:
Name Type Description
url string
height number
width number
real_height number
real_width number
Type:
  • Object

userCallback(user, error)

See:

User callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
user module:model/user~User
error module:exception~SendBirdException

userListQueryCallback(userList, error)

See:

User list query callback. If you set setErrorFirstCallback to true, order of parameters is reversed

Parameters:
Name Type Description
userList Array.<module:model/user~User>
error module:exception~SendBirdException