PurposesViewModel (android 1.41.2 API)

java.lang.Object
- androidx.lifecycle.ViewModel
- - io.didomi.sdk.purpose.PurposesViewModel

```
public class PurposesViewModel
extends androidx.lifecycle.ViewModel
```
View model associated to the purposes fragment/adapter. We should use this class to separate the business logic from the purposes view.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PurposesViewModel.ClickableDataProcessingCallback

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PurposesViewModel.ClickableDataProcessingCallback`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConfigurationRepository`	`configurationRepository`
`protected io.didomi.sdk.resources.LanguagesHelper`	`languagesHelper`
`protected java.util.List<PurposeCategory>`	`requiredCategories`
`protected java.util.Set<Purpose>`	`requiredPurposes`
`protected androidx.lifecycle.MutableLiveData<PurposeCategory>`	`selectedCategory`
`protected androidx.lifecycle.MutableLiveData<Purpose>`	`selectedPurpose`
`protected VendorRepository`	`vendorRepository`

Constructor Summary

Constructors
Constructor and Description
`PurposesViewModel(ConfigurationRepository configurationRepository, EventsRepository eventsRepository, VendorRepository vendorRepository, io.didomi.sdk.resources.LanguagesHelper languagesHelper, io.didomi.sdk.resources.ResourcesHelper resourcesHelper, ConsentRepository consentRepository, ContextHelper contextHelper)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areAllPurposesConsentEnabled()`
`boolean`	`areAllPurposesDefinedForCategory(PurposeCategory category)`
`boolean`	`areAllPurposesDisabled()`
`boolean`	`areAllPurposesDisabledWithoutEssentials()`
`int`	`calculateHighlightBackgroundColor(AppConfiguration.Theme theme)` Method used to get the highlight background color from the theme.
`int`	`calculateHighlightTextColor(AppConfiguration.Theme theme)` Method used to get the highlight text color in the form of an int.
`java.util.List<io.didomi.sdk.adapters.DisplayItem.PurposeDisplayItem>`	`createPurposesDisplayItems(android.content.Context context)`
`java.util.List<io.didomi.sdk.adapters.DisplayItem.PurposeDisplayItem>`	`createPurposesDisplayItemsForCategory(PurposeCategory category)`
`void`	`disableAll()` Method used to disable all purposes and update disabled vendors based on enabled vendors.
`void`	`disableAllConsentPurposes()` Method used to disable all purposes.
`void`	`disableAllConsentPurposesExceptEssentials()` Method used to disable all purposes except essential ones.
`void`	`disableAllLegitimatePurposes()` Method used to disable all legitimate purposes.
`void`	`disableAllVendorLegIntUnselected()` Disable legitimate interest for vendors not enabled by the user.
`void`	`disableAllVendorUnselected()` Method used to disable vendors not enabled by the user.
`void`	`disableLegitimatePurpose(Purpose purpose)` Method used to add a purpose to the disabled legitimate purposes array and remove it from the enabled legitimate purposes array.
`void`	`disablePurpose(Purpose purpose)` Method used to add a purpose to the disabled purposes array and remove it from the enabled purposes array.
`protected void`	`disablePurposeIfApplicable(Purpose purpose)`
`void`	`disableVendor(Vendor vendor)` Method used to add a vendor to the disabled vendors array.
`void`	`enableAll()` Method used to enable all purposes and update disabled vendors based on enabled vendors.
`void`	`enableAllConsentPurposes()` Method used to enable all purposes.
`void`	`enableAllConsentPurposesExceptEssentials()` Method used to enable all purposes except essential ones.
`void`	`enableAllLegitimatePurposes()` Method used to enable all legitimate purposes.
`void`	`enableAllVendorLegInt()`
`void`	`enableAllVendorLegIntUnselected()` Enable legitimate interest for vendors not disabled by the user.
`void`	`enableAllVendorUnselected()` Method used to enable vendors not selected by the user.
`boolean`	`enabledPlusDisabledEqualRequired()` Method used to check if the number of enabled and disabled purposes is equal to the number of required purposes.
`void`	`enableLegitimatePurpose(Purpose purpose)` Method used to add a purpose to the enabled legitimate purposes array and remove it from the disabled legitimate purposes array.
`void`	`enablePurpose(Purpose purpose)` Method used to add a purpose to the enabled purposes array and remove it from the disabled purposes array.
`protected void`	`enablePurposeIfApplicable(Purpose purpose)`
`void`	`enableVendor(Vendor vendor)` Method used to add a vendor to the enabled vendors array.
`android.text.Spannable`	`getAdditionalDataProcessingText(PurposesViewModel.ClickableDataProcessingCallback callback)` Get the text for the additional data processing section
`java.lang.String`	`getAgreeButtonLabel()` Method used to get the translated agree button label text.
`java.lang.String`	`getAllPurposesText()`
`boolean`	`getCanCloseWhenConsentIsMissing()` Method used to get the canCloseWhenConsentIsMissing flag.
`PurposeCategory`	`getCategoryById(java.lang.String id)`
`java.lang.String`	`getCategoryDescription(PurposeCategory category)`
`java.lang.String`	`getCategoryName(PurposeCategory category)`
`int`	`getCategorySwitchStatus(PurposeCategory category)`
`int`	`getCategorySwitchStatus(java.lang.String id)`
`java.lang.String`	`getConsentToggleText()` Method used to get the text that goes next to the Consent toggle.
`ContextHelper`	`getContextHelper()` Method used to get the context helper.
`java.lang.String`	`getDataProcessingDescription(DataProcessing dataProcessing)` Method used to get the translated description of a data processing.
`java.lang.String`	`getDataProcessingDescriptionLegal(DataProcessing dataProcessing)` Method used to get the translated legal description of a data processing.
`java.lang.String`	`getDataProcessingName(DataProcessing dataProcessing)` Method used to get the translated name of a data processing.
`protected java.util.Map<DataProcessing,java.lang.String>`	`getDataProcessingTranslations(java.util.Collection<DataProcessing> dataProcessings)` Get translations of data processings names
`boolean`	`getDisableButtonsUntilScroll()` Getter for disableButtonsUntilScroll
`java.util.Set<Purpose>`	`getDisabledLegitimatePurposes()` Method used to get a set that contains the legitimate purposes disabled.
`java.util.Set<Purpose>`	`getDisabledPurposes()` Method used to get a set that contains the purposes disabled.
`java.util.Set<Vendor>`	`getDisabledVendorsConsent()` Getter method for the disabledVendors array.
`java.util.Set<Vendor>`	`getDisabledVendorsLegInt()` Get the list of disabled legitimate interest vendors
`java.lang.String`	`getDisagreeButtonLabel()` Method used to get the translated disagree button label text.
`java.util.Set<Purpose>`	`getEnabledLegitimatePurposes()` Method used to get a set that contains the legitimate purposes enabled.
`java.util.Set<Purpose>`	`getEnabledPurposes()` Method used to get a set that contains the purposes enabled.
`java.util.Set<Vendor>`	`getEnabledVendorsConsent()` Getter method for the enabledVendors array.
`java.util.Set<Vendor>`	`getEnabledVendorsLegInt()` Retrieve the list of enabled legitimate interest vendors (all vendors with legitimate interest not disabled)
`java.lang.String`	`getEssentialPurposeText()` Method used to get the translated status description of a essential purpose.
`android.graphics.drawable.GradientDrawable`	`getHighlightBackground()` Getter method for highlightBackground.
`int`	`getHighlightTextColor()` Getter method for highlightTextColor.
`boolean`	`getIsLinkColorSet()` Getter method for isLinkColorSet flag.
`java.lang.String`	`getLegitimateInterestToggleText()` Method used to get the Legitimate interest text.
`int`	`getLinkColor()` Getter method for linkColor.
`Purpose`	`getPurposeById(java.lang.String id)`
`java.lang.String`	`getPurposeDescription(Purpose purpose)` Method used to get the translated description of a purpose.
`java.lang.String`	`getPurposeDescriptionLegal()` Method used to get the translated legal description of a purpose.
`java.lang.String`	`getPurposeName(Purpose purpose)` Method used to get the translated name of a purpose.
`java.lang.String`	`getPurposesMessageText()` Method used to get the translated Purposes Message text.
`int`	`getPurposeSwitchStatus(Purpose purpose)` Method used to get the status of a vendor
`int`	`getPurposeSwitchStatus(java.lang.String id)`
`android.graphics.drawable.GradientDrawable`	`getRegularBackground()` Getter method for regularBackground.
`int`	`getRegularTextColor()` Getter method for regularTextColor.
`java.util.Set<Vendor>`	`getRequiredVendorsConsent()` Required vendors consent.
`java.util.Set<Vendor>`	`getRequiredVendorsLegInt()` Required vendors legitimate interest
`java.lang.String`	`getSaveButtonDescriptionText()`
`java.lang.String`	`getSaveButtonLabel()` Method used to get the translated save button label text.
`java.lang.String`	`getScrollIndicatorText()` Method used to get the translated text for the scrolling indicator "Scroll down to give consent".
`androidx.lifecycle.MutableLiveData<PurposeCategory>`	`getSelectedCategory()`
`androidx.lifecycle.MutableLiveData<java.lang.Integer>`	`getSelectedCategoryState()`
`androidx.lifecycle.LiveData<Purpose>`	`getSelectedPurpose()` Getter method for the selectedPurpose.
`androidx.lifecycle.MutableLiveData<java.lang.Integer>`	`getSelectedPurposeConsentState()`
`androidx.lifecycle.MutableLiveData<java.lang.Integer>`	`getSelectedPurposeLegIntState()`
`boolean`	`getShouldAddRoomForIcon()` Getter method for shouldAddRoomForIcon.
`boolean`	`getShowWhenConsentIsMissing()` Method used to get the showWhenConsentIsMissing flag.
`protected java.util.List<DataProcessing>`	`getSortedDataProcessingList(java.util.Set<DataProcessing> dataProcessing, java.util.Map<DataProcessing,java.lang.String> dataProcessingTranslations)` Get a sorted list of data processings, by translated name alphabetical order
`int`	`getThemeColor()` Getter method for themeColor.
`java.lang.String`	`getTitle()` Method used to get the translated (if exists) title of the purposes fragment.
`java.lang.String`	`getVendorsViewLabel()` Method used to get the text that goes in the vendors view.
`java.lang.String`	`getViewAllText()` Method used to get the translated "View to all" text.
`java.lang.String`	`getYouAllowText()` Method used to get the translated "You allow..." text that goes in the purposes fragment.
`void`	`initializeSelectedCategoryState(PurposeCategory selectedCategory)`
`void`	`initializeSelectedPurposeStates(Purpose selectedPurpose)`
`boolean`	`isAnyPurposeEnabled()`
`boolean`	`isCategoryEssential(PurposeCategory category)`
`boolean`	`isLegitimatePurpose(Purpose purpose)`
`boolean`	`isLegitimatePurposeEnabled(Purpose purpose)`
`boolean`	`isSelectedPurposeDefined()` This function checks if there any choice made with regards to consent status of this purpose
`boolean`	`isSelectedPurposeEssential()`
`boolean`	`isSpecialFeature()`
`void`	`loadEnabledVendors()` Method used to load enabled vendors (that are enabled or undefined).
`void`	`mixAllConsentPurposes()` Method used to mix all purposes.
`boolean`	`noPurposeIsDefined()` Method used to check if no purpose has been defined (unknown).
`void`	`onAgreeAllButtonClicked()`
`void`	`onBulkPurposesSwitchWasToggled(int state)`
`void`	`onCategoryDetailScreenCloseClicked()`
`void`	`onCategoryDetailScreenLoaded()`
`void`	`onCategorySwitchToggled(PurposeCategory category, int state)`
`protected void`	`onDisablePurposeClicked(Purpose purpose)`
`void`	`onDisagreeAllButtonClicked()`
`void`	`onDismissButtonClicked()`
`protected void`	`onEnablePurposeClicked(Purpose purpose)`
`void`	`onPurposeConsentChanged(Purpose purpose, int consentStatus)`
`void`	`onPurposeDetailConsentSwitchToggled(Purpose purpose, int state)`
`void`	`onPurposeDetailLegIntSwitchToggled(Purpose purpose, int state)`
`void`	`onPurposeDetailScreenCloseClicked()`
`void`	`onPurposeDetailScreenLoaded()`
`void`	`onPurposeLegIntChanged(Purpose purpose, int legIntState)`
`void`	`onPurposeSwitchToggled(Purpose purpose, int state)`
`protected void`	`onPurposeSwitchWasToggled()`
`void`	`onSaveButtonClicked()`
`void`	`onViewCancelled()`
`java.util.List<Purpose>`	`preparePurposesForPresentation(android.content.Context context)` Method used to prepare purposes for presentation to the user.
`java.util.List<Purpose>`	`preparePurposesForPresentation(android.content.Context context, java.util.Set<Purpose> newPurposes)` Method used to refresh prepared purposes for presentation to the user.
`void`	`resetSelectedPurpose()`
`void`	`saveConsent()` Method used to save consent.
`void`	`setHasScrolledToTheBottom(boolean hasScrolledToTheBottom)` Setter method for the hasScrolledToTheBottom flag.
`void`	`setSelectedCategory(PurposeCategory item)`
`void`	`setSelectedCategoryState(java.lang.Integer selectedCategoryState)`
`void`	`setSelectedPurpose(Purpose item)` Setter method for the selectedPurpose.
`void`	`setSelectedPurposeConsentState(java.lang.Integer selectedPurposeConsentState)`
`void`	`setSelectedPurposeLegIntState(java.lang.Integer selectedPurposeLegIntState)`
`boolean`	`shouldBeCancelable()` Method used to determine if the purposes view should be cancelable or not.
`boolean`	`shouldDisplaySwitchesSeparator(Purpose purpose)` Whether UI should display a separator between the consent and legitimate interest switches
`boolean`	`shouldHandleConsentState(Purpose purpose)`
`boolean`	`shouldHandleLegitimateInterestState(Purpose purpose)`
`boolean`	`shouldHideDidomiLogo(boolean isMainScreen)` Method used to check if Didomi logo should be hidden.
`boolean`	`shouldShowAdditionalDataProcessing()` Whether the Additional data processing section should be shown or not We show it if the TCF version is 2 and we have at least one required special purpose or feature
`boolean`	`shouldShowDescriptionLegal()` Method used to indicate if description legal should be shown.
`boolean`	`shouldShowDismissButton(boolean isUserConsentStatusNotPartial)` Method used to check if the close button should be shown to the user.
`java.lang.Boolean`	`shouldSuggestScrolling()` Method used to check if the UI should suggest scrolling.
`boolean`	`shouldUseV2()` Determine is we are using TCFV2.
`protected void`	`sortByCategoriesIfNeeded(java.util.List<Purpose> purposes, java.util.List<PurposeCategory> categories)` This function is a temporary fix for Android TV to support sorting by categories in its previous form.
`void`	`triggerEvent(Event event)` Method used to trigger an (app) event.
`void`	`unsetPurpose(Purpose purpose)` Method used to remove a purposes from both disabled and enabled purposes.
`void`	`updatePurposesStatus(java.util.Set<Purpose> enabledPurposes, java.util.Set<Purpose> disabledPurposes, java.util.Set<Purpose> enabledLegitimatePurposes, java.util.Set<Purpose> disabledLegitimatePurposes)` Method used to update enabled and disabled purposes.
`void`	`updateVendorsAndSaveConsent()` Method used to save a customized vendors and purposes

