KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

Overview

Signature

Remarks

Members

Member Details

ReceivedMessage Class

Represents push message.

Syntax

public abstract class ReceivedMessage

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 Properties

[read-only]
 ActionIdentifier string . Return the action identifier given by APNS plugin callback. Always null for GCM push.
[read-only]
 ObjectScope Nullable<ReceivedMessage.Scope> . Return the scope of the object to which the event is occurred.
[read-only]
abstract
PushMessageType ReceivedMessage.MessageType . Return the push message type.
[read-only]
 Sender KiiUser . Return the user who causes the notification.

Public Methods

 GetBoolean (string) : bool
Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
GetDouble (string) : double
Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
GetInt (string) : int
Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
GetLong (string) : long
Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
GetString (string) : string
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Has (string) : bool
Returns true if this object has a mapping for given key.
static
Parse (string) : ReceivedMessage
Parse the json that is received from GCM or APNS server as push message.
ToJson () : JsonOrg.JsonObject
Get JSONObjcet representation of this message.

Member Details

ActionIdentifier Property

Return the action identifier given by APNS plugin callback. Always null for GCM push.

Syntax

public string ActionIdentifier { get; }

Value

The APNS action identifier.

Remarks

Requirements

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

GetBoolean Method

Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.

Syntax

public bool GetBoolean (string key)

Parameters

key
a string key.

Returns

a boolean value.

Remarks

Requirements

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

GetDouble Method

Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.

Syntax

public double GetDouble (string key)

Parameters

key
a string key.

Returns

a double value.

Remarks

Requirements

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

GetInt Method

Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.

Syntax

public int GetInt (string key)

Parameters

key
a string key.

Returns

a int value.

Remarks

Requirements

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

GetLong Method

Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.

Syntax

public long GetLong (string key)

Parameters

key
a string key.

Returns

a long value.

Remarks

Requirements

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

GetString Method

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Syntax

public string GetString (string key)

Parameters

key
a string key.

Returns

a string value.

Remarks

Requirements

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

Has Method

Returns true if this object has a mapping for given key.

Syntax

public bool Has (string key)

Parameters

key
a string key.

Returns

true if this instance has key; otherwise, false.

Remarks

Requirements

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

ObjectScope Property

Return the scope of the object to which the event is occurred.

Syntax

public Nullable<ReceivedMessage.Scope> ObjectScope { get; }

Value

The object scope.

Remarks

Requirements

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

Parse Method

Parse the json that is received from GCM or APNS server as push message.

Syntax

public static ReceivedMessage Parse (string json)

Parameters

json
message json.

Returns

Instance of KiiCorp.Cloud.Storage.ReceivedMessage

Remarks

Requirements

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

PushMessageType Property

Return the push message type.

Syntax

public abstract ReceivedMessage.MessageType PushMessageType { get; }

Value

The type of the push message.

Remarks

Requirements

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

Sender Property

Return the user who causes the notification.

Syntax

public virtual KiiUser Sender { get; }

Value

The sender.

Remarks

Requirements

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

ToJson Method

Get JSONObjcet representation of this message.

Syntax

public JsonOrg.JsonObject ToJson ()

Returns

Represents this message.

Remarks

Requirements

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