Package com.inductiveautomation.ignition.common.user

Interface User

All Superinterfaces:

Countable, Extendable<PropertySet>, Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, 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 final Property<String>	Badge
static final String	DEFAULT_SCHEDULE_NAME
static final Property<String>	FirstName
static final Property<String>	Language	The preferred language for the user.
static final Property<String>	LastName
static final Property<String>	Notes
static final Property<String>	Password
static final Property<String>	Schedule	The master schedule for this user.
static final Property<String>	Username
static final Pattern	USERNAME_PATTERN	A regex to check for a valid username.

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Method Summary

Modifier and Type	Method	Description
List<ContactInfo>	getContactInfo()	Returns all of the contact information for the user
Serializable	getId()	An opaque identifier that can be used to identify this user.
QualifiedPath	getPath()	Generate an path that unambiguously references this user
String	getProfileName()	The name of the user management profile this user was retrieved from.
Collection<String>	getRoles()	Returns all of the roles this user is a has.
List<ScheduleAdjustment>	getScheduleAdjustments()	Returns all of this user's upcoming schedule adjustments
void	setProfileName(String newProfileName)	Scripting functions allow adding and editing of users, and profile names may need to change.

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

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 Details

DEFAULT_SCHEDULE_NAME

static final String DEFAULT_SCHEDULE_NAME

See Also:

• Constant Field Values

USERNAME_PATTERN

static final Pattern USERNAME_PATTERN

A regex to check for a valid username. [p{Alnum}][@\\w.\\s\\-]{1,49}

Username

static final Property<String> Username

FirstName

static final Property<String> FirstName

LastName

static final Property<String> LastName

Password

static final Property<String> Password

Notes

static final Property<String> Notes

Schedule

static final Property<String> Schedule

The master schedule for this user.

Language

static final Property<String> Language

The preferred language for the user. Will be of the style of Locale.toString()

Badge

static final Property<String> Badge

Method Details

getProfileName

String getProfileName()

The name of the user management profile this user was retrieved from.

setProfileName

void setProfileName(@Nullable
 String newProfileName)

Scripting functions allow adding and editing of users, and profile names may need to change.

getId

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

Collection<String> getRoles()

Returns all of the roles this user is a has. Not null.

getContactInfo

List<ContactInfo> getContactInfo()

Returns all of the contact information for the user

getScheduleAdjustments

List<ScheduleAdjustment> getScheduleAdjustments()

Returns all of this user's upcoming schedule adjustments

getPath

QualifiedPath getPath()

Generate an path that unambiguously references this user