Methods inherited from class androidx.lifecycle.ViewModel
onCleared

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

- Field Detail
  - vendorRepository
```
protected VendorRepository vendorRepository
```
  - languagesHelper
```
protected io.didomi.sdk.resources.LanguagesHelper languagesHelper
```
  - configurationRepository
```
protected ConfigurationRepository configurationRepository
```
  - requiredPurposes
```
protected java.util.Set<Purpose> requiredPurposes
```
  - requiredCategories
```
protected java.util.List<PurposeCategory> requiredCategories
```
  - selectedPurpose
```
protected androidx.lifecycle.MutableLiveData<Purpose> selectedPurpose
```
  - selectedCategory
```
protected androidx.lifecycle.MutableLiveData<PurposeCategory> selectedCategory
```
- Constructor Detail
  - PurposesViewModel
```
public PurposesViewModel(ConfigurationRepository configurationRepository,
                         EventsRepository eventsRepository,
                         VendorRepository vendorRepository,
                         io.didomi.sdk.resources.LanguagesHelper languagesHelper,
                         io.didomi.sdk.resources.ResourcesHelper resourcesHelper,
                         ConsentRepository consentRepository,
                         ContextHelper contextHelper)
```
- Method Detail
  - shouldShowAdditionalDataProcessing
```
public boolean shouldShowAdditionalDataProcessing()
```
    Whether the Additional data processing section should be shown or not We show it if the TCF version is 2 and we have at least one required special purpose or feature
    
    Returns:
  - getAdditionalDataProcessingText
