com.pubnub.api.services

Interface UserService

public interface UserService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<EntityEnvelope<PNUser>>	createUser(java.lang.String subKey, java.lang.Object body, java.util.Map<java.lang.String,java.lang.String> options)
retrofit2.Call<EntityEnvelope<com.google.gson.JsonElement>>	deleteUser(java.lang.String subKey, java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> options)
retrofit2.Call<EntityEnvelope<PNUser>>	getUser(java.lang.String subKey, java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> options)
retrofit2.Call<EntityArrayEnvelope<PNUser>>	getUsers(java.lang.String subKey, java.util.Map<java.lang.String,java.lang.String> options)
retrofit2.Call<EntityEnvelope<PNUser>>	updateUser(java.lang.String subKey, java.lang.String userId, java.lang.Object body, java.util.Map<java.lang.String,java.lang.String> options)

Method Detail

getUsers

@GET(value="v1/objects/{subKey}/users")
retrofit2.Call<EntityArrayEnvelope<PNUser>> getUsers(@Path(value="subKey")
                                                                                             java.lang.String subKey,
                                                                                             @QueryMap(encoded=true)
                                                                                             java.util.Map<java.lang.String,java.lang.String> options)

getUser

@GET(value="v1/objects/{subKey}/users/{userId}")
retrofit2.Call<EntityEnvelope<PNUser>> getUser(@Path(value="subKey")
                                                                                                java.lang.String subKey,
                                                                                                @Path(value="userId")
                                                                                                java.lang.String userId,
                                                                                                @QueryMap(encoded=true)
                                                                                                java.util.Map<java.lang.String,java.lang.String> options)

createUser

@POST(value="v1/objects/{subKey}/users")
 @Headers(value="Content-Type: application/json; charset=UTF-8")
retrofit2.Call<EntityEnvelope<PNUser>> createUser(@Path(value="subKey")
                                                                                                                                                            java.lang.String subKey,
                                                                                                                                                            @Body
                                                                                                                                                            java.lang.Object body,
                                                                                                                                                            @QueryMap(encoded=true)
                                                                                                                                                            java.util.Map<java.lang.String,java.lang.String> options)

updateUser

@PATCH(value="v1/objects/{subKey}/users/{userId}")
 @Headers(value="Content-Type: application/json; charset=UTF-8")
retrofit2.Call<EntityEnvelope<PNUser>> updateUser(@Path(value="subKey")
                                                                                                                                                                      java.lang.String subKey,
                                                                                                                                                                      @Path(value="userId")
                                                                                                                                                                      java.lang.String userId,
                                                                                                                                                                      @Body
                                                                                                                                                                      java.lang.Object body,
                                                                                                                                                                      @QueryMap(encoded=true)
                                                                                                                                                                      java.util.Map<java.lang.String,java.lang.String> options)

deleteUser

@DELETE(value="v1/objects/{subKey}/users/{userId}")
retrofit2.Call<EntityEnvelope<com.google.gson.JsonElement>> deleteUser(@Path(value="subKey")
                                                                                                                           java.lang.String subKey,
                                                                                                                           @Path(value="userId")
                                                                                                                           java.lang.String userId,
                                                                                                                           @QueryMap(encoded=true)
                                                                                                                           java.util.Map<java.lang.String,java.lang.String> options)