Builder of the message.
See Also: Inherited members from object.
|
Build
()Build and return KiiPushMessage. |
|
|
EnableAPNS
(bool)Set flag of APNS delivery If omit calling this method, APNS delivery is enabled. Overwrite APNS delivery flag in the JSON message if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithAPNSMessage(APNSMessage) |
|
|
EnableGCM
(bool)Set flag of GCM delivery If omit calling this method, GCM delivery is enabled. Overwrite the GCM delivery flag in the message JSON if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithGCMMessage(GCMMessage) method, GCM delivery flag will be |
|
|
EnableMqtt
(bool)Set flag of MQTT delivery If omit calling this method, MQTT delivery is enabled. Overwrite the MQTT delivery flag in the message JSON if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithMqttMessage(MqttMessage) method, MQTT delivery flag will be |
|
|
SendAppID
(bool)Flags indicates whether "appId" field will be send or not. |
|
|
SendObjectScope
(bool)Flags indicates whether "objectScope" field will be send or not. |
|
|
SendOrigin
(bool)Flags indicates whether "sendOrigin" field will be send or not. |
|
|
SendSender
(bool)Flags indicates whether "sender" field will be send or not. |
|
|
SendToDevelopment
(bool)Flag indicates whether send to Development installations or not. Development installations are instantiated by calling KiiUser.PushInstallation(bool) with true. If omit calling this method, default value is true. |
|
|
SendTopicId
(bool)Flags indicates whether "topicID" field will be send or not. |
|
|
SendToProduction
(bool)Flag indicates whether send to Production installations or not. Production installations are instantiated by calling KiiUser.PushInstallation or KiiUser.PushInstallation(bool) with false. If omit calling this method, default value is true. |
|
|
SendWhen
(bool)Flags indicates whether "when" field will be send or not. |
|
|
WithAPNSMessage
(APNSMessage)Build with APNS specific message that will be delivered through APNS. Override the APNS delivery flag if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.EnableAPNS(bool) |
|
|
WithGCMMessage
(GCMMessage)Build with GCM specific message that will be delivered through GCM. Override the GCM delivery flag if already set by KiiCorp.Cloud.Storage.GCMMessage |
|
|
WithMqttMessage
(MqttMessage)Build with MQTT specific message that will be delivered through MQTT. Override the MQTT delivery flag if already set by KiiCorp.Cloud.Storage.MqttMessage |
|
|
WithPushMessageType
(string)Set the message type field with the provided value. |
Build and return KiiPushMessage.Syntax
public KiiPushMessage Build ()Returns
KiiPushMessageRemarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Set flag of APNS delivery If omit calling this method, APNS delivery is enabled. Overwrite APNS delivery flag in the JSON message if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithAPNSMessage(APNSMessage)Syntax
public KiiPushMessage.Builder EnableAPNS (bool apnsEnabled)Parameters
- apnsEnabled
- if true message would be delivered via APNS. If false, this message would not delivered thru APNS.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Set flag of GCM delivery If omit calling this method, GCM delivery is enabled. Overwrite the GCM delivery flag in the message JSON if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithGCMMessage(GCMMessage) method, GCM delivery flag will beSyntax
public KiiPushMessage.Builder EnableGCM (bool gcmEnabled)Parameters
- gcmEnabled
- if true message would be delivered via GCM. If false, this message would not delivered thru GCM.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Set flag of MQTT delivery If omit calling this method, MQTT delivery is enabled. Overwrite the MQTT delivery flag in the message JSON if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.WithMqttMessage(MqttMessage) method, MQTT delivery flag will beSyntax
public KiiPushMessage.Builder EnableMqtt (bool mqttEnabled)Parameters
- mqttEnabled
- if true message would be delivered via MQTT. If false, this message would not delivered thru MQTT.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "appId" field will be send or not.Syntax
public KiiPushMessage.Builder SendAppID (bool isSendAppId)Parameters
- isSendAppId
- If true, the appID field will also be sent. Default is false.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "objectScope" field will be send or not.Syntax
public KiiPushMessage.Builder SendObjectScope (bool sendObjectScope)Parameters
- sendObjectScope
- If true, send the “objectScope”-related fields that contain the topic that is the source of this notification. Default is true.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "sendOrigin" field will be send or not.Syntax
public KiiPushMessage.Builder SendOrigin (bool sendOrigin)Parameters
- sendOrigin
- If true, send the “origin” field that indicates if the message is the result of an event or sended explicitly by someone. Default is false.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "sender" field will be send or not.Syntax
public KiiPushMessage.Builder SendSender (bool sendSender)Parameters
- sendSender
- If true, send the “sender” field which is userID of the user that triggered the notification. Default is true.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flag indicates whether send to Development installations or not. Development installations are instantiated by calling KiiUser.PushInstallation(bool) with true. If omit calling this method, default value is true.Syntax
public KiiPushMessage.Builder SendToDevelopment (bool sendToDevelopment)Parameters
- sendToDevelopment
- If set to true send to development.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "topicID" field will be send or not.Syntax
public KiiPushMessage.Builder SendTopicId (bool sendTopicId)Parameters
- sendTopicId
- If true, send the “topicID” field, which contains the topicID that is the source of this notification. Default is true.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flag indicates whether send to Production installations or not. Production installations are instantiated by calling KiiUser.PushInstallation or KiiUser.PushInstallation(bool) with false. If omit calling this method, default value is true.Syntax
public KiiPushMessage.Builder SendToProduction (bool sendToProduction)Parameters
- sendToProduction
- If set to true send to production.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Flags indicates whether "when" field will be send or not.Syntax
public KiiPushMessage.Builder SendWhen (bool sendWhen)Parameters
- sendWhen
- If true, send the “when” field which denotes the time of push message was sent. Default is false.
Returns
Builder of the message.Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Build with APNS specific message that will be delivered through APNS. Override the APNS delivery flag if already set by KiiCorp.Cloud.Storage.KiiPushMessage.Builder.EnableAPNS(bool)Syntax
public KiiPushMessage.Builder WithAPNSMessage (APNSMessage message)Parameters
- message
- Message.
Returns
Builder of the message.Exceptions
Type Reason ArgumentNullException Is thrown when an argument is null. Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Build with GCM specific message that will be delivered through GCM. Override the GCM delivery flag if already set by KiiCorp.Cloud.Storage.GCMMessageSyntax
public KiiPushMessage.Builder WithGCMMessage (GCMMessage message)Parameters
- message
- Message.
Returns
Builder of the message.Exceptions
Type Reason ArgumentNullException Is thrown when an argument is null. Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Build with MQTT specific message that will be delivered through MQTT. Override the MQTT delivery flag if already set by KiiCorp.Cloud.Storage.MqttMessageSyntax
public KiiPushMessage.Builder WithMqttMessage (MqttMessage message)Parameters
- message
- Message.
Returns
Builder of the message.Exceptions
Type Reason ArgumentNullException Is thrown when an argument is null. Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0
Set the message type field with the provided value.Syntax
public KiiPushMessage.Builder WithPushMessageType (string pushMessageType)Parameters
- pushMessageType
- Type of the push message.
Returns
Builder of the message.Exceptions
Type Reason ArgumentNullException Is thrown when an argument is null. Remarks
Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0