Package com.vortexsoftware.sdk.types

Class User

java.lang.Object

com.vortexsoftware.sdk.types.User

public class User
extends Object

User data for JWT generation Required fields: - id: User's unique identifier in your system - email: User's email address Optional fields: - name: User's display name (max 200 characters) - avatarUrl: User's avatar URL (must be HTTPS, max 2000 characters) - adminScopes: List of admin scopes (e.g., ["autojoin"]) Example:

 User user = new User("user-123", "user@example.com");
 user.setName("Jane Doe");
 user.setAvatarUrl("https://example.com/avatars/jane.jpg");
 user.setAdminScopes(Arrays.asList("autojoin"));
 

Constructor Summary

Constructors

Constructor	Description
User()	Default constructor for Jackson deserialization
User(String id, String email)	Create a new User with required fields
User(String id, String email, List<String> adminScopes)	Create a new User with all fields

Method Summary

Modifier and Type	Method	Description
List<String>	getAdminScopes()
String	getAvatarUrl()
String	getEmail()
String	getId()
String	getName()
void	setAdminScopes(List<String> adminScopes)
void	setAvatarUrl(String avatarUrl)
void	setEmail(String email)
void	setId(String id)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

User

public User()

Default constructor for Jackson deserialization

User

public User(String id,
 String email)

Create a new User with required fields

Parameters:

id - User's unique identifier

email - User's email address

User

public User(String id,
 String email,
 List<String> adminScopes)

Create a new User with all fields

Parameters:

id - User's unique identifier

email - User's email address

adminScopes - List of admin scopes (e.g., ["autojoin"])

Method Details

getId

public String getId()

setId

public void setId(String id)

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getAdminScopes

public List<String> getAdminScopes()

setAdminScopes

public void setAdminScopes(List<String> adminScopes)

getName

public String getName()

setName

public void setName(String name)

getAvatarUrl

public String getAvatarUrl()

setAvatarUrl

public void setAvatarUrl(String avatarUrl)

toString

public String toString()

Overrides:

toString in class Object