Package io.getstream.chat.java.services

Interface UserService

public interface UserService

Method Summary

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

Method Details

upsert

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

list

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

partialUpdate

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

queryBanned

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

ban

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

deactivate

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

delete

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

deleteMany

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

reactivate

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

mute

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

unmute

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

export

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

createGuest

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

unban

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