com.pubnub.api.endpoints.presence

Interface PresenceService

public interface PresenceService

Method Summary

Modifier and Type	Method and 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(value="v2/presence/sub-key/{subKey}/channel/{channel}/leave")
retrofit2.Call<Envelope> leave(@Path(value="subKey")
                                                                                                  java.lang.String subKey,
                                                                                                  @Path(value="channel")
                                                                                                  java.lang.String channel,
                                                                                                  @QueryMap
                                                                                                  java.util.Map<java.lang.String,java.lang.String> options)

heartbeat

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

whereNow

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

globalHereNow

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

hereNow

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

getState

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

setState

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