BaseMessageParams

BaseMessageParams

Parameter class for building message objects. Classes UserMessageParams and FileMessageParams are derived from this class.

Constructor

new BaseMessageParams()

Members

(static) MentionType

Properties:
Name Type Description
USERS string

"users"
CHANNEL string

"channel"

String enum object for describing type of mentioning users

(static) PushNotificationDeliveryOption

Properties:
Name Type Description
DEFAULT string

"default"
SUPPRESS string

"suppress"

String enum object for describing push notification delivery option

appleCriticalAlertOptions :module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

Default Value:
  • null

Push notification options for Apple critical alert.

Type:
  • module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

(nullable) customType :string

Default Value:
  • null
Type:
  • string

(nullable) data :string

Default Value:
  • null
Type:
  • string

isReplyToChannel :boolean

Default Value:
  • false
Type:
  • boolean

(nullable) mentionedMessageTemplate :string

Default Value:
  • null
Type:
  • string

mentionedUserIds :Array.<string>

Type:
  • Array.<string>

mentionedUsers :Array.<module:model/user~User>

Type:
  • Array.<module:model/user~User>

mentionType :string

One of BaseMessageParams.MentionType

Type:
  • string

metaArrayKeys :Array.<string>

Deprecated:
  • since version v3.0.122, please use metaArrays instead
Default Value:
  • []

DEPRECATED

Type:
  • Array.<string>

metaArrays :Array.<module:model/messageMetaArray~MessageMetaArray>

Default Value:
  • []
Type:
  • Array.<module:model/messageMetaArray~MessageMetaArray>

(nullable) parentMessageId :number

Default Value:
  • null

Unique identifier of a parent message

Type:
  • number

(nullable) pushNotificationDeliveryOption :string

Default Value:
  • null

One of BaseMessageParams.PushNotificationDeliveryOption

Type:
  • string