Skip to content

Commit f561e54

Browse files
committed
Add link to Track Screenviews dev doc.
1 parent a09d26c commit f561e54

File tree

5 files changed

+8
-1
lines changed

5 files changed

+8
-1
lines changed

packages/analytics-compat/src/service.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@ export class AnalyticsService implements FirebaseAnalytics, _FirebaseService {
4545
logEventExp(this._delegate, eventName as '', eventParams, options);
4646
}
4747

48-
/** @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`. */
48+
/**
49+
* @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
50+
* See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
51+
*/
4952
setCurrentScreen(screenName: string, options?: AnalyticsCallOptions): void {
5053
setCurrentScreenExp(this._delegate, screenName, options);
5154
}

packages/analytics-types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,7 @@ export interface FirebaseAnalytics {
455455
* Use gtag 'config' command to set 'screen_name'.
456456
*
457457
* @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
458+
* See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
458459
*/
459460
setCurrentScreen(screenName: string, options?: AnalyticsCallOptions): void;
460461

packages/analytics/src/api.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ export async function isSupported(): Promise<boolean> {
145145
* @public
146146
*
147147
* @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
148+
* See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
148149
*
149150
* @param analyticsInstance - The {@link Analytics} instance.
150151
* @param screenName - Screen name to set.

packages/analytics/src/functions.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export async function logEvent(
5454
* Set screen_name parameter for this Google Analytics ID.
5555
*
5656
* @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
57+
* See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
5758
*
5859
* @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
5960
* @param screenName Screen name string to set.

packages/firebase/compat/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5217,6 +5217,7 @@ declare namespace firebase.analytics {
52175217
* Use gtag 'config' command to set 'screen_name'.
52185218
*
52195219
* @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
5220+
* See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
52205221
*/
52215222
setCurrentScreen(
52225223
screenName: string,

0 commit comments

Comments
 (0)