Package com.inductiveautomation.ignition.gateway.authentication.resources

Record Class InternalContactInfoResource

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.authentication.resources.InternalContactInfoResource

Record Components:

contactType - The contact type. By default, the system knows about three contact types: phone, sms, and email. Modules mayadd other contact types by registering them with the UserSourceManager in the Gateway.

value - The value of the contact information.

order - Sort order for the contact information.

public record InternalContactInfoResource(String contactType, String value, Integer order)
extends Record

Configuration for contact information for a user.

Constructor Summary

Constructors

Constructor	Description
InternalContactInfoResource(String contactType, String value, Integer order)	Creates an instance of a InternalContactInfoResource record class.

Method Summary

Modifier and Type	Method	Description
String	contactType()	Returns the value of the contactType record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Integer	order()	Returns the value of the order record component.
final String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InternalContactInfoResource

public InternalContactInfoResource(String contactType,
 String value,
 Integer order)

Creates an instance of a InternalContactInfoResource record class.

Parameters:

contactType - the value for the contactType record component

value - the value for the value record component

order - the value for the order record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

contactType

public String contactType()

Returns the value of the contactType record component.

Returns:

the value of the contactType record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component

order

public Integer order()

Returns the value of the order record component.

Returns:

the value of the order record component