```
public android.text.Spannable getAdditionalDataProcessingText(@Nullable
                                                              PurposesViewModel.ClickableDataProcessingCallback callback)
```
    Get the text for the additional data processing section
    
    Parameters:
    
    callback - callback to call when an additional data processing is clicked
    
    Returns:
    
    a spannable, with text and clickable elements
  - getDataProcessingTranslations
```
@NotNull
protected java.util.Map<DataProcessing,java.lang.String> getDataProcessingTranslations(java.util.Collection<DataProcessing> dataProcessings)
```
    Get translations of data processings names
    
    Parameters:
    
    dataProcessings - list of data processing to translate
    
    Returns:
    
    the data processings mapped to their name translation
  - getSortedDataProcessingList
```
@NotNull
protected java.util.List<DataProcessing> getSortedDataProcessingList(java.util.Set<DataProcessing> dataProcessing,
                                                                              java.util.Map<DataProcessing,java.lang.String> dataProcessingTranslations)
```
    Get a sorted list of data processings, by translated name alphabetical order
    
    Parameters:
    
    dataProcessing - list of data processings to sort
    
    dataProcessingTranslations - mapping of data processings with their name translation
    
    Returns:
    
    the sorted list
  - shouldBeCancelable
```
public boolean shouldBeCancelable()
```
    Method used to determine if the purposes view should be cancelable or not.
    
    Returns:
    
    true if the view should be cancelable, false otherwise
  - createPurposesDisplayItemsForCategory
