Struct clean_insights_sdk::consents::Consents

pub struct Consents {
    pub features: HashMap<Feature, Consent>,
    pub campaigns: HashMap<String, Consent>,
}

This struct 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 it’s 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.

Fields

features: HashMap<Feature, Consent>

campaigns: HashMap<String, Consent>

Implementations

impl Consents

pub fn grant_feature(&mut self, feature: Feature) -> FeatureConsent

User consents to evaluate a Feature.

pub fn deny(&mut self, feature: Feature) -> FeatureConsent

User denies consent to evaluate a Feature.

pub fn has_been_granted(&self, feature: Feature) -> bool

Returns if consent to a Feature was given.

pub fn grant_campaign(
    &mut self,
    campaign_id: &str,
    campaign: &Campaign
) -> CampaignConsent

User consents to run a specific campaign.

Arguments

• campaign_id: The campaign ID.
• campaign: The campaign.

pub fn deny_campaign(&mut self, campaign_id: &str) -> CampaignConsent

User denies consent to run a specific campaign.

pub fn is_campaign_granted(
    &self,
    campaign_id: &str,
    start: DateTime<Utc>,
    end: DateTime<Utc>
) -> bool

Returns if consent to run a campaign was given and is valid for the given period.

pub fn is_campaign_currently_granted(&self, campaign_id: &str) -> bool

Returns if consent to run a campaign was given and is now valid.

Trait Implementations

impl Debug for Consents

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Consents

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Consents> for Consents

fn eq(&self, other: &Consents) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Consents) -> bool

This method tests for !=.

impl Serialize for Consents

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Consents