Skip to content

Commit baaeccf

Browse files
committed
Adding more API to the docs
1 parent ff65db8 commit baaeccf

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

docs/analytics/getting-started.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# Getting started with Google Analytics
22

3-
`AngularFireAnalytics` dynamic imports the `firebase/analytics` library and provides a promisified version of the [Firebase Analytics SDK (`firebase.analytics.Analytics`)](https://firebase.google.com/docs/reference/js/firebase.analytics.Analytics.html).
3+
`AngularFireAnalytics` dynamically imports the `firebase/analytics` library and provides a promisified version of the [Firebase Analytics SDK (`firebase.analytics.Analytics`)](https://firebase.google.com/docs/reference/js/firebase.analytics.Analytics.html).
4+
5+
### API:
6+
7+
```ts
8+
class AngularFireAnalytics {
9+
updateConfig(options: {[key:string]: any}): Promise<void>;
10+
11+
// from firebase.analytics() proxy:
12+
logEvent(eventName: string, eventParams?: {[key: string]: any}, options?: analytics.AnalyticsCallOptions): Promise<void>;
13+
setCurrentScreen(screenName: string, options?: analytics.AnalyticsCallOptions): Promise<void>;
14+
setUserId(id: string, options?: analytics.AnalyticsCallOptions): Promise<void>;
15+
setUserProperties(properties: analytics.CustomParams, options?: analytics.AnalyticsCallOptions): Promise<void>;
16+
setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
17+
app: Promise<app.App>;
18+
}
19+
20+
COLLECTION_ENABLED = InjectionToken<boolean>;
21+
APP_VERSION = InjectionToken<string>;
22+
APP_NAME = InjectionToken<string>;
23+
DEBUG_MODE = InjectionToken<boolean>;
24+
CONFIG = InjectionToken<Config>;
25+
```
426

527
### Usage:
628

docs/remote-config/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
### API:
66

77
```ts
8+
class AngularFireRemoteConfigModule { }
9+
810
interface ConfigTemplate {[key:string]: string|number|boolean}
911

1012
type Parameter extends remoteConfig.Value {
@@ -43,8 +45,12 @@ budget: <T>(interval: number) => MonoTypeOperatorFunction<T>
4345

4446
// scanToObject is for use with .changes
4547
scanToObject: () => OperatorFunction<Parameter, {[key: string]: string|undefined}>
48+
4649
// mapToObject is the same behavior are scanToObject but for use with .parameters,
4750
mapToObject: () => OperatorFunction<Parameter[], {[key: string]: string|undefined}>
51+
52+
SETTINGS = InjectionToken<remoteConfig.Settings>;
53+
DEFAULTS = InjectionToken<ConfigTemplate>;
4854
```
4955

5056
## Configuration with Dependency Injection

0 commit comments

Comments
 (0)