Package com.kii.cloud.storage

Class PushToUserMessage

  • public class PushToUserMessage
extends com.kii.cloud.storage.ReceivedMessage

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.kii.cloud.storage.ReceivedMessage

        com.kii.cloud.storage.ReceivedMessage.Scope

    • Method Detail

      • getKiiTopic

        @Nullable
public KiiTopic getKiiTopic()
        Generate KiiTopic based on the information parsed from push message.
        Returns:
        the topic instance in which a message is sent or null if containsKiiTopic() is false.
        See Also:
        containsKiiTopic()

      • containsKiiTopic

        public boolean containsKiiTopic()
        Checks whether push message contains KiiTopic or not.
        Returns:
        true if the push message contains topic. NOTE: Some configuration of field setting may cause this api to return false even if the message contains topic id. If either KiiPushMessage.Builder.sendObjectScope(boolean) or KiiPushMessage.Builder.sendTopicId(boolean) set to false It is not possible to instantiate KiiTopic so it will return false.

      • getEventSourceGroup

        @Nullable
public KiiGroup getEventSourceGroup()
        The payloads can contain the subscribed bucket/topic informations including the scope. This API provides convenience methods to obtain KiiGroup 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 obtain KiiUser 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 obtain KiiThing if the payload contains thing scoped bucket/topic information.
        Returns:
        KiiThing instance when the subscribed bucket/topic is user scope. In other cases returns null.