@adobe/ccweb-add-on-analytics/dist/app/AnalyticsConsent.d.ts

Analytics libraries for Adobe Creative Cloud Web Add-on.

/********************************************************************************
 * MIT License

 * © Copyright 2023 Adobe. All rights reserved.

 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 ********************************************************************************/
import type { Logger } from "@adobe/ccweb-add-on-core";
import { UserPreferences } from "@adobe/ccweb-add-on-core";
import "reflect-metadata";
/**
 * Implementation class to get and set user's consent
 * on allowing the application to collect and send analytics to Adobe.
 */
export declare class AnalyticsConsent {
    private readonly _preferences;
    private readonly _logger;
    /**
     * Instantiate {@link AnalyticsConsent}.
     * @param preferences - {@link UserPreferences} reference.
     * @param logger - {@link Logger} reference.
     * @returns Reference to a new {@link AnalyticsConsent} instance.
     */
    constructor(preferences: UserPreferences, logger: Logger);
    /**
     * Get user consent to collect and send analytics to Adobe.
     * @returns Promise of boolean value representing whether the user has provided consent.
     */
    get(): Promise<boolean>;
    /**
     * Set user consent to collect and send analytics to Adobe.
     * @param consent - Boolean value representing whether the user has provided consent.
     */
    set(consent: boolean): Promise<void>;
    private _promptMessage;
    private _promptMessageOption;
}
//# sourceMappingURL=AnalyticsConsent.d.ts.map