Package io.getstream.chat.java.models

Class User

java.lang.Object

io.getstream.chat.java.models.User

public class User
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	User.Ban
static class	User.ChannelMute
static class	User.ChannelMuteRequestObject
static class	User.Mute
static class	User.OwnUser
static class	User.OwnUserRequestObject
static class	User.UserBanRequestData
static class	User.UserCreateGuestRequestData
static class	User.UserCreateGuestResponse
static class	User.UserDeactivateRequestData
static class	User.UserDeactivateResponse
static class	User.UserDeleteManyRequestData
static class	User.UserDeleteManyResponse
static class	User.UserDeleteRequest
static class	User.UserDeleteResponse
static class	User.UserExportRequest
static class	User.UserExportResponse
static class	User.UserListRequestData
static class	User.UserListResponse
static class	User.UserMute
static class	User.UserMuteRequestData
static class	User.UserMuteRequestObject
static class	User.UserMuteResponse
static class	User.UserPartialUpdateRequestData
static class	User.UserPartialUpdateRequestObject
static class	User.UserPartialUpdateResponse
static class	User.UserQueryBannedRequestData
static class	User.UserQueryBannedResponse
static class	User.UserReactivateRequestData
static class	User.UserReactivateResponse
static class	User.UserRequestObject
static class	User.UserRevokeTokensRequest
static class	User.UserUnbanRequest
static class	User.UserUnmuteRequestData
static class	User.UserUpsertRequestData
static class	User.UserUpsertResponse

Constructor Summary

Constructors

Constructor	Description
User()

Method Summary

Modifier and Type	Method	Description
static @NotNull User.UserBanRequestData.UserBanRequest	ban()	Creates a ban request
static @NotNull User.UserCreateGuestRequestData.UserCreateGuestRequest	createGuest()	Creates a create guest request
static @NotNull java.lang.String	createToken(@NotNull java.lang.String apiSecret, @NotNull java.lang.String userId, @Nullable java.util.Date expiresAt, @Nullable java.util.Date issuedAt)
static @NotNull java.lang.String	createToken(@NotNull java.lang.String userId, @Nullable java.util.Date expiresAt, @Nullable java.util.Date issuedAt)
static @NotNull User.UserDeactivateRequestData.UserDeactivateRequest	deactivate(@NotNull java.lang.String userId)	Creates a deactivate request
static @NotNull User.UserDeleteRequest	delete(@NotNull java.lang.String userId)	Creates a delete request
static @NotNull User.UserDeleteManyRequestData.UserDeleteManyRequest	deleteMany(@NotNull java.util.List<java.lang.String> userIds)	Create many users deletion request
static @NotNull User.UserExportRequest	export(@NotNull java.lang.String userId)	Creates an export request
static @NotNull Flag.FlagCreateRequestData.FlagCreateRequest	flag(@NotNull java.lang.String userId)	Creates a flag request
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalFields()
static @NotNull User.UserListRequestData.UserListRequest	list()	Creates a query request
static @NotNull User.UserMuteRequestData.UserMuteRequest	mute()	Creates a mute request
static @NotNull User.UserPartialUpdateRequestData.UserPartialUpdateRequest	partialUpdate()	Creates a partial update request
static @NotNull User.UserQueryBannedRequestData.UserQueryBannedRequest	queryBanned()	Creates a query banned request
static @NotNull User.UserReactivateRequestData.UserReactivateRequest	reactivate(@NotNull java.lang.String userId)	Creates a reactivate request
static @NotNull User.UserUnbanRequest	removeShadowBan(@NotNull java.lang.String targetUserId)	Creates a remove shadow ban request
static @NotNull User.UserRevokeTokensRequest	revokeToken(@NotNull java.lang.String userId, @Nullable java.util.Date revokeTokensIssuedBefore)	Creates a revoke token request
static @NotNull User.UserRevokeTokensRequest	revokeTokens(@NotNull java.util.List<java.lang.String> userIds, @Nullable java.util.Date revokeTokensIssuedBefore)	Creates a revoke token request
void	setAdditionalField(java.lang.String name, java.lang.Object value)
static @NotNull User.UserBanRequestData.UserBanRequest	shadowBan()	Creates a shadow ban request
static @NotNull User.UserUnbanRequest	unban(@NotNull java.lang.String targetUserId)	Creates an unban request
static @NotNull Flag.FlagDeleteRequestData.FlagDeleteRequest	unflag(@NotNull java.lang.String userId)	Creates an unflag request
static @NotNull User.UserUnmuteRequestData.UserUnmuteRequest	unmute()	Creates an unmute request
static @NotNull User.UserUpsertRequestData.UserUpsertRequest	upsert()	Creates an upsert request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

getAdditionalFields

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalFields()

setAdditionalField

public void setAdditionalField(java.lang.String name,
                               java.lang.Object value)

list

@NotNull
public static @NotNull User.UserListRequestData.UserListRequest list()

Creates a query request

Returns:

the created request

upsert

@NotNull
public static @NotNull User.UserUpsertRequestData.UserUpsertRequest upsert()

