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.Boolean
getAdmin()
Gets the admin flag which allows managing users and accounts.java.util.List<AlternateEmail>
getAlternateEmails()
Gets the list of alternateEmailsjava.lang.String
getCompany()
Gets the user's company namejava.util.Date
getCustomWelcomeScreenViewed()
Gets the customWelcomeScreenViewed datejava.lang.String
getDepartment()
Gets the user's departmentjava.lang.String
getEmail()
Gets the email address.java.lang.String
getFirstName()
Gets the first name.java.lang.Boolean
getGroupAdmin()
java.util.Date
getLastLogin()
Gets the lastLogin datejava.lang.String
getLastName()
Gets the last name.java.lang.Boolean
getLicensedSheetCreator()
Gets the licensed sheet creator flag that allows creating and owning sheets.java.lang.String
getMobilePhone()
Gets the user's mobile phone numberProfileImage
getProfileImage()
Gets the user's profile imagejava.lang.Boolean
getResourceViewer()
java.lang.String
getRole()
Gets the user's rolejava.lang.Integer
getSheetCount()
Gets the sheetCount.UserStatus
getStatus()
Gets the status of the user (active, pending, declined).java.lang.String
getTitle()
Gets the user's titlejava.lang.String
getWorkPhone()
Gets the user's work phone numberUserModel
setAdmin(java.lang.Boolean admin)
Sets the admin flag which allows managing users and accounts.UserModel
setAlternateEmails(java.util.List<AlternateEmail> alternateEmails)
Sets the list of alternateEmailsUserModel
setCompany(java.lang.String company)
Sets the user's company nameUserModel
setCustomWelcomeScreenViewed(java.util.Date customWelcomeScreenViewed)
Sets the customWelcomeScreenViewed dateUserModel
setDepartment(java.lang.String department)
Sets the user's departmentUserModel
setEmail(java.lang.String email)
Sets the email address.UserModel
setFirstName(java.lang.String firstName)
Sets the first name.UserModel
setGroupAdmin(java.lang.Boolean groupAdmin)
UserModel
setLastLogin(java.util.Date lastLogin)
Sets the lastLogin dateUserModel
setLastName(java.lang.String lastName)
Sets the last name.UserModel
setLicensedSheetCreator(java.lang.Boolean licensedSheetCreator)
Sets the licensed sheet creator flag that allows creating and owning sheets.UserModel
setMobilePhone(java.lang.String mobilePhone)
Sets the user's mobile phone numberUserModel
setProfileImage(ProfileImage profileImage)
Sets the user's profile imageUserModel
setResourceViewer(java.lang.Boolean resourceViewer)
Sets the resource manager flag.UserModel
setRole(java.lang.String role)
Sets the user's roleUserModel
setSheetCount(java.lang.Integer sheetCount)
Sets the sheetCountUserModel
setStatus(UserStatus status)
Sets the status of the user.UserModel
setTitle(java.lang.String title)
Sets the user's titleUserModel
setWorkPhone(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.- 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
-
-