Package com.pubnub.api.services

Interface PresenceService

  • public interface PresenceService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<Envelope<com.google.gson.JsonElement>> getState​(java.lang.String subKey, java.lang.String channel, java.lang.String uuid, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope<com.google.gson.JsonElement>> globalHereNow​(java.lang.String subKey, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope> heartbeat​(java.lang.String subKey, java.lang.String channel, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope<com.google.gson.JsonElement>> hereNow​(java.lang.String subKey, java.lang.String channel, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope> leave​(java.lang.String subKey, java.lang.String channel, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope<com.google.gson.JsonElement>> setState​(java.lang.String subKey, java.lang.String channel, java.lang.String uuid, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<Envelope<WhereNowPayload>> whereNow​(java.lang.String subKey, java.lang.String uuid, java.util.Map<java.lang.String,​java.lang.String> options)  

    • Method Detail

      • leave

        @GET("v2/presence/sub-key/{subKey}/channel/{channel}/leave")
retrofit2.Call<Envelope> leave​(@Path("subKey")
                               java.lang.String subKey,
                               @Path("channel")
                               java.lang.String channel,
                               @QueryMap
                               java.util.Map<java.lang.String,​java.lang.String> options)

      • heartbeat

        @GET("v2/presence/sub-key/{subKey}/channel/{channel}/heartbeat")
retrofit2.Call<Envelope> heartbeat​(@Path("subKey")
                                   java.lang.String subKey,
                                   @Path("channel")
                                   java.lang.String channel,
                                   @QueryMap(encoded=true)
                                   java.util.Map<java.lang.String,​java.lang.String> options)

      • whereNow

        @GET("v2/presence/sub-key/{subKey}/uuid/{uuid}")
retrofit2.Call<Envelope<WhereNowPayload>> whereNow​(@Path("subKey")
                                                   java.lang.String subKey,
                                                   @Path("uuid")
                                                   java.lang.String uuid,
                                                   @QueryMap
                                                   java.util.Map<java.lang.String,​java.lang.String> options)

      • globalHereNow

        @GET("v2/presence/sub_key/{subKey}")
retrofit2.Call<Envelope<com.google.gson.JsonElement>> globalHereNow​(@Path("subKey")
                                                                    java.lang.String subKey,
                                                                    @QueryMap
                                                                    java.util.Map<java.lang.String,​java.lang.String> options)

      • hereNow

        @GET("v2/presence/sub_key/{subKey}/channel/{channel}")
retrofit2.Call<Envelope<com.google.gson.JsonElement>> hereNow​(@Path("subKey")
                                                              java.lang.String subKey,
                                                              @Path("channel")
                                                              java.lang.String channel,
                                                              @QueryMap
                                                              java.util.Map<java.lang.String,​java.lang.String> options)

      • getState

        @GET("v2/presence/sub-key/{subKey}/channel/{channel}/uuid/{uuid}")
retrofit2.Call<Envelope<com.google.gson.JsonElement>> getState​(@Path("subKey")
                                                               java.lang.String subKey,
                                                               @Path("channel")
                                                               java.lang.String channel,
                                                               @Path("uuid")
                                                               java.lang.String uuid,
                                                               @QueryMap
                                                               java.util.Map<java.lang.String,​java.lang.String> options)

      • setState

        @GET("v2/presence/sub-key/{subKey}/channel/{channel}/uuid/{uuid}/data")
retrofit2.Call<Envelope<com.google.gson.JsonElement>> setState​(@Path("subKey")
                                                               java.lang.String subKey,
                                                               @Path("channel")
                                                               java.lang.String channel,
                                                               @Path("uuid")
                                                               java.lang.String uuid,
                                                               @QueryMap(encoded=true)
                                                               java.util.Map<java.lang.String,​java.lang.String> options)