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
protected boolean	canEqual(java.lang.Object other)
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
boolean	equals(java.lang.Object o)
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()
@Nullable java.lang.Integer	getAvgResponseTime()
@Nullable java.lang.String	getBanExpires()
@Nullable java.lang.Boolean	getBanned()
@Nullable java.util.List<java.lang.String>	getBlockedUserIDs()
@Nullable java.util.List<User.ChannelMute>	getChannelMutes()
@Nullable java.util.Date	getCreatedAt()
@Nullable java.util.Date	getDeactivatedAt()
@Nullable java.util.Date	getDeletedAt()
@NotNull java.lang.String	getId()
@Nullable java.lang.String	getImage()
@NotNull java.lang.Boolean	getInvisible()
@Nullable Language	getLanguage()
@Nullable java.util.Date	getLastActive()
@Nullable java.util.List<User.Mute>	getMutes()
@Nullable java.lang.String	getName()
@NotNull java.lang.Boolean	getOnline()
@NotNull java.lang.String	getRole()
@Nullable java.lang.Boolean	getShadowBanned()
@NotNull java.util.List<java.lang.String>	getTeams()
java.util.Map<java.lang.String,java.lang.String>	getTeamsRole()
@Nullable java.util.Date	getUpdatedAt()
int	hashCode()
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)
void	setAdditionalFields(@NotNull java.util.Map<java.lang.String,java.lang.Object> additionalFields)
void	setAvgResponseTime(@Nullable java.lang.Integer avgResponseTime)
void	setBanExpires(@Nullable java.lang.String banExpires)
void	setBanned(@Nullable java.lang.Boolean banned)
void	setBlockedUserIDs(@Nullable java.util.List<java.lang.String> blockedUserIDs)
void	setChannelMutes(@Nullable java.util.List<User.ChannelMute> channelMutes)
void	setCreatedAt(@Nullable java.util.Date createdAt)
void	setDeactivatedAt(@Nullable java.util.Date deactivatedAt)
void	setDeletedAt(@Nullable java.util.Date deletedAt)
void	setId(@NotNull java.lang.String id)
void	setImage(@Nullable java.lang.String image)
void	setInvisible(@NotNull java.lang.Boolean invisible)
void	setLanguage(@Nullable Language language)
void	setLastActive(@Nullable java.util.Date lastActive)
void	setMutes(@Nullable java.util.List<User.Mute> mutes)
void	setName(@Nullable java.lang.String name)
void	setOnline(@NotNull java.lang.Boolean online)
void	setRole(@NotNull java.lang.String role)
void	setShadowBanned(@Nullable java.lang.Boolean shadowBanned)
void	setTeams(@NotNull java.util.List<java.lang.String> teams)
void	setTeamsRole(java.util.Map<java.lang.String,java.lang.String> teamsRole)
void	setUpdatedAt(@Nullable java.util.Date updatedAt)
static @NotNull User.UserBanRequestData.UserBanRequest	shadowBan()	Creates a shadow ban request
java.lang.String	toString()
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, finalize, getClass, notify, notifyAll, 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)

getId

@NotNull
public @NotNull java.lang.String getId()

getName

@Nullable
public @Nullable java.lang.String getName()

getImage

@Nullable
public @Nullable java.lang.String getImage()

getRole

@NotNull
public @NotNull java.lang.String getRole()

getTeams

@NotNull
public @NotNull java.util.List<java.lang.String> getTeams()

getTeamsRole

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

getOnline

@NotNull
public @NotNull java.lang.Boolean getOnline()

getInvisible

@NotNull
public @NotNull java.lang.Boolean getInvisible()

getCreatedAt

@Nullable
public @Nullable java.util.Date getCreatedAt()

getUpdatedAt

@Nullable
public @Nullable java.util.Date getUpdatedAt()

getLastActive

@Nullable
public @Nullable java.util.Date getLastActive()

getDeletedAt

@Nullable
public @Nullable java.util.Date getDeletedAt()

getDeactivatedAt

@Nullable
public @Nullable java.util.Date getDeactivatedAt()

getBanned

@Nullable
public @Nullable java.lang.Boolean getBanned()

getBanExpires

@Nullable
public @Nullable java.lang.String getBanExpires()

getShadowBanned

@Nullable
public @Nullable java.lang.Boolean getShadowBanned()

getLanguage

@Nullable
public @Nullable Language getLanguage()

getMutes

@Nullable
public @Nullable java.util.List<User.Mute> getMutes()

getChannelMutes

@Nullable
public @Nullable java.util.List<User.ChannelMute> getChannelMutes()

getBlockedUserIDs

@Nullable
public @Nullable java.util.List<java.lang.String> getBlockedUserIDs()

getAvgResponseTime

@Nullable
public @Nullable java.lang.Integer getAvgResponseTime()

setId

public void setId(@NotNull
                  @NotNull java.lang.String id)

setName

public void setName(@Nullable
                    @Nullable java.lang.String name)

setImage

public void setImage(@Nullable
                     @Nullable java.lang.String image)

setRole

public void setRole(@NotNull
                    @NotNull java.lang.String role)

setTeams

public void setTeams(@NotNull
                     @NotNull java.util.List<java.lang.String> teams)

setTeamsRole

public void setTeamsRole(java.util.Map<java.lang.String,java.lang.String> teamsRole)

setOnline

public void setOnline(@NotNull
                      @NotNull java.lang.Boolean online)

setInvisible

public void setInvisible(@NotNull
                         @NotNull java.lang.Boolean invisible)

setCreatedAt

public void setCreatedAt(@Nullable
                         @Nullable java.util.Date createdAt)

setUpdatedAt

public void setUpdatedAt(@Nullable
                         @Nullable java.util.Date updatedAt)

setLastActive

public void setLastActive(@Nullable
                          @Nullable java.util.Date lastActive)

setDeletedAt

public void setDeletedAt(@Nullable
                         @Nullable java.util.Date deletedAt)

setDeactivatedAt

public void setDeactivatedAt(@Nullable
                             @Nullable java.util.Date deactivatedAt)

setBanned

public void setBanned(@Nullable
                      @Nullable java.lang.Boolean banned)

setBanExpires

public void setBanExpires(@Nullable
                          @Nullable java.lang.String banExpires)

setShadowBanned

public void setShadowBanned(@Nullable
                            @Nullable java.lang.Boolean shadowBanned)

setLanguage

public void setLanguage(@Nullable
                        @Nullable Language language)

setMutes

public void setMutes(@Nullable
                     @Nullable java.util.List<User.Mute> mutes)

setChannelMutes

public void setChannelMutes(@Nullable
                            @Nullable java.util.List<User.ChannelMute> channelMutes)

setAdditionalFields

public void setAdditionalFields(@NotNull
                                @NotNull java.util.Map<java.lang.String,java.lang.Object> additionalFields)

setBlockedUserIDs

public void setBlockedUserIDs(@Nullable
                              @Nullable java.util.List<java.lang.String> blockedUserIDs)

setAvgResponseTime

public void setAvgResponseTime(@Nullable
                               @Nullable java.lang.Integer avgResponseTime)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object