Class Consents

This class keeps track of all granted or denied consents of a user.

There are two different types of consents:

Consents for common features like if we're allowed to evaluate the locale or a user agent.
Consents per measurement campaign.

The time of the consent is recorded along with its state: If it was actually granted or denied.

Consents for common features are given indefinitely, since they are only ever recorded along with running campaigns.

Consents for campaigns only last for a certain amount of days.

Hierarchy

Consents

Index

Constructors

constructor

new Consents(json?): Consents
Parameters
- Optional json: {
  campaigns: ConsentsMap;
  features: ConsentsMap;
  }
  
  Optional data from JSON deserialization to assign.
  - campaigns: ConsentsMap
  - features: ConsentsMap
Returns Consents
- Defined in consents.ts:168

Properties

campaigns

campaigns: {
[key: string]: Consent;
} = {}

Type declaration

[key: string]: Consent

features

features: {
[key: string]: Consent;
} = {}

Type declaration

[key: string]: Consent

Methods

consentForCampaign

consentForCampaign(campaignId): null | CampaignConsent
Returns the consent for a given campaign, if any available.
Parameters
- campaignId: string
  
  The campaign ID to get the consent for.
Returns null | CampaignConsent
the CampaignConsent for the given campaign or null, if consent unknown.
- Defined in consents.ts:286

consentForFeature

consentForFeature(feature): null | FeatureConsent
Returns the consent for a given feature, if any available.
Parameters
- feature: string
  
  The feature to get the consent for.
Returns null | FeatureConsent
the FeatureConsent for the given feature or null, if consent unknown.
- Defined in consents.ts:222

denyCampaign

denyCampaign(campaignId): CampaignConsent
User denies consent to run a specific campaign.
Parameters
- campaignId: string
Returns CampaignConsent
- Defined in consents.ts:271

denyFeature

denyFeature(feature): FeatureConsent
User denies consent to evaluate a Feature.
Parameters
- feature: Feature
Returns FeatureConsent
- Defined in consents.ts:207

grantCampaign

grantCampaign(campaignId, campaign): CampaignConsent
User consents to run a specific campaign.
Parameters
- campaignId: string
  
  The campaign ID.
- campaign: Campaign
  
  The campaign.
Returns CampaignConsent
- Defined in consents.ts:249

grantFeature

grantFeature(feature): FeatureConsent
User consents to evaluate a Feature.
Parameters
- feature: Feature
Returns FeatureConsent
- Defined in consents.ts:192

stateOfCampaign

stateOfCampaign(campaignId): ConsentState
Checks the consent state of a campaign.
Parameters
- campaignId: string
  
  The campaign ID to check the consent state of.
Returns ConsentState
the current state of consent.
- Defined in consents.ts:300

stateOfFeature

stateOfFeature(feature): ConsentState
Checks the consent state of a feature.
Parameters
- feature: Feature
  
  The feature to check the consent state of.
Returns ConsentState
the current state of consent.
- Defined in consents.ts:236

Class Consents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional json: { campaigns: ConsentsMap; features: ConsentsMap; }

campaigns: ConsentsMap

features: ConsentsMap

Returns Consents

Properties

campaigns

Type declaration

[key: string]: Consent

features

Type declaration

[key: string]: Consent

Methods

consentForCampaign

Parameters

campaignId: string

Returns null | CampaignConsent

consentForFeature

Parameters

feature: string

Returns null | FeatureConsent

denyCampaign

Parameters

campaignId: string

Returns CampaignConsent

denyFeature

Parameters

feature: Feature

Returns FeatureConsent

grantCampaign

Parameters

campaignId: string

campaign: Campaign

Returns CampaignConsent

grantFeature

Parameters

feature: Feature

Returns FeatureConsent

stateOfCampaign

Parameters

campaignId: string

Returns ConsentState

stateOfFeature

Parameters

feature: Feature

Returns ConsentState

Settings

Member Visibility

Theme

On This Page

`Optional` json: {
campaigns: ConsentsMap;
features: ConsentsMap;
}