BaseChannel

BaseChannel

Represents a chat channel object which allows users to communicate. Following classes GroupChannel and OpenChannel are derived from this class.

Constructor

new BaseChannel(jsonObjectopt)

Parameters:
Name Type Attributes Description
jsonObject Object <optional>

Members

(static) CHANNEL_TYPE_BASE :string

Default Value:
  • "base"
Type:
  • string

(static) CHANNEL_TYPE_GROUP :string

Default Value:
  • "group"
Type:
  • string

(static) CHANNEL_TYPE_OPEN :string

Default Value:
  • "open"
Type:
  • string

(static) MessageTypeFilter

Properties:
Name Type Description
ALL string

""
USER string

"MESG"
FILE string

"FILE"
ADMIN string

"ADMM"

String enum object for describing type of message type filter

(static) ReportCategory

Properties:
Name Type Description
SPAM string

"spam"
HARASSING string

"harassing"
SUSPICIOUS string

"suspicious"
INAPPROPRIATE string

"inappropriate"

String enum object for describing type of report category

coverUrl :string

Default Value:
  • ""
Type:
  • string

createdAt :number

Default Value:
  • 0
Type:
  • number

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

Default Value:
  • null
Type:
  • module:model/user~User

(nullable) customType :string

Default Value:
  • null
Type:
  • string

(nullable) data :string

Default Value:
  • null
Type:
  • string

isEphemeral :boolean

Default Value:
  • false
Type:
  • boolean

isFrozen :boolean

Default Value:
  • false
Type:
  • boolean

name :string

Default Value:
  • ""
Type:
  • string

url :string

Default Value:
  • ""
Type:
  • string

Methods

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

See:

  • MessageMetaArray

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}

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

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

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

cancelUploadingFileMessage(reqId, callback) → {boolean}

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

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

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}

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

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

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

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

See:

  • MessageMetaArray

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}

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

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

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

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

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

createPollListQuery() → {module:model/query/pollListQuery~PollListQuery}

Returns:
Type
module:model/query/pollListQuery~PollListQuery

createPollVoterListQuery(pollId, optionId) → {module:model/query/pollVoterListQuery~PollVoterListQuery}

Parameters:
Name Type Description
pollId number
optionId number
Returns:
Type
module:model/query/pollVoterListQuery~PollVoterListQuery

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

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

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

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

deleteAllMetaCounters(callbackopt) → {Promise|undefined}

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

deleteAllMetaData(callbackopt) → {Promise|undefined}

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

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

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}

See:

  • MessageMetaArray

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}

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

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

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

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

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

getAllMetaCounters(callbackopt) → {Promise|undefined}

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

getAllMetaData(callbackopt) → {Promise|undefined}

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

getCachedMetaData() → {object}

Retrieve cached metadata of a channel.

Returns:
Type
object

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

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

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

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

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

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

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

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

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

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

getMessageChangeLogsByToken(callbackopt) → {Promise|undefined}

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

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

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

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

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}

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}

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}

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}

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

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

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

getMyMutedInfo(callbackopt) → {Promise|undefined}

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}

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

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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>
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

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

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

getNextMessagesByTimestamp(ts, isInclusive, nextResultSize, shouldReverse, messageType, customType, callbackopt, nullable) → {Promise|undefined}

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

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

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

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

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
*

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

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
callback messageListCallback <optional>
Returns:
Type
*

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

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
callback messageListCallback <optional>
Returns:
Type
*

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

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>
callback messageListCallback <optional>
Returns:
Type
*

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

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

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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>
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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>
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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>
callback messageListCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

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

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

isGroupChannel() → {boolean}

Returns:
Type
boolean

isOpenChannel() → {boolean}

Returns:
Type
boolean

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

See:

  • MessageMetaArray

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}

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

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

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

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

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}

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}

API to resend failed file messages

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

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

API to resend failed file messages

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

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

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}

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

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

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

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
customType string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, data, customType, thumbnailSizes, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
customType string
thumbnailSizes Array.<{maxWidth: number, maxHeight: number}>
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
customType string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, thumbnailSizes, callbackopt) → {module:model/fileMessage~FileMessage|null}

See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
customType string
thumbnailSizes Array.<{maxWidth: number, maxHeight: number}>
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

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

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

See:
Parameters:
Name Type Attributes Description
file File
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, data, customType, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
customType string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, data, customType, thumbnailSizes, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
data string
customType string
thumbnailSizes Array.<{maxWidth: number, maxHeight: number}>
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
customType string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, thumbnailSizes, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

See:
Parameters:
Name Type Attributes Description
file File
name string
type string
size number
data string
customType string
thumbnailSizes Array.<{maxWidth: number, maxHeight: number}>
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

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

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
data string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
data string
customType string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
name string
type string
size number
data string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, callbackopt) → {module:model/fileMessage~FileMessage|null}

See:
Parameters:
Name Type Attributes Description
file string
name string
type string
size number
data string
customType string
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
data string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, data, customType, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
data string
customType string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
name string
type string
size number
data string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

sendFileMessage(file, name, type, size, data, customType, progressHandler, callbackopt) → {module:model/fileMessage~FileMessage|null}

Deprecated:
  • Yes
See:
Parameters:
Name Type Attributes Description
file string
name string
type string
size number
data string
customType string
progressHandler fileProgressHandlerCallback
callback messageCallback <optional>
Returns:
  • pending message on successful request
Type
module:model/fileMessage~FileMessage | null

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

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}

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

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

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

sendUserMessage(message, data, customType, translationTargetLanguages, callbackopt) → {module:model/userMessage~UserMessage|null}

Parameters:
Name Type Attributes Description
message string
data string
customType string
translationTargetLanguages Array.<string>
callback messageCallback <optional>
Returns:
  • returns pending message on success
Type
module:model/userMessage~UserMessage | null

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

Deprecated:
  • Yes
Parameters:
Name Type Attributes Description
message string
data string
callback messageCallback <optional>
Returns:
  • returns pending message on success
Type
module:model/userMessage~UserMessage | null

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

Deprecated:
  • Yes
Parameters:
Name Type Attributes Description
message string
data string
customType string
callback messageCallback <optional>
Returns:
  • returns pending message on success
Type
module:model/userMessage~UserMessage | null

serialize() → {Object}

Returns:
Type
Object

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

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

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

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

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

See:
Parameters:
Name Type Attributes Description
messageId number
fileMessageParams module:model/params/fileMessageParams~FileMessageParams
callback messageCallback <optional>
Returns:
Type
Promise | undefined

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

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

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

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

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

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

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

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

updateUserMessage(messageId, userMessageParams, callbackopt) → {Promise|undefined}

See:
Parameters:
Name Type Attributes Description
messageId number
userMessageParams module:model/params/userMessageParams~UserMessageParams
callback messageCallback <optional>
Returns:
Type
Promise | undefined