Interface User
-
- All Superinterfaces:
Countable
,Extendable<PropertySet>
,java.lang.Iterable<PropertyValue>
,Mergable<PropertySet>
,MutablePropertyValueSource
,PropertySet
,PropertyValueSource
,java.io.Serializable
- All Known Subinterfaces:
AuthenticatedUser
- All Known Implementing Classes:
BasicAuthenticatedUser
,BasicUser
,PyUser
public interface User extends PropertySet
-
-
Field Summary
Fields Modifier and Type Field Description static Property<java.lang.String>
Badge
static java.lang.String
DEFAULT_SCHEDULE_NAME
static Property<java.lang.String>
FirstName
static Property<java.lang.String>
Language
The preferred language for the user.static Property<java.lang.String>
LastName
static Property<java.lang.String>
Notes
static Property<java.lang.String>
Password
static Property<java.lang.String>
Schedule
The master schedule for this user.static Property<java.lang.String>
Username
static java.util.regex.Pattern
USERNAME_PATTERN
A regex to check for a valid username.-
Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
EMPTY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<ContactInfo>
getContactInfo()
Returns all of the contact information for the userjava.io.Serializable
getId()
An opaque identifier that can be used to identify this user.QualifiedPath
getPath()
Generate an path that unambiguously references this userjava.lang.String
getProfileName()
The name of the user management profile this user was retrieved from.java.util.Collection<java.lang.String>
getRoles()
Returns all of the roles this user is a has.java.util.List<ScheduleAdjustment>
getScheduleAdjustments()
Returns all of this user's upcoming schedule adjustments-
Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource
merge, remove, set, set
-
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension
-
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource
contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues
-
-
-
-
Field Detail
-
DEFAULT_SCHEDULE_NAME
static final java.lang.String DEFAULT_SCHEDULE_NAME
- See Also:
- Constant Field Values
-
USERNAME_PATTERN
static final java.util.regex.Pattern USERNAME_PATTERN
A regex to check for a valid username.[p{Alnum}][@\\w.\\s\\-]{1,49}
-
Username
static final Property<java.lang.String> Username
-
FirstName
static final Property<java.lang.String> FirstName
-
LastName
static final Property<java.lang.String> LastName
-
Password
static final Property<java.lang.String> Password
-
Notes
static final Property<java.lang.String> Notes
-
Schedule
static final Property<java.lang.String> Schedule
The master schedule for this user.
-
Language
static final Property<java.lang.String> Language
The preferred language for the user. Will be of the style ofLocale.toString()
-
Badge
static final Property<java.lang.String> Badge
-
-
Method Detail
-
getProfileName
java.lang.String getProfileName()
The name of the user management profile this user was retrieved from.
-
getId
java.io.Serializable getId()
An opaque identifier that can be used to identify this user. Only valid (unique) within the context of the originating user profile
-
getRoles
java.util.Collection<java.lang.String> getRoles()
Returns all of the roles this user is a has. Not null.
-
getContactInfo
java.util.List<ContactInfo> getContactInfo()
Returns all of the contact information for the user
-
getScheduleAdjustments
java.util.List<ScheduleAdjustment> getScheduleAdjustments()
Returns all of this user's upcoming schedule adjustments
-
getPath
QualifiedPath getPath()
Generate an path that unambiguously references this user
-
-