KiiPushMessageBuilder | kii-cloud-sdk

Builder of push message

Hierarchy

KiiPushMessageBuilder

Constructors

constructor

new KiiPushMessageBuilder(data: any): KiiPushMessageBuilder

- Defined in src/topic.ts:236
instantiate builder with push message data. By default all push channels (gcm, apns, jpush, mqtt) is enabled. All other properties configured by method of this class won't be set and default value would be applied. Details of properties of message and its default value, please refer to http://documentation.kii.com/rest/#notification_management-leverage__push_to_users__notification-group_scope-send_messages-send_a_push_message_to_the_current_topic

Parameters
- data: any
  
  sent to all push channels (gcm, apns, jpush, mqtt).
Returns KiiPushMessageBuilder

Methods

apnsAlert

apnsAlert(alert: any): KiiPushMessageBuilder

- Defined in src/topic.ts:412
Set alert for APNS subscribers. If this method is not called, no alert is applied. For details please refer to APNS document of alert.

Parameters
- alert: any
  
  alert object
Returns KiiPushMessageBuilder
builder instance.

apnsBadge

apnsBadge(badge: number): KiiPushMessageBuilder

- Defined in src/topic.ts:436
Set badge for APNS subscribers. If this method is not called, no badge is applied. For details please refer to APNS document of badge.

Parameters
- badge: number
Returns KiiPushMessageBuilder
builder instance.

apnsCategory

apnsCategory(category: string): KiiPushMessageBuilder

- Defined in src/topic.ts:466
Set category for APNS subscribers. If this method is not called, no category is applied. For details please refer to APNS document of category.

Parameters
- category: string
Returns KiiPushMessageBuilder
builder instance.

apnsContentAvailable

apnsContentAvailable(contentAvailable: number): KiiPushMessageBuilder

- Defined in src/topic.ts:450
Set content-available for APNS subscribers. If this method is not called, no content-available is applied.

Parameters
- contentAvailable: number
  
  If eqaul or less than 0 or this method is not invoked, content-available payload is not delivered. Otherwise, content-available=1 payload is delivered.
Returns KiiPushMessageBuilder
builder instance.

apnsData

apnsData(data: any): KiiPushMessageBuilder

- Defined in src/topic.ts:400
Set specific data for APNS subscribers. If this method is not called, no specific data is not applied and data passed to the constructor would be sent to subscribers.

Parameters
- data: any
  
  specific data applied to only APNS subscribers. Contents should be JSON Object with only one-level of nesting, and only strings, integers, booleans or doubles in the values.
Returns KiiPushMessageBuilder
builder instance.

apnsMutableContent

apnsMutableContent(mutableContent: number): KiiPushMessageBuilder

- Defined in src/topic.ts:480
Set mutable-content for APNS subscribers. If this method is not called, no mutable-content is applied.

Parameters
- mutableContent: number
  
  If equal or less than 0 or this method is not invoked, mutable-content payload is not delivered. Otherwise, mutable-content=1 payload is delivered.
Returns KiiPushMessageBuilder
builder instance.

apnsSound

apnsSound(sound: string): KiiPushMessageBuilder

- Defined in src/topic.ts:424
Set sound for APNS subscribers. If this method is not called, no sound is applied. For details please refer to APNS document of sound.

Parameters
- sound: string
Returns KiiPushMessageBuilder
builder instance.

build

build(): any

- Defined in src/topic.ts:244
build push message.

Returns any
push message object. Can be used in KiiTopic.sendMessage

enableApns