```
public java.util.List<io.didomi.sdk.adapters.DisplayItem.PurposeDisplayItem> createPurposesDisplayItemsForCategory(PurposeCategory category)
```
  - createPurposesDisplayItems
```
public java.util.List<io.didomi.sdk.adapters.DisplayItem.PurposeDisplayItem> createPurposesDisplayItems(android.content.Context context)
```
  - preparePurposesForPresentation
```
public java.util.List<Purpose> preparePurposesForPresentation(android.content.Context context)
```
    Method used to prepare purposes for presentation to the user. This might change the order of the purposes, add icons, etc.
    
    Returns:
    
    purposes ordered by category.
  - sortByCategoriesIfNeeded
```
protected void sortByCategoriesIfNeeded(java.util.List<Purpose> purposes,
                                        java.util.List<PurposeCategory> categories)
```
    This function is a temporary fix for Android TV to support sorting by categories in its previous form. This method is supposed to be removed after the full support for categories is added for Android TV For mobile it's doing nothing, since we don't need such sorting here
    
    Parameters:
    
    purposes -
    
    categories -
  - preparePurposesForPresentation
```
public java.util.List<Purpose> preparePurposesForPresentation(android.content.Context context,
                                                              java.util.Set<Purpose> newPurposes)
```
    Method used to refresh prepared purposes for presentation to the user. It is used when device language changes.
    
    Returns:
    
    purposes ordered by category.
  - getShouldAddRoomForIcon
```
public boolean getShouldAddRoomForIcon()
```
    Getter method for shouldAddRoomForIcon.
    
    Returns:
  - calculateHighlightBackgroundColor
```
public int calculateHighlightBackgroundColor(AppConfiguration.Theme theme)
```
    Method used to get the highlight background color from the theme.
    
    Parameters:
    
    theme -
    
    Returns:
  - calculateHighlightTextColor
```
public int calculateHighlightTextColor(AppConfiguration.Theme theme)
```
    Method used to get the highlight text color in the form of an int.
    
    Parameters:
    
    theme -
    
    Returns:
  - getHighlightBackground
```
public android.graphics.drawable.GradientDrawable getHighlightBackground()
```
    Getter method for highlightBackground.
    
    Returns:
  - getRegularBackground
```
public android.graphics.drawable.GradientDrawable getRegularBackground()
```
    Getter method for regularBackground.
    
    Returns:
  - getHighlightTextColor
```
public int getHighlightTextColor()
```
    Getter method for highlightTextColor.
    
    Returns:
  - getRegularTextColor
```
public int getRegularTextColor()
```
    Getter method for regularTextColor.
    
    Returns:
  - getLinkColor
```
public int getLinkColor()
```
    Getter method for linkColor.
    
    Returns:
  - getThemeColor
```
public int getThemeColor()
```
    Getter method for themeColor.
    
    Returns:
  - getIsLinkColorSet
```
public boolean getIsLinkColorSet()
```
    Getter method for isLinkColorSet flag.
    
    Returns:
  - triggerEvent
```
public void triggerEvent(Event event)
```
    Method used to trigger an (app) event.
    
    Parameters:
    
    event - event to be triggered.
  - getVendorsViewLabel
```
public java.lang.String getVendorsViewLabel()
```
    Method used to get the text that goes in the vendors view.
    
    Returns:
    
    the computed string that will be displayed on the vendors view.
  - getPurposeById
```
public Purpose getPurposeById(java.lang.String id)
```
  - getCategoryById
```
public PurposeCategory getCategoryById(java.lang.String id)
```
  - getEnabledPurposes