Creates an upsert request

Returns:

the created request

partialUpdate

@NotNull
public static @NotNull User.UserPartialUpdateRequestData.UserPartialUpdateRequest partialUpdate()

Creates a partial update request

Returns:

the created request

ban

@NotNull
public static @NotNull User.UserBanRequestData.UserBanRequest ban()

Creates a ban request

Returns:

the created request

shadowBan

@NotNull
public static @NotNull User.UserBanRequestData.UserBanRequest shadowBan()

Creates a shadow ban request

Returns:

the created request

queryBanned

@NotNull
public static @NotNull User.UserQueryBannedRequestData.UserQueryBannedRequest queryBanned()

Creates a query banned request

Returns:

the created request

deactivate

@NotNull
public static @NotNull User.UserDeactivateRequestData.UserDeactivateRequest deactivate(@NotNull
                                                                                       @NotNull java.lang.String userId)

Creates a deactivate request

Parameters:

userId - the user id to deactivate

Returns:

the created request

delete

@NotNull
public static @NotNull User.UserDeleteRequest delete(@NotNull
                                                     @NotNull java.lang.String userId)

Creates a delete request

Parameters:

userId - the user id to delete

Returns:

the created request

deleteMany

@NotNull
public static @NotNull User.UserDeleteManyRequestData.UserDeleteManyRequest deleteMany(@NotNull
                                                                                       @NotNull java.util.List<java.lang.String> userIds)

Create many users deletion request

Parameters:

userIds - list of user ids to be deleted

Returns:

the created request

reactivate

@NotNull
public static @NotNull User.UserReactivateRequestData.UserReactivateRequest reactivate(@NotNull
                                                                                       @NotNull java.lang.String userId)

Creates a reactivate request

Parameters:

userId - the user id to reactivate

Returns:

the created request

flag

@NotNull
public static @NotNull Flag.FlagCreateRequestData.FlagCreateRequest flag(@NotNull
                                                                         @NotNull java.lang.String userId)

Creates a flag request

Parameters:

userId - the user id to flag

Returns:

the created request

unflag

@NotNull
public static @NotNull Flag.FlagDeleteRequestData.FlagDeleteRequest unflag(@NotNull
                                                                           @NotNull java.lang.String userId)

Creates an unflag request

Parameters:

userId - the user id to unflag

Returns:

the created request

mute

@NotNull
public static @NotNull User.UserMuteRequestData.UserMuteRequest mute()

Creates a mute request

Returns:

the created request

unmute

@NotNull
public static @NotNull User.UserUnmuteRequestData.UserUnmuteRequest unmute()

Creates an unmute request

Returns:

the created request

export

@NotNull
public static @NotNull User.UserExportRequest export(@NotNull
                                                     @NotNull java.lang.String userId)

Creates an export request

Parameters:

userId - the user id to export

Returns:

the created request

createGuest

@NotNull
public static @NotNull User.UserCreateGuestRequestData.UserCreateGuestRequest createGuest()

Creates a create guest request

Returns:

the created request

unban

@NotNull
public static @NotNull User.UserUnbanRequest unban(@NotNull
                                                   @NotNull java.lang.String targetUserId)

Creates an unban request

Parameters:

targetUserId - the user id to unban

Returns:

the created request

removeShadowBan

@NotNull
public static @NotNull User.UserUnbanRequest removeShadowBan(@NotNull
                                                             @NotNull java.lang.String targetUserId)

Creates a remove shadow ban request

Parameters:

targetUserId - the user id to unban

Returns:

the created request

revokeToken

@NotNull
public static @NotNull User.UserRevokeTokensRequest revokeToken(@NotNull
                                                                @NotNull java.lang.String userId,
                                                                @Nullable
                                                                @Nullable java.util.Date revokeTokensIssuedBefore)

Creates a revoke token request

Parameters:

userId - the user id to revoke token for

revokeTokensIssuedBefore - the limit date to revoke tokens

Returns:

the created request

revokeTokens

@NotNull
public static @NotNull User.UserRevokeTokensRequest revokeTokens(@NotNull
                                                                 @NotNull java.util.List<java.lang.String> userIds,
                                                                 @Nullable
                                                                 @Nullable java.util.Date revokeTokensIssuedBefore)

Creates a revoke token request

Parameters:

userIds - the user ids to revoke token for

revokeTokensIssuedBefore - the limit date to revoke tokens

Returns:

the created request

createToken

@NotNull
public static @NotNull java.lang.String createToken(@NotNull
                                                    @NotNull java.lang.String userId,
                                                    @Nullable
                                                    @Nullable java.util.Date expiresAt,
                                                    @Nullable
                                                    @Nullable java.util.Date issuedAt)

createToken

@NotNull
public static @NotNull java.lang.String createToken(@NotNull
                                                    @NotNull java.lang.String apiSecret,
                                                    @NotNull
                                                    @NotNull java.lang.String userId,
                                                    @Nullable
                                                    @Nullable java.util.Date expiresAt,
                                                    @Nullable
                                                    @Nullable java.util.Date issuedAt)