KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

PushToAppMessage Class

A "Push to App" notification mechanism will let your application know that there were some changes on object(s) in a bucket. By leveraging this notification feature, your application can quickly fetch the changes that occur on the server-side.

Syntax

public class PushToAppMessage : ReceivedMessage

Remarks

Requirements

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

Members

See Also: Inherited members from ReceivedMessage.

Public Properties

[read-only]
ActionIdentifier string . Return the action identifier given by APNS plugin callback. Always null for GCM push. (Inherited from ReceivedMessage.)
[read-only]
KiiBucket KiiBucket . Generate KiiBucket based on the information parsed from push message.
[read-only]
KiiObject KiiObject . Generate KiiObject based on the information parsed from push message.
[read-only]
ObjectScope Nullable<ReceivedMessage.Scope> . Return the scope of the object to which the event is occurred. (Inherited from ReceivedMessage.)
[read-only]
ObjectScopeGroup KiiGroup . Return the group that the bucket generated notification belongs to. Push message has this field only if the bucket is group scoped.
[read-only]
ObjectScopeUser KiiUser . Return the user that the bucket generated notification belongs to. Push message has this field only if the subscribed bucket is user scoped.
[read-only]
override
PushMessageType ReceivedMessage.MessageType . Return the push message type.
[read-only]
abstract
PushMessageType ReceivedMessage.MessageType . Return the push message type. (Inherited from ReceivedMessage.)
[read-only]
Sender KiiUser . Return the user who causes the notification. (Inherited from ReceivedMessage.)

Public Methods

ContainsKiiBucket () : bool
Checks whether the push message contains KiiBucket or not.
ContainsKiiObject () : bool
Checks whether the push message contains KiiObject or not.
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. (Inherited from ReceivedMessage.)
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. (Inherited from ReceivedMessage.)
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. (Inherited from ReceivedMessage.)
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. (Inherited from ReceivedMessage.)
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. (Inherited from ReceivedMessage.)
Has (string) : bool
Returns true if this object has a mapping for given key. (Inherited from ReceivedMessage.)
ToJson () : JsonOrg.JsonObject
Get JSONObjcet representation of this message. (Inherited from ReceivedMessage.)

Member Details

ContainsKiiBucket Method

Checks whether the push message contains KiiBucket or not.

Syntax

public bool ContainsKiiBucket ()

Returns

true if the push message contains KiiBucket, otherwise false.

Remarks

Requirements

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

ContainsKiiObject Method

Checks whether the push message contains KiiObject or not.

Syntax

public bool ContainsKiiObject ()

Returns

true if the push message contains KiiObject, otherwise false.

Remarks

Requirements

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

KiiBucket Property

Generate KiiBucket based on the information parsed from push message.

Syntax

public KiiBucket KiiBucket { get; }

Value

Instance when the event of KiiBucket or KiiObject inside KiiBucekt happened. In other cases returns null.

Remarks

Requirements

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

KiiObject Property

Generate KiiObject based on the information parsed from push message.

Syntax

public KiiObject KiiObject { get; }

Value

Instance when the event of KiiObject inside KiiBucekt happened. In other cases returns null.

Remarks

Requirements

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

ObjectScopeGroup Property

Return the group that the bucket generated notification belongs to. Push message has this field only if the bucket is group scoped.

Syntax

public KiiGroup ObjectScopeGroup { get; }

Value

KiiGroup.

Remarks

Requirements

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

ObjectScopeUser Property

Return the user that the bucket generated notification belongs to. Push message has this field only if the subscribed bucket is user scoped.

Syntax

public KiiUser ObjectScopeUser { get; }

Value

KiiUser.

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 override 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