Class ContactType
- java.lang.Object
-
- com.inductiveautomation.ignition.common.user.ContactType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ContactType>
public class ContactType extends java.lang.Object implements java.io.Serializable, java.lang.Comparable<ContactType>
Represents a method of contacting a user. By default the system knows about three contact types: phone, sms, and email. Modules may add other contact types by registering them with the UserSourceManager in the Gateway.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static ContactType
EMAIL
static ContactType
PHONE
static ContactType
SMS
-
Constructor Summary
Constructors Constructor Description ContactType(java.lang.String contactType, LocalizedString displayName)
Create a new ContactType.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(ContactType o)
boolean
equals(java.lang.Object obj)
java.lang.String
getContactType()
LocalizedString
getDisplayName()
java.lang.String
toString()
-
-
-
Field Detail
-
PHONE
public static ContactType PHONE
-
SMS
public static ContactType SMS
-
EMAIL
public static ContactType EMAIL
-
-
Constructor Detail
-
ContactType
public ContactType(java.lang.String contactType, LocalizedString displayName)
Create a new ContactType.- Parameters:
contactType
- The type code for this contact type. Do not use "phone", "sms", or "email". These are reserved.displayName
- A human-readable display name for the contact type.
-
-
Method Detail
-
getContactType
public java.lang.String getContactType()
-
getDisplayName
public LocalizedString getDisplayName()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
compareTo
public int compareTo(ContactType o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<ContactType>
-
-