```
public java.util.Set<Purpose> getEnabledPurposes()
```
    Method used to get a set that contains the purposes enabled.
    
    Returns:
    
    set of purposes enabled.
  - getDisabledPurposes
```
public java.util.Set<Purpose> getDisabledPurposes()
```
    Method used to get a set that contains the purposes disabled.
    
    Returns:
    
    set of purposes disabled.
  - getEnabledLegitimatePurposes
```
public java.util.Set<Purpose> getEnabledLegitimatePurposes()
```
    Method used to get a set that contains the legitimate purposes enabled.
    
    Returns:
    
    set of legitimate purposes enabled.
  - getDisabledLegitimatePurposes
```
public java.util.Set<Purpose> getDisabledLegitimatePurposes()
```
    Method used to get a set that contains the legitimate purposes disabled.
    
    Returns:
    
    set of legitimate purposes disabled.
  - getEnabledVendorsConsent
```
public java.util.Set<Vendor> getEnabledVendorsConsent()
```
    Getter method for the enabledVendors array.
    
    Returns:
  - getDisabledVendorsConsent
```
public java.util.Set<Vendor> getDisabledVendorsConsent()
```
    Getter method for the disabledVendors array.
    
    Returns:
  - getEnabledVendorsLegInt
```
public java.util.Set<Vendor> getEnabledVendorsLegInt()
```
    Retrieve the list of enabled legitimate interest vendors (all vendors with legitimate interest not disabled)
    
    Returns:
  - getDisabledVendorsLegInt
```
public java.util.Set<Vendor> getDisabledVendorsLegInt()
```
    Get the list of disabled legitimate interest vendors
    
    Returns:
  - getRequiredVendorsConsent
```
public java.util.Set<Vendor> getRequiredVendorsConsent()
```
    Required vendors consent.
    
    Returns:
  - getRequiredVendorsLegInt
```
public java.util.Set<Vendor> getRequiredVendorsLegInt()
```
    Required vendors legitimate interest
    
    Returns:
  - getSaveButtonLabel
```
public java.lang.String getSaveButtonLabel()
```
    Method used to get the translated save button label text.
    
    Returns:
    
    save button label text.
  - getTitle
```
public java.lang.String getTitle()
```
    Method used to get the translated (if exists) title of the purposes fragment.
    
    Returns:
    
    title of the purposes fragment.
  - getYouAllowText
```
public java.lang.String getYouAllowText()
```
    Method used to get the translated "You allow..." text that goes in the purposes fragment.
    
    Returns:
    
    "You allow..." text.
  - getScrollIndicatorText
```
public java.lang.String getScrollIndicatorText()
```
    Method used to get the translated text for the scrolling indicator "Scroll down to give consent".
    
    Returns:
    
    "Scroll down to give consent" text.
  - getViewAllText
```
public java.lang.String getViewAllText()
```
    Method used to get the translated "View to all" text.
    
    Returns:
    
    "View to all" text.
  - getPurposesMessageText
```
public java.lang.String getPurposesMessageText()
```
    Method used to get the translated Purposes Message text.
    
    Returns:
    
    Purposes Message text.
  - getAgreeButtonLabel
```
public java.lang.String getAgreeButtonLabel()
```
    Method used to get the translated agree button label text.
    
    Returns:
    
    agree button label text.
  - getDisagreeButtonLabel
```
public java.lang.String getDisagreeButtonLabel()
```
    Method used to get the translated disagree button label text.
    
    Returns:
    
    disagree button label text.
  - getPurposeName
```
public java.lang.String getPurposeName(Purpose purpose)
```
    Method used to get the translated name of a purpose.
    
    Parameters:
    
    purpose - purpose to get the translated name from.
    
    Returns:
    
    translated purpose name.
  - getCategoryName
```
public java.lang.String getCategoryName(PurposeCategory category)
```
  - getPurposeDescription
```
public java.lang.String getPurposeDescription(Purpose purpose)
```
    Method used to get the translated description of a purpose.
    
    Parameters:
    
    purpose - purpose to get the description from.
    
    Returns:
    
    translated purpose description.
  - getCategoryDescription
```
public java.lang.String getCategoryDescription(PurposeCategory category)
```
  - getPurposeDescriptionLegal
```
public java.lang.String getPurposeDescriptionLegal()
```
    Method used to get the translated legal description of a purpose.
    
    Returns:
    
    translated purpose legal description.
  - shouldShowDescriptionLegal
```
public boolean shouldShowDescriptionLegal()
```
    Method used to indicate if description legal should be shown.
    
    Returns:
    
    boolean
  - getConsentToggleText
```
public java.lang.String getConsentToggleText()
```
    Method used to get the text that goes next to the Consent toggle. It can display "Consent" or "Opt-in" in the corresponding language.
    
    Returns:
    
    Consent text.
  - getLegitimateInterestToggleText
```
public java.lang.String getLegitimateInterestToggleText()
```
    Method used to get the Legitimate interest text.
    
    Returns:
    
    Legitimate interest text.
  - getEssentialPurposeText
```
public java.lang.String getEssentialPurposeText()
```
    Method used to get the translated status description of a essential purpose.
    
    Returns:
    
    translated essential purpose status description.
  - getDataProcessingName
```
public java.lang.String getDataProcessingName(DataProcessing dataProcessing)
```
    Method used to get the translated name of a data processing.
    
    Parameters:
    
    dataProcessing - data processing to get the translated name from.
    
    Returns:
    
    translated data processing name.
  - getDataProcessingDescription
