java.lang.Object
- com.onfido.model.CheckShared

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class CheckShared
extends Object

CheckShared

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CheckShared.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_APPLICANT_ID`
`static String`	`SERIALIZED_NAME_APPLICANT_PROVIDES_DATA`
`static String`	`SERIALIZED_NAME_PRIVACY_NOTICES_READ_CONSENT_GIVEN`
`static String`	`SERIALIZED_NAME_REDIRECT_URI`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_WEBHOOK_IDS`

Constructor Summary

Constructors
Constructor Description

CheckShared()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CheckShared`	`addTagsItem(String tagsItem)`
`CheckShared`	`addWebhookIdsItem(String webhookIdsItem)`
`CheckShared`	`applicantId(UUID applicantId)`
`CheckShared`	`applicantProvidesData(Boolean applicantProvidesData)`
`boolean`	`equals(Object o)`
`static CheckShared`	`fromJson(String jsonString)`	Create an instance of CheckShared given an JSON string
`Map<String,Object>`	`getAdditionalProperties()`	Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)`	Return the additional (undeclared) property with the specified name.
`UUID`	`getApplicantId()`	The ID of the applicant to do the check on.
`Boolean`	`getApplicantProvidesData()`	Send an applicant form to applicant to complete to proceed with check.
`Boolean`	`getPrivacyNoticesReadConsentGiven()`	Get privacyNoticesReadConsentGiven
`String`	`getRedirectUri()`	For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
`List<String>`	`getTags()`	Array of tags being assigned to this check.
`List<String>`	`getWebhookIds()`	An array of webhook ids describing which webhooks to trigger for this check.
`int`	`hashCode()`
`CheckShared`	`privacyNoticesReadConsentGiven(Boolean privacyNoticesReadConsentGiven)`
`CheckShared`	`putAdditionalProperty(String key, Object value)`	Set the additional (undeclared) property with the specified name and value.
`CheckShared`	`redirectUri(String redirectUri)`
`void`	`setApplicantId(UUID applicantId)`
`void`	`setApplicantProvidesData(Boolean applicantProvidesData)`
`void`	`setPrivacyNoticesReadConsentGiven(Boolean privacyNoticesReadConsentGiven)`
`void`	`setRedirectUri(String redirectUri)`
`void`	`setTags(List<String> tags)`
`void`	`setWebhookIds(List<String> webhookIds)`
`CheckShared`	`tags(List<String> tags)`
`String`	`toJson()`	Convert an instance of CheckShared to an JSON string
`String`	`toString()`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found
`CheckShared`	`webhookIds(List<String> webhookIds)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_WEBHOOK_IDS
```
public static final String SERIALIZED_NAME_WEBHOOK_IDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_APPLICANT_ID
```
public static final String SERIALIZED_NAME_APPLICANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_APPLICANT_PROVIDES_DATA
```
public static final String SERIALIZED_NAME_APPLICANT_PROVIDES_DATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAGS
```
public static final String SERIALIZED_NAME_TAGS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REDIRECT_URI
```
public static final String SERIALIZED_NAME_REDIRECT_URI
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRIVACY_NOTICES_READ_CONSENT_GIVEN
```
public static final String SERIALIZED_NAME_PRIVACY_NOTICES_READ_CONSENT_GIVEN
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CheckShared
```
public CheckShared()
```
- Method Detail
  - webhookIds
```
public CheckShared webhookIds(List<String> webhookIds)
```
  - addWebhookIdsItem
```
public CheckShared addWebhookIdsItem(String webhookIdsItem)
```
  - getWebhookIds
```
@Nullable
public List<String> getWebhookIds()
```
    An array of webhook ids describing which webhooks to trigger for this check.
    
    Returns:
    
    webhookIds
  - setWebhookIds
```
public void setWebhookIds(List<String> webhookIds)
```
  - applicantId
```
public CheckShared applicantId(UUID applicantId)
```
  - getApplicantId
```
@Nonnull
public UUID getApplicantId()
```
    The ID of the applicant to do the check on.
    
    Returns:
    
    applicantId
  - setApplicantId
```
public void setApplicantId(UUID applicantId)
```
  - applicantProvidesData
```
public CheckShared applicantProvidesData(Boolean applicantProvidesData)
```
  - getApplicantProvidesData
```
@Nullable
public Boolean getApplicantProvidesData()
```
    Send an applicant form to applicant to complete to proceed with check. Defaults to false.
    
    Returns:
    
    applicantProvidesData
  - setApplicantProvidesData
```
public void setApplicantProvidesData(Boolean applicantProvidesData)
```
  - tags
```
public CheckShared tags(List<String> tags)
```
  - addTagsItem
```
public CheckShared addTagsItem(String tagsItem)
```
  - getTags
```
@Nullable
public List<String> getTags()
```
    Array of tags being assigned to this check.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - redirectUri
```
public CheckShared redirectUri(String redirectUri)
```
  - getRedirectUri
```
@Nullable
public String getRedirectUri()
```
    For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
    
    Returns:
    
    redirectUri
  - setRedirectUri
```
public void setRedirectUri(String redirectUri)
```
  - privacyNoticesReadConsentGiven
```
public CheckShared privacyNoticesReadConsentGiven(Boolean privacyNoticesReadConsentGiven)
```
  - getPrivacyNoticesReadConsentGiven
```
@Nullable
public Boolean getPrivacyNoticesReadConsentGiven()
```
    Get privacyNoticesReadConsentGiven
    
    Returns:
    
    privacyNoticesReadConsentGiven
  - setPrivacyNoticesReadConsentGiven
```
public void setPrivacyNoticesReadConsentGiven(Boolean privacyNoticesReadConsentGiven)
```
  - putAdditionalProperty
```
public CheckShared 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 property
    
    value - value of the property
    
    Returns:
    
    the CheckShared 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
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonElement
```
public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException
```
    Validates 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 CheckShared
  - fromJson
```
public static CheckShared fromJson(String jsonString)
                            throws IOException
```
    Create an instance of CheckShared given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CheckShared
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CheckShared
  - toJson
```
public String toJson()
```
    Convert an instance of CheckShared to an JSON string
    
    Returns:
    
    JSON string

Class CheckShared

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_WEBHOOK_IDS

SERIALIZED_NAME_APPLICANT_ID

SERIALIZED_NAME_APPLICANT_PROVIDES_DATA

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_REDIRECT_URI

SERIALIZED_NAME_PRIVACY_NOTICES_READ_CONSENT_GIVEN

openapiFields

openapiRequiredFields

Constructor Detail

CheckShared

Method Detail

webhookIds

addWebhookIdsItem

getWebhookIds

setWebhookIds

applicantId

getApplicantId

setApplicantId

applicantProvidesData

getApplicantProvidesData

setApplicantProvidesData

tags

addTagsItem

getTags

setTags

redirectUri

getRedirectUri

setRedirectUri

privacyNoticesReadConsentGiven

getPrivacyNoticesReadConsentGiven

setPrivacyNoticesReadConsentGiven

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson