Package io.getstream.chat.java.models

Class User

java.lang.Object

io.getstream.chat.java.models.User

public class User
extends 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 User.UserBanRequestData.UserBanRequest	ban()	Creates a ban request
static User.UserCreateGuestRequestData.UserCreateGuestRequest	createGuest()	Creates a create guest request
static String	createToken(String apiSecret, String userId, Date expiresAt, Date issuedAt)
static String	createToken(String userId, Date expiresAt, Date issuedAt)
static User.UserDeactivateRequestData.UserDeactivateRequest	deactivate(String userId)	Creates a deactivate request
static User.UserDeleteRequest	delete(String userId)	Creates a delete request
static User.UserDeleteManyRequestData.UserDeleteManyRequest	deleteMany(List<String> userIds)	Create many users deletion request
static User.UserExportRequest	export(String userId)	Creates an export request
static Flag.FlagCreateRequestData.FlagCreateRequest	flag(String userId)	Creates a flag request
Map<String,Object>	getAdditionalFields()
static User.UserListRequestData.UserListRequest	list()	Creates a query request
static User.UserMuteRequestData.UserMuteRequest	mute()	Creates a mute request
static User.UserPartialUpdateRequestData.UserPartialUpdateRequest	partialUpdate()	Creates a partial update request
static User.UserQueryBannedRequestData.UserQueryBannedRequest	queryBanned()	Creates a query banned request
static User.UserReactivateRequestData.UserReactivateRequest	reactivate(String userId)	Creates a reactivate request
static User.UserUnbanRequest	removeShadowBan(String targetUserId)	Creates a remove shadow ban request
static User.UserRevokeTokensRequest	revokeToken(String userId, Date revokeTokensIssuedBefore)	Creates a revoke token request
static User.UserRevokeTokensRequest	revokeTokens(List<String> userIds, Date revokeTokensIssuedBefore)	Creates a revoke token request
void	setAdditionalField(String name, Object value)
static User.UserBanRequestData.UserBanRequest	shadowBan()	Creates a shadow ban request
static User.UserUnbanRequest	unban(String targetUserId)	Creates an unban request
static Flag.FlagDeleteRequestData.FlagDeleteRequest	unflag(String userId)	Creates an unflag request
static User.UserUnmuteRequestData.UserUnmuteRequest	unmute()	Creates an unmute request
static 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 Details

User

public User()

Method Details

getAdditionalFields

public Map<String,Object> getAdditionalFields()

setAdditionalField

public void setAdditionalField(String name,
 Object value)

list

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

Creates a query request

Returns:

the created request

upsert

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

Creates an upsert request

Returns:

the created request

partialUpdate

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

Creates a partial update request

Returns:

the created request

ban

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

Creates a ban request

Returns:

the created request

shadowBan

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

Creates a shadow ban request

Returns:

the created request

queryBanned

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

Creates a query banned request

Returns:

the created request

deactivate

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

Creates a deactivate request

Parameters:

userId - the user id to deactivate

Returns:

the created request

delete

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

Creates a delete request

Parameters:

userId - the user id to delete

Returns:

the created request

deleteMany

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

Create many users deletion request

Parameters:

userIds - list of user ids to be deleted

Returns:

the created request

reactivate

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

Creates a reactivate request

Parameters:

userId - the user id to reactivate

Returns:

the created request

flag

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

Creates a flag request

Parameters:

userId - the user id to flag

Returns:

the created request

unflag

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

Creates an unflag request

Parameters:

userId - the user id to unflag

Returns:

the created request

mute

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

Creates a mute request

Returns:

the created request

unmute

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

Creates an unmute request

Returns:

the created request

export

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

Creates an export request

Parameters:

userId - the user id to export

Returns:

the created request

createGuest

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

Creates a create guest request

Returns:

the created request

unban

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

Creates an unban request

Parameters:

targetUserId - the user id to unban

Returns:

the created request

removeShadowBan

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

Creates a remove shadow ban request

Parameters:

targetUserId - the user id to unban

Returns:

the created request

revokeToken

@NotNull
public static User.UserRevokeTokensRequest revokeToken(@NotNull
 String userId,
 @Nullable
 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 User.UserRevokeTokensRequest revokeTokens(@NotNull
 List<String> userIds,
 @Nullable
 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 String createToken(@NotNull
 String userId,
 @Nullable
 Date expiresAt,
 @Nullable
 Date issuedAt)

createToken

@NotNull
public static String createToken(@NotNull
 String apiSecret,
 @NotNull
 String userId,
 @Nullable
 Date expiresAt,
 @Nullable
 Date issuedAt)