Package com.onfido.model
Class WorkflowRunLink
- java.lang.Object
-
- com.onfido.model.WorkflowRunLink
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.9.0") public class WorkflowRunLink extends Object
WorkflowRunLink
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWorkflowRunLink.CustomTypeAdapterFactorystatic classWorkflowRunLink.LanguageEnumThe code for the language when the workflow run is acessed using the link.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_COMPLETED_REDIRECT_URLstatic StringSERIALIZED_NAME_EXPIRED_REDIRECT_URLstatic StringSERIALIZED_NAME_EXPIRES_ATstatic StringSERIALIZED_NAME_LANGUAGEstatic StringSERIALIZED_NAME_URL
-
Constructor Summary
Constructors Constructor Description WorkflowRunLink()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description WorkflowRunLinkcompletedRedirectUrl(String completedRedirectUrl)booleanequals(Object o)WorkflowRunLinkexpiredRedirectUrl(String expiredRedirectUrl)WorkflowRunLinkexpiresAt(OffsetDateTime expiresAt)static WorkflowRunLinkfromJson(String jsonString)Create an instance of WorkflowRunLink given an JSON stringMap<String,Object>getAdditionalProperties()Return the additional (undeclared) property.ObjectgetAdditionalProperty(String key)Return the additional (undeclared) property with the specified name.StringgetCompletedRedirectUrl()When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido 'thank you' page.StringgetExpiredRedirectUrl()When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.OffsetDateTimegetExpiresAt()Date and time when the link will expire.WorkflowRunLink.LanguageEnumgetLanguage()The code for the language when the workflow run is acessed using the link.StringgetUrl()Link to access the Workflow Run without the need to integrate with Onfido's SDKs.inthashCode()WorkflowRunLinklanguage(WorkflowRunLink.LanguageEnum language)WorkflowRunLinkputAdditionalProperty(String key, Object value)Set the additional (undeclared) property with the specified name and value.voidsetCompletedRedirectUrl(String completedRedirectUrl)voidsetExpiredRedirectUrl(String expiredRedirectUrl)voidsetExpiresAt(OffsetDateTime expiresAt)voidsetLanguage(WorkflowRunLink.LanguageEnum language)voidsetUrl(String url)StringtoJson()Convert an instance of WorkflowRunLink to an JSON stringStringtoString()WorkflowRunLinkurl(String url)static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_URL
public static final String SERIALIZED_NAME_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COMPLETED_REDIRECT_URL
public static final String SERIALIZED_NAME_COMPLETED_REDIRECT_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRED_REDIRECT_URL
public static final String SERIALIZED_NAME_EXPIRED_REDIRECT_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRES_AT
public static final String SERIALIZED_NAME_EXPIRES_AT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LANGUAGE
public static final String SERIALIZED_NAME_LANGUAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
url
public WorkflowRunLink url(String url)
-
getUrl
@Nullable public String getUrl()
Link to access the Workflow Run without the need to integrate with Onfido's SDKs.- Returns:
- url
-
setUrl
public void setUrl(String url)
-
completedRedirectUrl
public WorkflowRunLink completedRedirectUrl(String completedRedirectUrl)
-
getCompletedRedirectUrl
@Nullable public String getCompletedRedirectUrl()
When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido 'thank you' page.- Returns:
- completedRedirectUrl
-
setCompletedRedirectUrl
public void setCompletedRedirectUrl(String completedRedirectUrl)
-
expiredRedirectUrl
public WorkflowRunLink expiredRedirectUrl(String expiredRedirectUrl)
-
getExpiredRedirectUrl
@Nullable public String getExpiredRedirectUrl()
When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.- Returns:
- expiredRedirectUrl
-
setExpiredRedirectUrl
public void setExpiredRedirectUrl(String expiredRedirectUrl)
-
expiresAt
public WorkflowRunLink expiresAt(OffsetDateTime expiresAt)
-
getExpiresAt
@Nullable public OffsetDateTime getExpiresAt()
Date and time when the link will expire.- Returns:
- expiresAt
-
setExpiresAt
public void setExpiresAt(OffsetDateTime expiresAt)
-
language
public WorkflowRunLink language(WorkflowRunLink.LanguageEnum language)
-
getLanguage
@Nullable public WorkflowRunLink.LanguageEnum getLanguage()
The code for the language when the workflow run is acessed using the link.- Returns:
- language
-
setLanguage
public void setLanguage(WorkflowRunLink.LanguageEnum language)
-
putAdditionalProperty
public WorkflowRunLink putAdditionalProperty(String key, Object value)
Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.- Parameters:
key- name of the propertyvalue- value of the property- Returns:
- the WorkflowRunLink instance itself
-
getAdditionalProperties
public Map<String,Object> getAdditionalProperties()
Return the additional (undeclared) property.- Returns:
- a map of objects
-
getAdditionalProperty
public Object getAdditionalProperty(String key)
Return the additional (undeclared) property with the specified name.- Parameters:
key- name of the property- Returns:
- an object
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates the JSON Element and throws an exception if issues found- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is invalid with respect to WorkflowRunLink
-
fromJson
public static WorkflowRunLink fromJson(String jsonString) throws IOException
Create an instance of WorkflowRunLink given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of WorkflowRunLink
- Throws:
IOException- if the JSON string is invalid with respect to WorkflowRunLink
-
toJson
public String toJson()
Convert an instance of WorkflowRunLink to an JSON string- Returns:
- JSON string
-
-