xref: /packages/modules/AdServices/adservices/framework/java/android/app/adservices/IAdServicesManager.aidl

/*
  * Copyright (C) 2022 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

package android.app.adservices;

import android.app.adservices.consent.ConsentParcel;
import android.app.adservices.topics.TopicParcel;

/**
  * AdServices Manager Service
  *
  * {@hide}
  */
interface IAdServicesManager {
    /**
     * Get Consent
     */
    ConsentParcel getConsent(in int consentApiType);

    /**
     * Set Consent
     */
    void setConsent(in ConsentParcel consentParcel);

    /**
     * Saves information to the storage that a deletion of measurement data occurred.
     */
     void recordAdServicesDeletionOccurred(in int deletionType);

     /**
      * Checks whether the module needs to handle data reconciliation after a rollback.
      */
     boolean needsToHandleRollbackReconciliation(in int deletionType);

    /**
     * Saves information to the storage that notification was displayed for the first time to the
     * user.
     */
    void recordNotificationDisplayed();

    /**
     * Returns information whether Consent Notification was displayed or not.
     *
     * @return true if Consent Notification was displayed, otherwise false.
     */
    boolean wasNotificationDisplayed();

    /**
     * Saves information to the storage that GA UX notification was displayed for the
     * first time to the user.
     */
    void recordGaUxNotificationDisplayed();

    /**
     * Returns information whether GA UX Consent Notification was displayed or not.
     *
     * @return true if GA UX Consent Notification was displayed, otherwise false.
     */
    boolean wasGaUxNotificationDisplayed();

    /**
     * Saves information to the storage that user explicitly interacted with consent.
     *
     * Current state:
     * <ul>
     *    <li> -1 means no manual interaction recorded </li>
     *    <li> 0 means no data about interaction </li>
     *    <li> 1 means manual interaction recorded </li>
     * </ul>
     */
    void recordUserManualInteractionWithConsent(in int interactionId);

    /**
     * Returns information about the user's manual interaction with consent.
     * Current state:
     * <ul>
     *    <li> -1 means no manual interaction recorded </li>
     *    <li> 0 means no data about interaction </li>
     *    <li> 1 means manual interaction recorded </li>
     * </ul>
     */
    int getUserManualInteractionWithConsent();

    /**
     * Record a blocked topic.
     */
    void recordBlockedTopic(in List<TopicParcel> blockedTopicParcels);

    /**
     * Remove a blocked topic.
     */
    void removeBlockedTopic(in TopicParcel blockedTopicParcel);

    /**
     * Get all blocked topics.
     */
    List<TopicParcel> retrieveAllBlockedTopics();

    /**
     * Clear all blocked topics.
     */
    void clearAllBlockedTopics();

    /**
      * Saves the PP API default consent of a user.
      */
    void recordDefaultConsent(in boolean defaultConsent);

    /**
      * Saves the topics default consent of a user.
      */
    void recordTopicsDefaultConsent(in boolean defaultConsent);

    /**
      * Saves the FLEDGE default consent of a user.
      */
    void recordFledgeDefaultConsent(in boolean defaultConsent);

    /**
      * Saves the measurement default consent of a user.
      */
    void recordMeasurementDefaultConsent(in boolean defaultConsent);

    /**
      * Saves the default AdId state of a user.
      */
    void recordDefaultAdIdState(in boolean defaultAdIdState);

    /**
      * Returns the PP API default consent of a user.
      *
      * @return true if the PP API default consent is given, false otherwise.
      */
    boolean getDefaultConsent();

    /**
      * Returns the topics default consent of a user.
      *
      * @return true if the topics default consent is given, false otherwise.
      */
    boolean getTopicsDefaultConsent();

    /**
      * Returns the FLEDGE default consent of a user.
      *
      * @return true if the FLEDGE default consent is given, false otherwise.
      */
    boolean getFledgeDefaultConsent();

     /**
       * Returns the measurement default consent of a user.
       *
       * @return true if the measurement default consent is given, false otherwise.
       */
     boolean getMeasurementDefaultConsent();

     /**
       * Returns the default AdId state of a user.
       *
       * @return true if the default AdId state is enabled, false otherwise.
       */
     boolean getDefaultAdIdState();

    String getCurrentPrivacySandboxFeature();

    void setCurrentPrivacySandboxFeature(in String featureType);

    List<String> getKnownAppsWithConsent(in List<String> installedPackages);

    List<String> getAppsWithRevokedConsent(in List<String> installedPackages);

    void setConsentForApp(in String packageName,in int packageUid,in boolean isConsentRevoked);

    void clearKnownAppsWithConsent();

    void clearAllAppConsentData();

    boolean isConsentRevokedForApp(in String packageName,in int packageUid);

    boolean setConsentForAppIfNew(in String packageName,in int packageUid,in boolean isConsentRevoked);

    void clearConsentForUninstalledApp(in String packageName,in int packageUid);

    /** Returns whether the isAdIdEnabled bit is true. */
    boolean isAdIdEnabled();

    /** Saves the isAdIdEnabled bit. */
    void setAdIdEnabled(boolean isAdIdEnabled);

    /** Returns whether the isU18Account bit is true. */
    boolean isU18Account();

    /** Saves the isU18Account bit. */
    void setU18Account(boolean isU18Account);

    /** Returns whether the isEntryPointEnabled bit is true. */
    boolean isEntryPointEnabled();

    /** Saves the isEntryPointEnabled bit. */
    void setEntryPointEnabled(boolean isEntryPointEnabled);

    /** Returns whether the isAdultAccount bit is true. */
    boolean isAdultAccount();

    void setAdultAccount(boolean isAdultAccount);

    /** Returns whether the wasU18NotificationDisplayed bit is true. */
    boolean wasU18NotificationDisplayed();

    /** Saves the wasU18NotificationDisplayed bit. */
    void setU18NotificationDisplayed(boolean wasU18NotificationDisplayed);

}