Package io.getstream.chat.java.services

Interface UserService

public interface UserService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<StreamResponseObject>	ban(@NotNull User.UserBanRequestData userBanRequestData)
retrofit2.Call<User.UserCreateGuestResponse>	createGuest(@NotNull User.UserCreateGuestRequestData userCreateGuestRequestData)
retrofit2.Call<User.UserDeactivateResponse>	deactivate(@NotNull java.lang.String userId, @NotNull User.UserDeactivateRequestData userDeactivateRequestData)
retrofit2.Call<User.UserDeleteResponse>	delete(@NotNull java.lang.String userId, @Nullable java.lang.Boolean markMessagesDeleted, @Nullable java.lang.Boolean hardDelete, @Nullable java.lang.Boolean deleteConversationChannels)
retrofit2.Call<User.UserDeleteManyResponse>	deleteMany(@NotNull User.UserDeleteManyRequestData data)
retrofit2.Call<User.UserExportResponse>	export(@NotNull java.lang.String userId)
retrofit2.Call<User.UserListResponse>	list(@NotNull User.UserListRequestData userListRequestData)
retrofit2.Call<User.UserMuteResponse>	mute(@NotNull User.UserMuteRequestData userMuteRequestData)
retrofit2.Call<User.UserPartialUpdateResponse>	partialUpdate(@NotNull User.UserPartialUpdateRequestData userPartialUpdateRequestData)
retrofit2.Call<User.UserQueryBannedResponse>	queryBanned(@NotNull User.UserQueryBannedRequestData userQueryBannedRequestData)
retrofit2.Call<User.UserReactivateResponse>	reactivate(@NotNull java.lang.String userId, @NotNull User.UserReactivateRequestData userReactivateRequestData)
retrofit2.Call<StreamResponseObject>	unban(@NotNull java.lang.String targetUserId, @Nullable java.lang.String channelType, @Nullable java.lang.String channelId, @Nullable java.lang.Boolean shadow)
retrofit2.Call<StreamResponseObject>	unmute(@NotNull User.UserUnmuteRequestData userUnmuteRequestData)
retrofit2.Call<User.UserUpsertResponse>	upsert(@NotNull User.UserUpsertRequestData userUpsertRequestData)

Method Detail

upsert

@POST("users")
retrofit2.Call<User.UserUpsertResponse> upsert(@NotNull @Body
                                               @NotNull User.UserUpsertRequestData userUpsertRequestData)

list

@GET("users")
retrofit2.Call<User.UserListResponse> list(@NotNull @Query("payload")
                                           @NotNull User.UserListRequestData userListRequestData)

partialUpdate

@PATCH("users")
retrofit2.Call<User.UserPartialUpdateResponse> partialUpdate(@NotNull @Body
                                                             @NotNull User.UserPartialUpdateRequestData userPartialUpdateRequestData)

queryBanned

@GET("query_banned_users")
retrofit2.Call<User.UserQueryBannedResponse> queryBanned(@NotNull @Query("payload")
                                                         @NotNull User.UserQueryBannedRequestData userQueryBannedRequestData)

ban

@POST("moderation/ban")
retrofit2.Call<StreamResponseObject> ban(@NotNull @Body
                                         @NotNull User.UserBanRequestData userBanRequestData)

deactivate

@POST("users/{user_id}/deactivate")
retrofit2.Call<User.UserDeactivateResponse> deactivate(@NotNull @Path("user_id")
                                                       @NotNull java.lang.String userId,
                                                       @NotNull @Body
                                                       @NotNull User.UserDeactivateRequestData userDeactivateRequestData)

delete

@DELETE("users/{user_id}")
retrofit2.Call<User.UserDeleteResponse> delete(@NotNull @Path("user_id")
                                               @NotNull java.lang.String userId,
                                               @Nullable @Query("mark_messages_deleted")
                                               @Nullable java.lang.Boolean markMessagesDeleted,
                                               @Nullable @Query("hard_delete")
                                               @Nullable java.lang.Boolean hardDelete,
                                               @Nullable @Query("delete_conversation_channels")
                                               @Nullable java.lang.Boolean deleteConversationChannels)

deleteMany

@POST("users/delete")
retrofit2.Call<User.UserDeleteManyResponse> deleteMany(@NotNull @Body
                                                       @NotNull User.UserDeleteManyRequestData data)

reactivate

@POST("users/{user_id}/reactivate")
retrofit2.Call<User.UserReactivateResponse> reactivate(@NotNull @Path("user_id")
                                                       @NotNull java.lang.String userId,
                                                       @NotNull @Body
                                                       @NotNull User.UserReactivateRequestData userReactivateRequestData)

mute

@POST("moderation/mute")
retrofit2.Call<User.UserMuteResponse> mute(@NotNull @Body
                                           @NotNull User.UserMuteRequestData userMuteRequestData)

unmute

@POST("moderation/unmute")
retrofit2.Call<StreamResponseObject> unmute(@NotNull @Body
                                            @NotNull User.UserUnmuteRequestData userUnmuteRequestData)

export

@GET("users/{user_id}/export")
retrofit2.Call<User.UserExportResponse> export(@NotNull @Path("user_id")
                                               @NotNull java.lang.String userId)

createGuest

@POST("guest")
retrofit2.Call<User.UserCreateGuestResponse> createGuest(@NotNull @Body
                                                         @NotNull User.UserCreateGuestRequestData userCreateGuestRequestData)

unban

@DELETE("moderation/ban")
retrofit2.Call<StreamResponseObject> unban(@NotNull @Query("target_user_id")
                                           @NotNull java.lang.String targetUserId,
                                           @Nullable @Query("type")
                                           @Nullable java.lang.String channelType,
                                           @Nullable @Query("id")
                                           @Nullable java.lang.String channelId,
                                           @Nullable @Query("shadow")
                                           @Nullable java.lang.Boolean shadow)