All Implemented Interfaces:
```
public final class CurrentUserStatus

                    
```
Current User Status Type used to represent the current user status. This contains all the choices made by the user on the Didomi SDK and other related information such as consent string and dates when the status was created or updated.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CurrentUserStatus.PurposeStatus`	User Status for a Purpose
`public final class`	`CurrentUserStatus.VendorStatus`	User Status for a Vendor

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`userId`
`private final String`	`created`
`private final String`	`updated`
`private final String`	`consentString`
`private final String`	`additionalConsent`
`private final String`	`didomiDcs`
`private final String`	`gppString`
`private final transient Regulation`	`regulation`
`private final Map<String, CurrentUserStatus.PurposeStatus>`	`purposes`
`private final Map<String, CurrentUserStatus.VendorStatus>`	`vendors`

Constructor Summary

Constructors
Constructor	Description
`CurrentUserStatus(Map<String, CurrentUserStatus.PurposeStatus> purposes, Map<String, CurrentUserStatus.VendorStatus> vendors)`	Public constructor for CurrentUserStatus
`CurrentUserStatus(Map<String, CurrentUserStatus.PurposeStatus> purposes, Map<String, CurrentUserStatus.VendorStatus> vendors, String userId, String created, String updated, String consentString, String additionalConsent, String didomiDcs, String regulationString, String gppString)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getUserId()`	Didomi user ID
`final String`	`getCreated()`	User status creation date
`final String`	`getUpdated()`	User status update date
`final String`	`getConsentString()`	TCF consent as string
`final String`	`getAdditionalConsent()`	Additional consent as string
`final String`	`getDidomiDcs()`	Didomi DCS
`final String`	`getGppString()`	GPP String (from `IABGPP_HDR_GppString` key)
`final Regulation`	`getRegulation()`	Current Regulation
`final Map<String, CurrentUserStatus.PurposeStatus>`	`getPurposes()`	Property that contains the user status associated to purposes.
`final Map<String, CurrentUserStatus.VendorStatus>`	`getVendors()`	Property that contains the user status associated to vendors.
`final Boolean`	`shouldUserStatusBeCollected()`	Determine if the User Status (consent) should be collected or not.

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

- Constructor Detail
  - CurrentUserStatus
```
CurrentUserStatus(Map<String, CurrentUserStatus.PurposeStatus> purposes, Map<String, CurrentUserStatus.VendorStatus> vendors)
```
    Public constructor for CurrentUserStatus
    
    Parameters:
    
    purposes - Map of purposes with their status
    
    vendors - Map of vendors with their status
  - CurrentUserStatus
```
CurrentUserStatus(Map<String, CurrentUserStatus.PurposeStatus> purposes, Map<String, CurrentUserStatus.VendorStatus> vendors, String userId, String created, String updated, String consentString, String additionalConsent, String didomiDcs, String regulationString, String gppString)
```
- Method Detail
  - getUserId
```
 final String getUserId()
```
    Didomi user ID
  - getCreated
```
 final String getCreated()
```
    User status creation date
  - getUpdated
```
 final String getUpdated()
```
    User status update date
  - getConsentString
```
 final String getConsentString()
```
    TCF consent as string
  - getAdditionalConsent
```
 final String getAdditionalConsent()
```
    Additional consent as string
  - getDidomiDcs
```
 final String getDidomiDcs()
```
    Didomi DCS
  - getGppString
```
 final String getGppString()
```
    GPP String (from IABGPP_HDR_GppString key)
  - getRegulation
```
 final Regulation getRegulation()
```
    Current Regulation
  - getPurposes
```
 final Map<String, CurrentUserStatus.PurposeStatus> getPurposes()
```
    Property that contains the user status associated to purposes.
  - getVendors
```
 final Map<String, CurrentUserStatus.VendorStatus> getVendors()
```
    Property that contains the user status associated to vendors.
  - shouldUserStatusBeCollected
```
 final Boolean shouldUserStatusBeCollected()
```
    Determine if the User Status (consent) should be collected or not. This is based on the regulation and the expiration date.
    If the regulation is NONE, we don't need to collect the User Status, false is always returned.
    If the User Status (consent) should be collected when the CurrentUserStatus has been computed, true is always returned.
    If the User Status (consent) should NOT be collected when the CurrentUserStatus has been computed, true is returned only if the consent is expired.
    Returns:
    
    true if User Status (consent) should be collected, false otherwise.

Class CurrentUserStatus

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CurrentUserStatus

CurrentUserStatus

Method Detail

getUserId

getCreated

getUpdated

getConsentString

getAdditionalConsent

getDidomiDcs

getGppString

getRegulation

getPurposes

getVendors

shouldUserStatusBeCollected