KiiMessageField Constants Reference
Declared in | KiiReceivedMessage.h |
KiiMessageField
Enumeration of KiiMessageField that represents KiiCloud specific fields.
KiiMessageField list is as follows:
Key | Short key | Push to App | Push to User | Direct Push | Description | Possible values |
---|---|---|---|---|---|---|
KiiMessage_APP_ID | a | - | - (Depends on “sendAppID”) |
- | Source app which generated the notification. | |
KiiMessage_SENDER | s | - | X (Depends on “sendSender”) |
X (Depends on “sendSender”) |
The user or thing who caused the notification. | |
KiiMessage_ORIGIN | o | - | - (Depends on “sendOrigin”) |
- (Depends on “sendOrigin”) |
Origin of push. “EVENT” for “Push to App” notification. “EXPLICIT” for “Push to User” and “Direct Push” notification. | - EVENT - EXPLICIT |
KiiMessage_WHEN | w | X | - (Depends on “sendWhen”) |
- (Depends on “sendWhen”) |
The timestamp of the notification in milliseconds. (Since January 1, 1970 00:00:00 UTC) | |
KiiMessage_TYPE | t | X | - (Depends on “pushMessageType”) |
- (Depends on “pushMessageType”) |
The type of notification and the additional data. | [Push to App] - DATA_OBJECT_CREATED - DATA_OBJECT_DELETED - DATA_OBJECT_UPDATED - DATA_OBJECT_BODY_UPDATED - DATA_OBJECT_BODY_DELETED - DATA_OBJECT_ACL_MODIFIED - BUCKET_DELETED |
KiiMessage_TOPIC | to | - | X (Depends on “sendTopicID”) |
- | TopicID that is the source of this notification. TopicID is only for “Push to User” push messages. | |
KiiMessage_SCOPE_APP_ID | sa | X | X (Depends on “sendObjectScope”) |
- | AppID of topic/object scope. | |
KiiMessage_SCOPE_USER_ID | su | X | X (Depends on “sendObjectScope”) |
- | UserID of topic/topic/object scope. Push message has this field only if the subscribed bucket/topic is user scope. | |
KiiMessage_SCOPE_GROUP_ID | sg | X | X (Depends on “sendObjectScope”) |
- | GroupID of topic/object scope. Push message has this field only if the subscribed bucket/topic is group scope. | |
KiiMessage_SCOPE_THING_ID | sth | X | X (Depends on “sendObjectScope”) |
- | ThingID of topic/object scope. Push message has this field only if the subscribed bucket/topic is thing scope. | |
KiiMessage_SCOPE_TYPE | st | X | X (Depends on “sendObjectScope”) |
- | Type of topic/object scope. | - APP - APP_AND_USER - APP_AND_GROUP - APP_AND_THING |
KiiMessage_BUCKET_ID | bi | X | - | - | Bucket name of push subscribed. | |
KiiMessage_BUCKET_TYPE | bt | X | - | - | Type of source bucket. | - rw - sync |
KiiMessage_OBJECT_ID | oi | X | - | - | ID of the object operated. | |
KiiMessage_OBJECT_MODIFIED_AT | om | - | - | - | Timestamp of the modification of object in milliseconds. (Since January 1, 1970 00:00:00 UTC) | - DATA_OBJECT_CREATED - DATA_OBJECT_UPDATED - DATA_OBJECT_BODY_UPDATE |
Definition
typedef NS_ENUM(NSUInteger, KiiMessageField ) {
KiiMessage_APP_ID,
KiiMessage_SENDER,
KiiMessage_TYPE,
KiiMessage_WHEN,
KiiMessage_ORIGIN,
KiiMessage_TOPIC,
KiiMessage_SCOPE_APP_ID,
KiiMessage_SCOPE_USER_ID,
KiiMessage_SCOPE_GROUP_ID,
KiiMessage_SCOPE_TYPE,
KiiMessage_BUCKET_ID,
KiiMessage_BUCKET_TYPE,
KiiMessage_OBJECT_ID,
KiiMessage_OBJECT_MODIFIED_AT,
KiiMessage_SCOPE_THING_ID,
};
Constants
KiiMessage_APP_ID
-
Source app which generated the notification.
Declared In
KiiReceivedMessage.h
. KiiMessage_SENDER
-
The user who caused the notification.
Declared In
KiiReceivedMessage.h
. KiiMessage_TYPE
-
The type of notification and the additional data.
Declared In
KiiReceivedMessage.h
. KiiMessage_WHEN
-
The timestamp of the notification in milliseconds. (Since January 1, 1970 00:00:00 UTC)
Declared In
KiiReceivedMessage.h
. KiiMessage_ORIGIN
-
Origin of push. “EVENT” for “Push to App” notification. “EXPLICIT” for “Push to User” and “Direct Push” notification.
Declared In
KiiReceivedMessage.h
. KiiMessage_TOPIC
-
TopicID that is the source of this notification. TopicID is only for “Push to User” push messages.
Declared In
KiiReceivedMessage.h
. KiiMessage_SCOPE_APP_ID
-
AppID of topic/object scope.
Declared In
KiiReceivedMessage.h
. KiiMessage_SCOPE_USER_ID
-
UserID of topic/object scope. Push message has this field only if the subscribed bucket/topic is user scope.
Declared In
KiiReceivedMessage.h
. KiiMessage_SCOPE_GROUP_ID
-
GroupID of topic/object scope. Push message has this field only if the subscribed bucket/topic is group scope.
Declared In
KiiReceivedMessage.h
. KiiMessage_SCOPE_TYPE
-
Type of topic/object scope.
Declared In
KiiReceivedMessage.h
. KiiMessage_BUCKET_ID
-
Bucket name of push subscribed.
Declared In
KiiReceivedMessage.h
. KiiMessage_BUCKET_TYPE
-
Type of source bucket.
Declared In
KiiReceivedMessage.h
. KiiMessage_OBJECT_ID
-
ID of the object operated.
Declared In
KiiReceivedMessage.h
. KiiMessage_OBJECT_MODIFIED_AT
-
Timestamp of the modification of object in milliseconds. (Since January 1, 1970 00:00:00 UTC)
Declared In
KiiReceivedMessage.h
. KiiMessage_SCOPE_THING_ID
-
ThingID of topic/object scope. Push message has this field only if the subscribed bucket/topic is thing scope.
Declared In
KiiReceivedMessage.h
.
Declared In
KiiReceivedMessage.h