-
-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
693 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,152 @@ | ||
| export interface FirebaseAnalyticsPlugin { | ||
| /** | ||
| * Sets the user ID property. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| setUserId(options: SetUserIdOptions): Promise<void>; | ||
| /** | ||
| * Sets a custom user property to a given value. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| setUserProperty(options: SetUserPropertyOptions): Promise<void>; | ||
| /** | ||
| * Sets the current screen name. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| setCurrentScreen(options: SetCurrentScreenOptions): Promise<void>; | ||
| /** | ||
| * Logs an app event. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| logEvent(options: LogEventOptions): Promise<void>; | ||
| /** | ||
| * Sets the duration of inactivity that terminates the current session. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| setSessionTimeoutDuration( | ||
| options: SetSessionTimeoutDurationOptions, | ||
| ): Promise<void>; | ||
| /** | ||
| * Enables/disables automatic data collection. | ||
| * The value does not apply until the next run of the app. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| setEnabled(options: SetEnabledOptions): Promise<void>; | ||
| /** | ||
| * Returns whether or not automatic data collection is enabled. | ||
| * | ||
| * Only available for Web. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| isEnabled(): Promise<IsEnabledResult>; | ||
| /** | ||
| * Clears all analytics data for this app from the device. | ||
| * Resets the app instance id. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| resetAnalyticsData(): Promise<void>; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface SetUserIdOptions { | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| userId: string | null; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface SetUserPropertyOptions { | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| key: string; | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| value: string | null; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface SetCurrentScreenOptions { | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| screenName: string | null; | ||
| /** | ||
| * Only available for Android and iOS. | ||
| * | ||
| * Default: `null` | ||
| * @default null | ||
| * @since 0.1.0 | ||
| */ | ||
| screenClassOverride?: string | null; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface LogEventOptions { | ||
| /** | ||
| * The event name. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| name: string; | ||
| /** | ||
| * The optional event params. | ||
| * | ||
| * @since 0.1.0 | ||
| */ | ||
| params?: { [key: string]: any }; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface SetSessionTimeoutDurationOptions { | ||
| /** | ||
| * Duration in seconds. | ||
| * | ||
| * Default: `1800` (30 minutes) | ||
| * @default 1800 | ||
| * @since 0.1.0 | ||
| */ | ||
| duration: number; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface SetEnabledOptions { | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| enabled: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| export interface IsEnabledResult { | ||
| /** | ||
| * @since 0.1.0 | ||
| */ | ||
| enabled: boolean; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.