```
public java.lang.String getDataProcessingDescription(DataProcessing dataProcessing)
```
    Method used to get the translated description of a data processing.
    
    Parameters:
    
    dataProcessing - data processing to get the description from.
    
    Returns:
    
    translated data processing description.
  - getDataProcessingDescriptionLegal
```
public java.lang.String getDataProcessingDescriptionLegal(DataProcessing dataProcessing)
```
    Method used to get the translated legal description of a data processing.
    
    Parameters:
    
    dataProcessing - data processing to get the description from.
    
    Returns:
    
    translated data processing legal description.
  - getCanCloseWhenConsentIsMissing
```
public boolean getCanCloseWhenConsentIsMissing()
```
    Method used to get the canCloseWhenConsentIsMissing flag.
    
    Returns:
    
    canCloseWhenConsentIsMissing flag.
  - getShowWhenConsentIsMissing
```
public boolean getShowWhenConsentIsMissing()
```
    Method used to get the showWhenConsentIsMissing flag.
    
    Returns:
    
    showWhenConsentIsMissing flag.
  - getContextHelper
```
public ContextHelper getContextHelper()
```
    Method used to get the context helper.
    
    Returns:
    
    instance of ContextHelper.
  - setHasScrolledToTheBottom
```
public void setHasScrolledToTheBottom(boolean hasScrolledToTheBottom)
```
    Setter method for the hasScrolledToTheBottom flag.
    
    Parameters:
    
    hasScrolledToTheBottom -
  - getDisableButtonsUntilScroll
```
public boolean getDisableButtonsUntilScroll()
```
    Getter for disableButtonsUntilScroll
    
    Returns:
  - enabledPlusDisabledEqualRequired
```
public boolean enabledPlusDisabledEqualRequired()
```
    Method used to check if the number of enabled and disabled purposes is equal to the number of required purposes. Once the user toggles a Legitimate interest toggle, we should hide the Agree to all / Disagree to all buttons and switch to the Save button like we do with consent-based toggles.(TCFv2 only)
    
    Returns:
    
    true if the number of enabled plus disabled purposes is equal to the number of required purposes, false otherwise.
  - noPurposeIsDefined
```
public boolean noPurposeIsDefined()
```
    Method used to check if no purpose has been defined (unknown).
    
    Returns:
    
    true if no purpose has been defined, false otherwise.
  - areAllPurposesDefinedForCategory
```
public boolean areAllPurposesDefinedForCategory(PurposeCategory category)
```
  - isCategoryEssential
```
public boolean isCategoryEssential(PurposeCategory category)
```
  - shouldSuggestScrolling
```
public java.lang.Boolean shouldSuggestScrolling()
```
    Method used to check if the UI should suggest scrolling.
    
    Returns:
    
    true if the UI should suggest scrolling, false otherwise.
  - updatePurposesStatus
```
public void updatePurposesStatus(@NonNull
                                 java.util.Set<Purpose> enabledPurposes,
                                 @NonNull
                                 java.util.Set<Purpose> disabledPurposes,
                                 @NonNull
                                 java.util.Set<Purpose> enabledLegitimatePurposes,
                                 @NonNull
                                 java.util.Set<Purpose> disabledLegitimatePurposes)
```
    Method used to update enabled and disabled purposes.
    
    Parameters:
    
    enabledPurposes - enabled purposes to set.
    
    disabledPurposes - disabled purposes to set.
    
    enabledLegitimatePurposes - enabled legitimate interest purposes to set.
    
    disabledLegitimatePurposes - disabled legitimate interest purposes to set.
  - enableAllVendorUnselected
```
public void enableAllVendorUnselected()
```
    Method used to enable vendors not selected by the user.
  - disableAllVendorUnselected
```
public void disableAllVendorUnselected()
```
    Method used to disable vendors not enabled by the user.
  - enableAllVendorLegIntUnselected
```
public void enableAllVendorLegIntUnselected()
```
    Enable legitimate interest for vendors not disabled by the user.
  - disableAllVendorLegIntUnselected
```
public void disableAllVendorLegIntUnselected()
```
    Disable legitimate interest for vendors not enabled by the user.
  - enableAllVendorLegInt
```
public void enableAllVendorLegInt()
```
  - enableAll
```
public void enableAll()
```
    Method used to enable all purposes and update disabled vendors based on enabled vendors.
  - enableAllConsentPurposes
```
public void enableAllConsentPurposes()
```
    Method used to enable all purposes.
  - enableAllConsentPurposesExceptEssentials
```
public void enableAllConsentPurposesExceptEssentials()
```
    Method used to enable all purposes except essential ones.
  - mixAllConsentPurposes
```
public void mixAllConsentPurposes()
```
    Method used to mix all purposes.
  - disableAllConsentPurposes
```
public void disableAllConsentPurposes()
```
    Method used to disable all purposes.
  - disableAllConsentPurposesExceptEssentials
```
public void disableAllConsentPurposesExceptEssentials()
```
    Method used to disable all purposes except essential ones.
  - enableAllLegitimatePurposes
```
public void enableAllLegitimatePurposes()
```
    Method used to enable all legitimate purposes.
  - disableAllLegitimatePurposes
```
public void disableAllLegitimatePurposes()
```
    Method used to disable all legitimate purposes.
  - disableAll
```
public void disableAll()
```
    Method used to disable all purposes and update disabled vendors based on enabled vendors.
  - enablePurpose
```
public void enablePurpose(Purpose purpose)
```
    Method used to add a purpose to the enabled purposes array and remove it from the disabled purposes array.
    
    Parameters:
    
    purpose - purpose to update.
  - disablePurpose
