ScheduledUserMessage

ScheduledUserMessage

Class representing scheduled user message

Constructor

new ScheduledUserMessage(jsonObjectopt)

Parameters:
Name Type Attributes Description
jsonObject Object <optional>

Members

(static) Status

Properties:
Name Type Description
SCHEDULED string

"scheduled"
SENT string

"sent"
CANCELED string

"canceled"
FAILED string

"failed"

String enum object for describing type of the scheduled user message status

appleCriticalAlertOptions :module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

Default Value:
  • null

Push notification options for Apple critical alert.

Type:
  • module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

channelUrl :string

Default Value:
  • ""
Type:
  • string

createdAt :number

Default Value:
  • 0
Type:
  • number

customType :string

Default Value:
  • ""
Type:
  • string

data :string

Default Value:
  • ""
Type:
  • string

errorCode :number

Default Value:
  • 0
Type:
  • number

errorMessage :string

Default Value:
  • ""
Type:
  • string

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

Default Value:
  • []
Type:
  • Array.<module:model/user~User>

mentionType :string

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

message :string

Default Value:
  • ""
Type:
  • string

metaArray :Object

Deprecated:
  • Yes
Type:
  • Object

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

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

pushNotificationDeliveryOption :string

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

scheduledDateTimeString :string

Default Value:
  • ""
Type:
  • string

scheduledId :number

Default Value:
  • 0
Type:
  • number

scheduledTimezone :string

Default Value:
  • ""
Type:
  • string

sender :module:model/user~User

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

status :string

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

translationTargetLanguages :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

updatedAt :number

Default Value:
  • 0
Type:
  • number

Methods

isGroupChannel() → {boolean}

Returns:
Type
boolean

isOpenChannel() → {boolean}

Returns:
Type
boolean