OpenChannel

OpenChannel

Class representing an open channel

Constructor

new OpenChannel(jsonObjectopt)

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

Extends

Members

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

isEphemeral :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

isFrozen :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

name :string

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

participantCount :number

Default Value:
  • 0
Type:
  • number

url :string

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

Methods

(static) buildFromSerializedData(serializedObject)

Parameters:
Name Type Description
serializedObject object
Returns:

module:model/openChannel~OpenChannel

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

See:
Parameters:
Name Type Attributes Description
openChannelParams module:model/params/openChannelParams~OpenChannelParams
callback openChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

(static) createChannel(name, coverUrlOrImageFile, data, operatorUserIds, callbackopt, nullable) → {Promise|undefined}

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

(static) createChannel(name, coverUrlOrImageFile, data, operatorUserIds, customType, callbackopt, nullable) → {Promise|undefined}

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

(static) createChannelWithOperatorUserIds(name, coverUrlOrImageFile, data, operatorUserIds, callbackopt, nullable) → {Promise|undefined}

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

(static) createChannelWithOperatorUserIds(name, coverUrlOrImageFile, data, operatorUserIds, customType, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
name string
coverUrlOrImageFile string | File
data string
operatorUserIds Array.<string> | string
customType string
callback openChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

(static) createOpenChannelListQuery() → {module:model/query/openChannelListQuery~OpenChannelListQuery}

Returns:
Type
module:model/query/openChannelListQuery~OpenChannelListQuery

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

Parameters:
Name Type Attributes Description
channelUrl string
callback openChannelCallback <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 openChannelCallback <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, callbackopt, nullable) → {Promise|undefined}

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

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

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

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

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

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

See:
Parameters:
Name Type Attributes Description
userId string
callback commonCallback <optional>
<nullable>
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}

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

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

createMutedUserListQuery() → {module:model/query/mutedUserListQuery~MutedUserListQuery}

See:
Returns:
Type
module:model/query/mutedUserListQuery~MutedUserListQuery

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

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

createParticipantListQuery() → {module:model/query/participantListQuery~ParticipantListQuery}

See:
Returns:
Type
module:model/query/participantListQuery~ParticipantListQuery

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

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

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

Overrides:
See:
Parameters:
Name Type Attributes Description
metaCounter Object
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

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

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

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

See:
Parameters:
Name Type Attributes Description
callback openChannelCallback <optional>
<nullable>
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

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

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

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

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

isGroupChannel() → {boolean}

Overrides:
Returns:
Type
boolean

isOpenChannel() → {boolean}

Overrides:
Returns:
Type
boolean

isOperator(user) → {boolean}

Parameters:
Name Type Description
user module:model/user~User
Returns:
Type
boolean

isOperatorWithUserId(userId) → {boolean}

Parameters:
Name Type Description
userId string
Returns:
Type
boolean

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

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

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

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

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

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

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

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

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

Parameters:
Name Type Attributes Description
callback openChannelCallback <optional>
<nullable>
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

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

setLatestParticipantCount(count, ts) → {boolean}

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

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, nullable) → {Promise|undefined}

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

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

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

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

See:
Parameters:
Name Type Attributes Description
user module:model/user~User
callback commonCallback <optional>
<nullable>
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(openChannelParams, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
openChannelParams module:model/params/openChannelParams~OpenChannelParams
callback openChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

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

Deprecated:
  • Yes
Parameters:
Name Type Attributes Description
name string
coverUrlOrImage string | File
data string
operatorUserIds Array.<string> | string
callback openChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

updateChannel(name, coverUrlOrImage, data, operatorUserIds, customType, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
name string
coverUrlOrImage string | File
data string
operatorUserIds Array.<string> | string
customType string
callback openChannelCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

updateChannelWithOperatorUserIds(name, coverUrlOrImageFile, data, operatorUserIds, customType, callbackopt, nullable) → {Promise|undefined}

Parameters:
Name Type Attributes Description
name string
coverUrlOrImageFile string | File
data string
operatorUserIds Array.<string> | string
customType string
callback openChannelCallback <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