Class TokenRetrieveResponse
-
- All Implemented Interfaces:
public final class TokenRetrieveResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTokenRetrieveResponse.BuilderA builder for TokenRetrieveResponse.
public final classTokenRetrieveResponse.Status
-
Method Summary
Modifier and Type Method Description final UserTokentoUserToken()final Stringtoken()Full body of the token. final UserToken.ProviderKeyproviderKey()final Optional<UserToken.Device>device()Information about the device the token came from. final Optional<UserToken.ExpiryDate>expiryDate()ISO 8601 formatted date the token expires. final JsonValue_properties()Properties about the token. final Optional<UserToken.Tracking>tracking()Tracking information about the device the token came from. final Optional<TokenRetrieveResponse.Status>status()final Optional<String>statusReason()The reason for the token status. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<UserToken.ProviderKey>_providerKey()Returns the raw JSON value of providerKey. final JsonField<UserToken.Device>_device()Returns the raw JSON value of device. final JsonField<UserToken.ExpiryDate>_expiryDate()Returns the raw JSON value of expiryDate. final JsonField<UserToken.Tracking>_tracking()Returns the raw JSON value of tracking. final JsonField<TokenRetrieveResponse.Status>_status()Returns the raw JSON value of status. final JsonField<String>_statusReason()Returns the raw JSON value of statusReason. final Map<String, JsonValue>_additionalProperties()final TokenRetrieveResponse.BuildertoBuilder()final TokenRetrieveResponsevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static TokenRetrieveResponse.Builderbuilder()Returns a mutable builder for constructing an instance of TokenRetrieveResponse. -
-
Method Detail
-
toUserToken
final UserToken toUserToken()
-
providerKey
final UserToken.ProviderKey providerKey()
-
device
final Optional<UserToken.Device> device()
Information about the device the token came from.
-
expiryDate
final Optional<UserToken.ExpiryDate> expiryDate()
ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable expiration.
-
_properties
final JsonValue _properties()
Properties about the token.
This arbitrary value can be deserialized into a custom type using the
convertmethod:MyClass myObject = tokenRetrieveResponse.properties().convert(MyClass.class);
-
tracking
final Optional<UserToken.Tracking> tracking()
Tracking information about the device the token came from.
-
status
final Optional<TokenRetrieveResponse.Status> status()
-
statusReason
final Optional<String> statusReason()
The reason for the token status.
-
_token
final JsonField<String> _token()
Returns the raw JSON value of token.
Unlike token, this method doesn't throw if the JSON field has an unexpected type.
-
_providerKey
final JsonField<UserToken.ProviderKey> _providerKey()
Returns the raw JSON value of providerKey.
Unlike providerKey, this method doesn't throw if the JSON field has an unexpected type.
-
_device
final JsonField<UserToken.Device> _device()
Returns the raw JSON value of device.
Unlike device, this method doesn't throw if the JSON field has an unexpected type.
-
_expiryDate
final JsonField<UserToken.ExpiryDate> _expiryDate()
Returns the raw JSON value of expiryDate.
Unlike expiryDate, this method doesn't throw if the JSON field has an unexpected type.
-
_tracking
final JsonField<UserToken.Tracking> _tracking()
Returns the raw JSON value of tracking.
Unlike tracking, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<TokenRetrieveResponse.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_statusReason
final JsonField<String> _statusReason()
Returns the raw JSON value of statusReason.
Unlike statusReason, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final TokenRetrieveResponse.Builder toBuilder()
-
validate
final TokenRetrieveResponse validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static TokenRetrieveResponse.Builder builder()
Returns a mutable builder for constructing an instance of TokenRetrieveResponse.
The following fields are required:
.token() .providerKey()
-
-
-
-