enableApns(enable: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:300
Enable/ Disable message distribution via APNS. If this method is not called, true will be applied as default.

Parameters
- enable: boolean
  
  flag indicate whether distribute this message to APNS subscribers.
Returns KiiPushMessageBuilder
builder instance.

enableGcm

enableGcm(enable: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:289
Enable/ Disable message distribution via GCM. If this method is not called, true will be applied as default.

Parameters
- enable: boolean
  
  flag indicate whether distribute this message to GCM subscribers.
Returns KiiPushMessageBuilder
builder instance.

enableJpush

enableJpush(enable: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:311
Enable/ Disable message distribution via JPush. If this method is not called, true will be applied as default.

Parameters
- enable: boolean
  
  flag indicate whether distribute this message to JPush subscribers.
Returns KiiPushMessageBuilder
builder instance.

enableMqtt

enableMqtt(enable: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:322
Enable/ Disable message distribution via MQTT. If this method is not called, true will be applied as default.

Parameters
- enable: boolean
  
  flag indicate whether distribute this message to MQTT subscribers.
Returns KiiPushMessageBuilder
builder instance.

gcmCollapseKey

gcmCollapseKey(collapseKey: string): KiiPushMessageBuilder

- Defined in src/topic.ts:348
Set collapse_key for GCM subscribers. If this method is not called, no collapse_key is applied. For details please refer to GCM document of collapse_key.

Parameters
- collapseKey: string
Returns KiiPushMessageBuilder
builder instance.

gcmData

gcmData(data: any): KiiPushMessageBuilder

- Defined in src/topic.ts:336
Set specific data for GCM subscribers. If this method is not called, no specific data is not applied and data passed to the constructor would be sent to subscribers.

Parameters
- data: any
  
  specific data applied to only GCM subscribers. Contents should be JSON Object with only one-level of nesting, and only strings in values
Returns KiiPushMessageBuilder
builder instance.

gcmDelayWhileIdle

gcmDelayWhileIdle(delayWhileIdle: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:360
Set delay_while_idle for GCM subscribers. If this method is not called, no delay_while_idle is applied. For details please refer to GCM document of delay_while_idle.

Parameters
- delayWhileIdle: boolean
Returns KiiPushMessageBuilder
builder instance.

gcmRestrictedPackageName

gcmRestrictedPackageName(restrictedPackageName: string): KiiPushMessageBuilder

- Defined in src/topic.ts:384
Set restricted_package_name for GCM subscribers. If this method is not called, no restricted_package_name is applied. For details please refer to GCM document of restricted_package_name.

Parameters
- restrictedPackageName: string
Returns KiiPushMessageBuilder
builder instance.

gcmTimeToLive

gcmTimeToLive(timeToLive: number): KiiPushMessageBuilder

- Defined in src/topic.ts:372
Set time_to_live for GCM subscribers. If this method is not called, no time_to_live is applied. For details please refer to GCM document of time_to_live.

Parameters
- timeToLive: number
Returns KiiPushMessageBuilder
builder instance.

jpushData

jpushData(data: any): KiiPushMessageBuilder

- Defined in src/topic.ts:498
Set specific data for JPush subscribers. If this method is not called, no specific data is not applied and data passed to the constructor would be sent to subscribers.

Parameters
- data: any
  
  specific data applied to only JPush subscribers. Contents should be JSON Object with only one-level of nesting, and only strings, integers, booleans or doubles in the values.
Returns KiiPushMessageBuilder
builder instance.

mqttData

mqttData(data: any): KiiPushMessageBuilder

- Defined in src/topic.ts:512
Set specific data for MQTT subscribers. If this method is not called, no specific data is not applied and data passed to the constructor would be sent to subscribers.

Parameters
- data: any
  
  specific data applied to only MQTT subscribers. Contents should be JSON Object with only one-level of nesting, and only strings in the values.
Returns KiiPushMessageBuilder
builder instance.

setSendToDevelopment

setSendToDevelopment(flag: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:267
Indicate whether send this message to development environment. If this method is not called, true will be applied as default.

Parameters
- flag: boolean
  
  indicate whether send this message to development env.
Returns KiiPushMessageBuilder
builder instance.

setSendToProduction

setSendToProduction(flag: boolean): KiiPushMessageBuilder

- Defined in src/topic.ts:278
Indicate whether send this message to production environment. If this method is not called, true will be applied as default.

Parameters
- flag: boolean
  
  indicate whether send this message to production env.
Returns KiiPushMessageBuilder
builder instance.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

data: any

Returns KiiPushMessageBuilder

Methods

apnsAlert

Parameters

alert: any

Returns KiiPushMessageBuilder

apnsBadge

Parameters

badge: number

Returns KiiPushMessageBuilder

apnsCategory

Parameters

category: string

Returns KiiPushMessageBuilder

apnsContentAvailable

Parameters

contentAvailable: number

Returns KiiPushMessageBuilder

apnsData

Parameters

data: any

Returns KiiPushMessageBuilder

apnsMutableContent

Parameters

mutableContent: number

Returns KiiPushMessageBuilder

apnsSound

Parameters

sound: string

Returns KiiPushMessageBuilder

build

Returns any

enableApns

Parameters

enable: boolean

Returns KiiPushMessageBuilder

enableGcm

Parameters

enable: boolean

Returns KiiPushMessageBuilder

enableJpush

Parameters

enable: boolean

Returns KiiPushMessageBuilder

enableMqtt

Parameters

enable: boolean

Returns KiiPushMessageBuilder

gcmCollapseKey

Parameters

collapseKey: string

Returns KiiPushMessageBuilder

gcmData

Parameters

data: any

Returns KiiPushMessageBuilder

gcmDelayWhileIdle

Parameters

delayWhileIdle: boolean

Returns KiiPushMessageBuilder

gcmRestrictedPackageName

Parameters

restrictedPackageName: string

Returns KiiPushMessageBuilder

gcmTimeToLive

Parameters

timeToLive: number

Returns KiiPushMessageBuilder

jpushData

Parameters

data: any

Returns KiiPushMessageBuilder