Class BasicUser
java.lang.Object
com.inductiveautomation.ignition.common.config.BasicPropertySet
com.inductiveautomation.ignition.common.user.BasicUser
- All Implemented Interfaces:
Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, User, Serializable, Iterable<PropertyValue>
- Direct Known Subclasses:
BasicAuthenticatedUser
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class BasicPropertySet
BasicPropertySet.BuilderNested classes/interfaces inherited from interface User
User.GsonAdapter -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<ContactInfo> protected Serializableprotected Stringprotected List<ScheduleAdjustment> Fields inherited from interface PropertySet
EMPTYFields inherited from interface User
Badge, DEFAULT_SCHEDULE_NAME, FirstName, Language, LastName, Notes, Password, Schedule, STANDARD_USER_PROPERTIES, Username, USERNAME_PATTERN -
Constructor Summary
ConstructorsConstructorDescriptionBasicUser(String profileName, String id, Collection<String> roles) BasicUser(String profileName, String id, Collection<String> roles, List<ContactInfo> contactInfo) -
Method Summary
Modifier and TypeMethodDescriptionboolean@NonNull List<ContactInfo> Returns all the contact information for the usergetId()An opaque identifier that can be used to identify this user.getPath()Generate a path that unambiguously references this userThe name of the user management profile this user was retrieved from.getRoles()Returns a mutable list of roles this user has.@NonNull List<ScheduleAdjustment> Returns all of this user's upcoming schedule adjustmentsinthashCode()setContactInfo(@Nullable List<ContactInfo> contactInfo) voidsetProfileName(@Nullable String newProfileName) Scripting functions allow adding and editing of users, and profile names may need to change.setRoles(@Nullable Collection<String> roles) setScheduleAdjustments(@Nullable List<ScheduleAdjustment> scheduleAdjustments) Methods inherited from class BasicPropertySet
addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, contains, firePropertyChange, get, getCount, getExtension, getOrDefault, getOrElse, getProperties, getRaw, getRawValueMap, getValues, isExtended, isInherited, iterator, of, remove, removePropertyChangeListener, removePropertyChangeListener, set, set, setDirect, setImpl, setRawValueMap, toStringMethods inherited from interface Iterable
forEach, iterator, spliteratorMethods inherited from interface MutablePropertyValueSource
merge, remove, set, setMethods inherited from interface PropertySet
extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtensionMethods inherited from interface PropertyValueSource
contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues
-
Field Details
-
profileName
-
id
-
roles
-
contactInfo
-
scheduleAdjustments
-
-
Constructor Details
-
BasicUser
-
BasicUser
public BasicUser(String profileName, String id, Collection<String> roles, List<ContactInfo> contactInfo)
-
-
Method Details
-
setRoles
-
setContactInfo
-
setScheduleAdjustments
-
setProfileName
Description copied from interface:UserScripting functions allow adding and editing of users, and profile names may need to change.- Specified by:
setProfileNamein interfaceUser
-
equals
- Overrides:
equalsin classBasicPropertySet
-
hashCode
-
getProfileName
Description copied from interface:UserThe name of the user management profile this user was retrieved from.- Specified by:
getProfileNamein interfaceUser
-
getId
-
getRoles
-
getContactInfo
Description copied from interface:UserReturns all the contact information for the user- Specified by:
getContactInfoin interfaceUser
-
getScheduleAdjustments
Description copied from interface:UserReturns all of this user's upcoming schedule adjustments- Specified by:
getScheduleAdjustmentsin interfaceUser
-
getPath
Description copied from interface:UserGenerate a path that unambiguously references this user
-