KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

Overview

Signature

Remarks

Members

Member Details

KiiPushMessageData Class

Represent data to be delivered to each device. It contains a JSON object whose field represents key-value pairs of message's payload. Note that, if the data intended to deliver to GCM devices, key can not be a reserved word listed bellow:

Syntax

public class KiiPushMessageData

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Members

See Also: Inherited members from object.

Public Constructors

 Initializes a new instance of the KiiCorp.Cloud.Storage.KiiPushMessageData class.

Protected Fields

Public Methods

 Put (string, bool) : KiiPushMessageData
Put Bool value to the data.
Put (string, double) : KiiPushMessageData
Put Double value to the data.
Put (string, int) : KiiPushMessageData
Put Int value to the data.
Put (string, long) : KiiPushMessageData
Put Long value to the data.
Put (string, string) : KiiPushMessageData
Put String value to the data.
ToJsonObject () : JsonOrg.JsonObject
Obtain JSONObject representation of the Data. Operation for returned object won't affect this object.

Protected Methods

 IsValidKey (string) : bool
Determines whether this instance is valid key the specified key.

Member Details

KiiPushMessageData Constructor

Initializes a new instance of the KiiCorp.Cloud.Storage.KiiPushMessageData class.

Syntax

public KiiPushMessageData ()

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

IsValidKey Method

Determines whether this instance is valid key the specified key.

Syntax

protected virtual bool IsValidKey (string key)

Parameters

key
Key.

Returns

true if this instance is valid key the specified key; otherwise, false.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

mData Field

The data.

Syntax

protected JsonOrg.JsonObject mData

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Put Method

Put Bool value to the data.

Syntax

public virtual KiiPushMessageData Put (string key, bool value)

Parameters

key
When the same value specified, overwrite existing value.
value
Bool value.

Returns

This instance.

Exceptions

Type Reason
ArgumentException Is thrown when the specified key is null or empty.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Put Method

Put Double value to the data.

Syntax

public virtual KiiPushMessageData Put (string key, double value)

Parameters

key
When the same value specified, overwrite existing value.
value
Double value.

Returns

This instance.

Exceptions

Type Reason
ArgumentException Is thrown when the specified key is null or empty.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Put Method

Put Int value to the data.

Syntax

public virtual KiiPushMessageData Put (string key, int value)

Parameters

key
When the same value specified, overwrite existing value.
value
Int value.

Returns

This instance.

Exceptions

Type Reason
ArgumentException Is thrown when the specified key is null or empty.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Put Method

Put Long value to the data.

Syntax

public virtual KiiPushMessageData Put (string key, long value)

Parameters

key
When the same value specified, overwrite existing value.
value
Long value.

Returns

This instance.

Exceptions

Type Reason
ArgumentException Is thrown when the specified key is null or empty.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Put Method

Put String value to the data.

Syntax

public virtual KiiPushMessageData Put (string key, string value)

Parameters

key
When the same value specified, overwrite existing value.
value
String value.

Returns

This instance.

Exceptions

Type Reason
ArgumentException Is thrown when the specified key is null or empty.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

ToJsonObject Method

Obtain JSONObject representation of the Data. Operation for returned object won't affect this object.

Syntax

public JsonOrg.JsonObject ToJsonObject ()

Returns

JsonObject represents the data.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0