Package com.kii.cloud.storage
Class PushToAppMessage
- java.lang.Object
-
- com.kii.cloud.storage.ReceivedMessage
-
- com.kii.cloud.storage.PushToAppMessage
-
public class PushToAppMessage extends com.kii.cloud.storage.ReceivedMessage
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsKiiBucket()
Checks whether the push message contains KiiBucket or not.boolean
containsKiiObject()
Checks whether the push message contains KiiObject or not.KiiGroup
getEventSourceGroup()
The payloads can contain the subscribed bucket/topic informations including the scope.KiiThing
getEventSourceThing()
The payloads can contain the subscribed bucket/topic informations including the scope.KiiUser
getEventSourceUser()
The payloads can contain the subscribed bucket/topic informations including the scope.KiiBucket
getKiiBucket()
Generate KiiBucket based on the information parsed from push message.KiiObject
getKiiObject()
Generate KiiObject based on the information parsed from push message.PushMessageBundleHelper.MessageType
pushMessageType()
Return the push message type.
-
-
-
Method Detail
-
getEventSourceGroup
@Nullable public KiiGroup getEventSourceGroup()
The payloads can contain the subscribed bucket/topic informations including the scope. This API provides convenience methods to obtainKiiGroup
if the payload contains group scoped bucket/topic information.- Returns:
KiiGroup
instance when the subscribed bucket/topic is group scope. In other cases returns null.
-
getEventSourceUser
@Nullable public KiiUser getEventSourceUser()
The payloads can contain the subscribed bucket/topic informations including the scope. This API provides convenience methods to obtainKiiUser
if the payload contains user scoped bucket/topic information.- Returns:
KiiUser
instance when the subscribed bucket/topic is user scope. In other cases returns null.
-
getEventSourceThing
@Nullable public KiiThing getEventSourceThing()
The payloads can contain the subscribed bucket/topic informations including the scope. This API provides convenience methods to obtainKiiThing
if the payload contains thing scoped bucket/topic information.- Returns:
KiiThing
instance when the subscribed bucket/topic is thing scope. In other cases returns null.
-
getKiiBucket
@Nullable public KiiBucket getKiiBucket()
Generate KiiBucket based on the information parsed from push message.- Returns:
- KiiBucket instance when the event of KiiBucket or KiiObject inside KiiBucket happened. In other cases returns null.
- See Also:
containsKiiBucket()
-
getKiiObject
@Nullable public KiiObject getKiiObject()
Generate KiiObject based on the information parsed from push message.- Returns:
- KiiObject instance when the event of KiiObject inside KiiBucekt happened. In other cases returns null.
- See Also:
containsKiiBucket()
,containsKiiObject()
-
containsKiiObject
public boolean containsKiiObject()
Checks whether the push message contains KiiObject or not.- Returns:
- true if the push message contains KiiObject, otherwise false.
-
containsKiiBucket
public boolean containsKiiBucket()
Checks whether the push message contains KiiBucket or not.- Returns:
- true if the push message contains KiiBucket, otherwise false.
-
pushMessageType
@NonNull public PushMessageBundleHelper.MessageType pushMessageType()
Return the push message type.- Specified by:
pushMessageType
in classcom.kii.cloud.storage.ReceivedMessage
- Returns:
PushMessageBundleHelper.MessageType
-
-