Package com.smartsheet.api.models
Class UserModel
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<java.lang.Long>
-
- com.smartsheet.api.models.UserModel
-
- Direct Known Subclasses:
UserModelWithName,UserProfile
public abstract class UserModel extends IdentifiableModel<java.lang.Long>
-
-
Constructor Summary
Constructors Constructor Description UserModel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.BooleangetAdmin()Gets the admin flag which allows managing users and accounts.java.util.List<AlternateEmail>getAlternateEmails()Gets the list of alternateEmailsjava.lang.StringgetCompany()Gets the user's company namejava.util.DategetCustomWelcomeScreenViewed()Gets the customWelcomeScreenViewed datejava.lang.StringgetDepartment()Gets the user's departmentjava.lang.StringgetEmail()Gets the email address.java.lang.StringgetFirstName()Gets the first name.java.lang.BooleangetGroupAdmin()java.util.DategetLastLogin()Gets the lastLogin datejava.lang.StringgetLastName()Gets the last name.java.lang.BooleangetLicensedSheetCreator()Gets the licensed sheet creator flag that allows creating and owning sheets.java.lang.StringgetMobilePhone()Gets the user's mobile phone numberProfileImagegetProfileImage()Gets the user's profile imagejava.lang.BooleangetResourceViewer()java.lang.StringgetRole()Gets the user's rolejava.lang.IntegergetSheetCount()Gets the sheetCount.UserStatusgetStatus()Gets the status of the user (active, pending, declined).java.lang.StringgetTitle()Gets the user's titlejava.lang.StringgetWorkPhone()Gets the user's work phone numberUserModelsetAdmin(java.lang.Boolean admin)Sets the admin flag which allows managing users and accounts.UserModelsetAlternateEmails(java.util.List<AlternateEmail> alternateEmails)Sets the list of alternateEmailsUserModelsetCompany(java.lang.String company)Sets the user's company nameUserModelsetCustomWelcomeScreenViewed(java.util.Date customWelcomeScreenViewed)Sets the customWelcomeScreenViewed dateUserModelsetDepartment(java.lang.String department)Sets the user's departmentUserModelsetEmail(java.lang.String email)Sets the email address.UserModelsetFirstName(java.lang.String firstName)Sets the first name.UserModelsetGroupAdmin(java.lang.Boolean groupAdmin)UserModelsetLastLogin(java.util.Date lastLogin)Sets the lastLogin dateUserModelsetLastName(java.lang.String lastName)Sets the last name.UserModelsetLicensedSheetCreator(java.lang.Boolean licensedSheetCreator)Sets the licensed sheet creator flag that allows creating and owning sheets.UserModelsetMobilePhone(java.lang.String mobilePhone)Sets the user's mobile phone numberUserModelsetProfileImage(ProfileImage profileImage)Sets the user's profile imageUserModelsetResourceViewer(java.lang.Boolean resourceViewer)Sets the resource manager flag.UserModelsetRole(java.lang.String role)Sets the user's roleUserModelsetSheetCount(java.lang.Integer sheetCount)Sets the sheetCountUserModelsetStatus(UserStatus status)Sets the status of the user.UserModelsetTitle(java.lang.String title)Sets the user's titleUserModelsetWorkPhone(java.lang.String workPhone)Sets the user's work phone number-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
getEmail
public java.lang.String getEmail()
Gets the email address.- Returns:
- the email address
-
setEmail
public UserModel setEmail(java.lang.String email)
Sets the email address.- Parameters:
email- the new email address
-
getFirstName
public java.lang.String getFirstName()
Gets the first name.- Returns:
- the first name
-
setFirstName
public UserModel setFirstName(java.lang.String firstName)
Sets the first name.- Parameters:
firstName- the new first name
-
getLastName
public java.lang.String getLastName()
Gets the last name.- Returns:
- the last name
-
setLastName
public UserModel setLastName(java.lang.String lastName)
Sets the last name.- Parameters:
lastName- the new last name
-
getAdmin
public java.lang.Boolean getAdmin()
Gets the admin flag which allows managing users and accounts.- Returns:
- the admin
-
setAdmin
public UserModel setAdmin(java.lang.Boolean admin)
Sets the admin flag which allows managing users and accounts.- Parameters:
admin- the new admin
-
getLicensedSheetCreator
public java.lang.Boolean getLicensedSheetCreator()
Gets the licensed sheet creator flag that allows creating and owning sheets.- Returns:
- the licensed sheet creator
-
setLicensedSheetCreator
public UserModel setLicensedSheetCreator(java.lang.Boolean licensedSheetCreator)
Sets the licensed sheet creator flag that allows creating and owning sheets.- Parameters:
licensedSheetCreator- the new licensed sheet creator
-
getStatus
public UserStatus getStatus()
Gets the status of the user (active, pending, declined).- Returns:
- the status
-
setStatus
public UserModel setStatus(UserStatus status)
Sets the status of the user.- Parameters:
status- the new status
-
getResourceViewer
public java.lang.Boolean getResourceViewer()
- Returns:
- the flag indicating if someone is a resource manager
-
setResourceViewer
public UserModel setResourceViewer(java.lang.Boolean resourceViewer)
Sets the resource manager flag.- Parameters:
resourceViewer- the flag
-
getGroupAdmin
public java.lang.Boolean getGroupAdmin()
- Returns:
- the flag indicating if the user is able to administer group.
-
setGroupAdmin
public UserModel setGroupAdmin(java.lang.Boolean groupAdmin)
- Parameters:
groupAdmin- sets the flag that indicates if someone is a groupAdmin
-
getAlternateEmails
public java.util.List<AlternateEmail> getAlternateEmails()
Gets the list of alternateEmails- Returns:
- the list of alternateEmails
-
setAlternateEmails
public UserModel setAlternateEmails(java.util.List<AlternateEmail> alternateEmails)
Sets the list of alternateEmails- Parameters:
alternateEmails- the new list of alternateEmails- Returns:
- the UserModel
-
getSheetCount
public java.lang.Integer getSheetCount()
Gets the sheetCount. The number of sheets owned by the current user within the organization. Note: As of 5-12-2025, this behavior will be discontinued and sheetCount will hold a value of -1 only if the user's status is ACTIVE. For more information, see the API Changelog.- Returns:
- sheetCount
-
setSheetCount
public UserModel setSheetCount(java.lang.Integer sheetCount)
Sets the sheetCount- Parameters:
sheetCount- the new sheetCount- Returns:
- the UserModel
-
getLastLogin
public java.util.Date getLastLogin()
Gets the lastLogin date- Returns:
- the lastLogin date
-
setLastLogin
public UserModel setLastLogin(java.util.Date lastLogin)
Sets the lastLogin date- Parameters:
lastLogin- the new lastLogin date- Returns:
- the UserModel
-
getCustomWelcomeScreenViewed
public java.util.Date getCustomWelcomeScreenViewed()
Gets the customWelcomeScreenViewed date- Returns:
- the customerWelcomeScreenViewed date
-
setCustomWelcomeScreenViewed
public UserModel setCustomWelcomeScreenViewed(java.util.Date customWelcomeScreenViewed)
Sets the customWelcomeScreenViewed date- Parameters:
customWelcomeScreenViewed- the new customWelcomeScreenViewed date- Returns:
- the UserModel
-
getCompany
public java.lang.String getCompany()
Gets the user's company name- Returns:
- the company name
-
setCompany
public UserModel setCompany(java.lang.String company)
Sets the user's company name- Parameters:
company- the company name
-
getDepartment
public java.lang.String getDepartment()
Gets the user's department- Returns:
- the department
-
setDepartment
public UserModel setDepartment(java.lang.String department)
Sets the user's department- Parameters:
department- the department
-
getMobilePhone
public java.lang.String getMobilePhone()
Gets the user's mobile phone number- Returns:
- the phone number
-
setMobilePhone
public UserModel setMobilePhone(java.lang.String mobilePhone)
Sets the user's mobile phone number- Parameters:
mobilePhone- the phone number
-
getProfileImage
public ProfileImage getProfileImage()
Gets the user's profile image- Returns:
- the ProfileImage
-
setProfileImage
public UserModel setProfileImage(ProfileImage profileImage)
Sets the user's profile image- Parameters:
profileImage- the ProfileImage
-
getRole
public java.lang.String getRole()
Gets the user's role- Returns:
- the role
-
setRole
public UserModel setRole(java.lang.String role)
Sets the user's role- Parameters:
role- the role
-
getTitle
public java.lang.String getTitle()
Gets the user's title- Returns:
- the title
-
setTitle
public UserModel setTitle(java.lang.String title)
Sets the user's title- Parameters:
title- the title
-
getWorkPhone
public java.lang.String getWorkPhone()
Gets the user's work phone number- Returns:
- the phone number
-
setWorkPhone
public UserModel setWorkPhone(java.lang.String workPhone)
Sets the user's work phone number- Parameters:
workPhone- the phone number
-
-