```
public void disablePurpose(Purpose purpose)
```
    Method used to add a purpose to the disabled purposes array and remove it from the enabled purposes array.
    
    Parameters:
    
    purpose - purpose to update.
  - unsetPurpose
```
public void unsetPurpose(Purpose purpose)
```
    Method used to remove a purposes from both disabled and enabled purposes.
    
    Parameters:
    
    purpose - purpose to update.
  - enableVendor
```
public void enableVendor(Vendor vendor)
```
    Method used to add a vendor to the enabled vendors array.
    
    Parameters:
    
    vendor - vendor to update.
  - disableVendor
```
public void disableVendor(Vendor vendor)
```
    Method used to add a vendor to the disabled vendors array.
    
    Parameters:
    
    vendor - vendor to update.
  - enableLegitimatePurpose
```
public void enableLegitimatePurpose(Purpose purpose)
```
    Method used to add a purpose to the enabled legitimate purposes array and remove it from the disabled legitimate purposes array.
    
    Parameters:
    
    purpose - purpose to update.
  - disableLegitimatePurpose
```
public void disableLegitimatePurpose(Purpose purpose)
```
    Method used to add a purpose to the disabled legitimate purposes array and remove it from the enabled legitimate purposes array.
    
    Parameters:
    
    purpose - purpose to update.
  - isLegitimatePurposeEnabled
```
public boolean isLegitimatePurposeEnabled(Purpose purpose)
```
  - isLegitimatePurpose
```
public boolean isLegitimatePurpose(Purpose purpose)
```
  - saveConsent
```
public void saveConsent()
                 throws DidomiNotReadyException
```
    Method used to save consent.
    
    Throws:
    
    DidomiNotReadyException
  - loadEnabledVendors
```
public void loadEnabledVendors()
```
    Method used to load enabled vendors (that are enabled or undefined).
  - shouldHideDidomiLogo
```
public boolean shouldHideDidomiLogo(boolean isMainScreen)
```
    Method used to check if Didomi logo should be hidden.
    
    Parameters:
    
    isMainScreen - true if check is for the main preferences screen
    
    Returns:
    
    true if Didomi logo should be hidden, false otherwise.
  - shouldShowDismissButton
```
public boolean shouldShowDismissButton(boolean isUserConsentStatusNotPartial)
```
    Method used to check if the close button should be shown to the user.
    
    Returns:
    
    true if Didomi dismiss button should appear, false otherwise.
  - areAllPurposesDisabled
```
public boolean areAllPurposesDisabled()
```
    Returns:
    
    true if all Purposes are disabled - consent and legitimate interest
  - areAllPurposesConsentEnabled
```
public boolean areAllPurposesConsentEnabled()
```
    Returns:
    
    true if all Purposes are enabled - only consent is taken into account
  - areAllPurposesDisabledWithoutEssentials
```
public boolean areAllPurposesDisabledWithoutEssentials()
```
    Returns:
    
    true if all Purposes are disabled - only consent is taken into account
  - isAnyPurposeEnabled
```
public boolean isAnyPurposeEnabled()
```
    Returns:
    
    true if at least one Purposes is enabled - consent or legitimate interest
  - updateVendorsAndSaveConsent
```
public void updateVendorsAndSaveConsent()
```
    Method used to save a customized vendors and purposes
  - shouldUseV2
```
public boolean shouldUseV2()
```
    Determine is we are using TCFV2.
    
    Returns:
    
    true if we are using TCFV2, false otherwise.
  - resetSelectedPurpose
```
public void resetSelectedPurpose()
```
  - getSelectedPurpose
```
public androidx.lifecycle.LiveData<Purpose> getSelectedPurpose()
```
    Getter method for the selectedPurpose. Returns the currently selected purpose.
  - setSelectedPurpose
```
public void setSelectedPurpose(Purpose item)
```
    Setter method for the selectedPurpose. Sets the currently selected purpose.
  - getSelectedCategory
```
public androidx.lifecycle.MutableLiveData<PurposeCategory> getSelectedCategory()
```
  - setSelectedCategory
```
public void setSelectedCategory(PurposeCategory item)
```
  - isSpecialFeature
```
public boolean isSpecialFeature()
```
  - getPurposeSwitchStatus
```
public int getPurposeSwitchStatus(java.lang.String id)
```
  - getCategorySwitchStatus
```
public int getCategorySwitchStatus(java.lang.String id)
```
  - getPurposeSwitchStatus
```
public int getPurposeSwitchStatus(Purpose purpose)
```
    Method used to get the status of a vendor
    
    Parameters:
    
    purpose - affected purpose
    
    Returns:
    
    vendor's status, option available at RMAbstractSwitch.
  - getCategorySwitchStatus
```
public int getCategorySwitchStatus(PurposeCategory category)
```
  - getSelectedPurposeConsentState
```
public androidx.lifecycle.MutableLiveData<java.lang.Integer> getSelectedPurposeConsentState()
```
  - setSelectedPurposeConsentState
```
public void setSelectedPurposeConsentState(java.lang.Integer selectedPurposeConsentState)
```
  - getSelectedCategoryState
```
public androidx.lifecycle.MutableLiveData<java.lang.Integer> getSelectedCategoryState()
```
  - setSelectedCategoryState
```
public void setSelectedCategoryState(java.lang.Integer selectedCategoryState)
```
  - getSelectedPurposeLegIntState
```
public androidx.lifecycle.MutableLiveData<java.lang.Integer> getSelectedPurposeLegIntState()
```
  - setSelectedPurposeLegIntState
```
public void setSelectedPurposeLegIntState(java.lang.Integer selectedPurposeLegIntState)
```
  - initializeSelectedPurposeStates
