mirror of
https://github.com/musix-org/musix-oss
synced 2025-04-03 20:53:29 +00:00
53 lines
2.4 KiB
TypeScript
53 lines
2.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google Inc.
|
|
*
|
|
* 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.
|
|
*/
|
|
import { AnalyticsCallOptions, Gtag, CustomParams, EventParams } from '@firebase/analytics-types';
|
|
/**
|
|
* Logs an analytics event through the Firebase SDK.
|
|
*
|
|
* @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
|
|
* @param eventName Google Analytics event name, choose from standard list or use a custom string.
|
|
* @param eventParams Analytics event parameters.
|
|
*/
|
|
export declare function logEvent(gtagFunction: Gtag, analyticsId: string, eventName: string, eventParams?: EventParams, options?: AnalyticsCallOptions): void;
|
|
/**
|
|
* Set screen_name parameter for this Google Analytics ID.
|
|
*
|
|
* @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
|
|
* @param screenName Screen name string to set.
|
|
*/
|
|
export declare function setCurrentScreen(gtagFunction: Gtag, analyticsId: string, screenName: string | null, options?: AnalyticsCallOptions): void;
|
|
/**
|
|
* Set user_id parameter for this Google Analytics ID.
|
|
*
|
|
* @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
|
|
* @param id User ID string to set
|
|
*/
|
|
export declare function setUserId(gtagFunction: Gtag, analyticsId: string, id: string | null, options?: AnalyticsCallOptions): void;
|
|
/**
|
|
* Set all other user properties other than user_id and screen_name.
|
|
*
|
|
* @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
|
|
* @param properties Map of user properties to set
|
|
*/
|
|
export declare function setUserProperties(gtagFunction: Gtag, analyticsId: string, properties: CustomParams, options?: AnalyticsCallOptions): void;
|
|
/**
|
|
* Set whether collection is enabled for this ID.
|
|
*
|
|
* @param enabled If true, collection is enabled for this ID.
|
|
*/
|
|
export declare function setAnalyticsCollectionEnabled(analyticsId: string, enabled: boolean): void;
|