ScheduledUserMessageParams

ScheduledUserMessageParams

Parameter class for building scheduled user messages. Used by groupChannel.registerScheduledUserMessage

Constructor

new ScheduledUserMessageParams(jsonObjectopt)

Parameters:
Name Type Attributes Description
jsonObject Object <optional>

Extends

Members

appleCriticalAlertOptions :module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

Overrides:
Default Value:
  • null

Push notification options for Apple critical alert.

Type:
  • module:model/appleCriticalAlertOptions~AppleCriticalAlertOptions

(nullable) customType :string

Overrides:
Default Value:
  • null
Type:
  • string

(nullable) data :string

Overrides:
Default Value:
  • null
Type:
  • string

(nullable) day :number

Default Value:
  • null
Type:
  • number

(nullable) hour :number

Default Value:
  • null
Type:
  • number

isReplyToChannel :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

(nullable) mentionedMessageTemplate :string

Overrides:
Default Value:
  • null
Type:
  • string

mentionedUserIds :Array.<string>

Overrides:
Type:
  • Array.<string>

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

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

mentionType :string

Overrides:

One of BaseMessageParams.MentionType

Type:
  • string

(nullable) message :string

Overrides:
Default Value:
  • null
Type:
  • string

metaArrayKeys :Array.<string>

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

DEPRECATED

Type:
  • Array.<string>

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

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

(nullable) min :number

Default Value:
  • null
Type:
  • number

(nullable) month :number

Default Value:
  • null
Type:
  • number

(nullable) parentMessageId :number

Overrides:
Default Value:
  • null

Unique identifier of a parent message

Type:
  • number

(nullable) pollId :number

Overrides:
Default Value:
  • undefined
Properties:
Name Type Description
`number`:

link the poll
`null`:

unlink the poll
`undefined`:

ignore to change the poll state
Type:
  • number

(nullable) pushNotificationDeliveryOption :string

Overrides:
Default Value:
  • null

One of BaseMessageParams.PushNotificationDeliveryOption

Type:
  • string

(nullable) scheduledDateTimeString :string

Type:
  • string

targetLanguages :Array.<string>

Overrides:
Deprecated:
  • since version v3.0.84, please use translationTargetLanguages instead
Default Value:
  • []
Type:
  • Array.<string>

(nullable) timezone :string

Default Value:
  • null
Type:
  • string

translationTargetLanguages :Array.<string>

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

(nullable) year :number

Default Value:
  • null
Type:
  • number

Methods

serialize() → {Object}

Overrides:

Returns serialized object for the class instance.

Returns:
Type
Object

setSchedule(year, month, day, hour, min, timezone)

Parameters:
Name Type Description
year number
month number
day number
hour number
min number
timezone string