```
public void initializeSelectedPurposeStates(Purpose selectedPurpose)
```
  - initializeSelectedCategoryState
```
public void initializeSelectedCategoryState(PurposeCategory selectedCategory)
```
  - shouldHandleLegitimateInterestState
```
public boolean shouldHandleLegitimateInterestState(Purpose purpose)
```
  - shouldHandleConsentState
```
public boolean shouldHandleConsentState(Purpose purpose)
```
  - shouldDisplaySwitchesSeparator
```
public boolean shouldDisplaySwitchesSeparator(Purpose purpose)
```
    Whether UI should display a separator between the consent and legitimate interest switches
    
    Parameters:
    
    purpose - displayed purpose
    
    Returns:
    
    true if separator should be displayed
  - onAgreeAllButtonClicked
```
public void onAgreeAllButtonClicked()
```
  - onDisagreeAllButtonClicked
```
public void onDisagreeAllButtonClicked()
```
  - onSaveButtonClicked
```
public void onSaveButtonClicked()
```
  - onDismissButtonClicked
```
public void onDismissButtonClicked()
```
  - onViewCancelled
```
public void onViewCancelled()
```
  - onDisablePurposeClicked
```
protected void onDisablePurposeClicked(Purpose purpose)
```
  - disablePurposeIfApplicable
```
protected void disablePurposeIfApplicable(Purpose purpose)
```
  - onEnablePurposeClicked
```
protected void onEnablePurposeClicked(Purpose purpose)
```
  - enablePurposeIfApplicable
```
protected void enablePurposeIfApplicable(Purpose purpose)
```
  - onPurposeSwitchToggled
```
public void onPurposeSwitchToggled(Purpose purpose,
                                   int state)
```
  - onPurposeDetailConsentSwitchToggled
```
public void onPurposeDetailConsentSwitchToggled(Purpose purpose,
                                                int state)
```
  - onPurposeDetailLegIntSwitchToggled
```
public void onPurposeDetailLegIntSwitchToggled(Purpose purpose,
                                               int state)
```
  - onCategorySwitchToggled
```
public void onCategorySwitchToggled(PurposeCategory category,
                                    int state)
```
  - onPurposeConsentChanged
```
public void onPurposeConsentChanged(Purpose purpose,
                                    int consentStatus)
```
  - onPurposeSwitchWasToggled
```
protected void onPurposeSwitchWasToggled()
```
  - onPurposeLegIntChanged
```
public void onPurposeLegIntChanged(Purpose purpose,
                                   int legIntState)
```
  - getAllPurposesText
```
public java.lang.String getAllPurposesText()
```
  - getSaveButtonDescriptionText
```
public java.lang.String getSaveButtonDescriptionText()
```
  - onBulkPurposesSwitchWasToggled
```
public void onBulkPurposesSwitchWasToggled(int state)
```
  - onCategoryDetailScreenLoaded
```
public void onCategoryDetailScreenLoaded()
```
  - onPurposeDetailScreenLoaded
```
public void onPurposeDetailScreenLoaded()
```
  - onCategoryDetailScreenCloseClicked
```
public void onCategoryDetailScreenCloseClicked()
```
  - onPurposeDetailScreenCloseClicked
```
public void onPurposeDetailScreenCloseClicked()
```
  - isSelectedPurposeEssential
```
public boolean isSelectedPurposeEssential()
```
  - isSelectedPurposeDefined
```
public boolean isSelectedPurposeDefined()
```
    This function checks if there any choice made with regards to consent status of this purpose

Class PurposesViewModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class androidx.lifecycle.ViewModel

Methods inherited from class java.lang.Object

Field Detail

vendorRepository

languagesHelper

configurationRepository

requiredPurposes

requiredCategories

selectedPurpose

selectedCategory

Constructor Detail

PurposesViewModel

Method Detail

shouldShowAdditionalDataProcessing

getAdditionalDataProcessingText

getDataProcessingTranslations

getSortedDataProcessingList

shouldBeCancelable

createPurposesDisplayItemsForCategory

createPurposesDisplayItems

preparePurposesForPresentation

sortByCategoriesIfNeeded

preparePurposesForPresentation

getShouldAddRoomForIcon

calculateHighlightBackgroundColor

calculateHighlightTextColor

getHighlightBackground

getRegularBackground

getHighlightTextColor

getRegularTextColor

getLinkColor

getThemeColor

getIsLinkColorSet

triggerEvent

getVendorsViewLabel

getPurposeById

getCategoryById

getEnabledPurposes

getDisabledPurposes

getEnabledLegitimatePurposes

getDisabledLegitimatePurposes

getEnabledVendorsConsent

getDisabledVendorsConsent

getEnabledVendorsLegInt

getDisabledVendorsLegInt

getRequiredVendorsConsent

getRequiredVendorsLegInt

getSaveButtonLabel

getTitle

getYouAllowText

getScrollIndicatorText

getViewAllText

getPurposesMessageText

getAgreeButtonLabel

getDisagreeButtonLabel

getPurposeName

getCategoryName

getPurposeDescription

getCategoryDescription

getPurposeDescriptionLegal

shouldShowDescriptionLegal

getConsentToggleText

getLegitimateInterestToggleText

getEssentialPurposeText

getDataProcessingName

getDataProcessingDescription

getDataProcessingDescriptionLegal

getCanCloseWhenConsentIsMissing

getShowWhenConsentIsMissing

getContextHelper

setHasScrolledToTheBottom

getDisableButtonsUntilScroll

enabledPlusDisabledEqualRequired

noPurposeIsDefined

areAllPurposesDefinedForCategory