Package com.inductiveautomation.ignition.common.user

Interface User

    • 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 of Locale.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