Record Class LoginResult
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.auth.messages.LoginResult
- Record Components:
user- The validated user information. The user'sUser.getProfileName()gives the user-source name (classic auth) or IdP name (IdP auth).sessionId- The internal ID used as a stable identifier.secret- Any arbitrary piece of "secret" info to piggyback on the result, such as an auth token.
public record LoginResult(@Nullable AuthenticatedUser user, String sessionId, @Nullable String secret)
extends Record
Basic nominal tuple used as a return value for Designer and Client authentication.
-
Constructor Summary
ConstructorsConstructorDescriptionLoginResult(@Nullable AuthenticatedUser user, String sessionId, @Nullable String secret) Creates an instance of aLoginResultrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@Nullable Stringsecret()Returns the value of thesecretrecord component.Returns the value of thesessionIdrecord component.final StringtoString()Returns a string representation of this record class.@Nullable AuthenticatedUseruser()Returns the value of theuserrecord component.
-
Constructor Details
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
user
-
sessionId
-
secret
-