kylefang/react-native-firebase
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-firebase.git synced 2026-06-04 19:45:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] docs

Browse Source
This commit is contained in:
ehesp
2019-04-29 17:12:04 +01:00
parent 623a16b812
commit adbb3a52e5
2 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/analytics/lib/index.d.ts vendored
View File

@@ -38,8 +38,6 @@ export namespace Analytics {
/**
* Log a custom event with optional params.
*
* @note 100 characters is the maximum length for param key names.
*
* #### Example
*
* ```js
@@ -48,6 +46,8 @@ export namespace Analytics {
* });
* ```
*
* @note 100 characters is the maximum length for param key names.
*
* @param name Event name must not conflict with any Reserved Events.
* @param params Parameters to be sent and displayed with the event.
*/
@@ -57,8 +57,6 @@ export namespace Analytics {
* If true, allows the device to collect analytical data and send it to Firebase.
* Useful for GDPR.
*
* @note Analytics collection is enabled by default.
*
* #### Example
*
* ```js
@@ -66,6 +64,8 @@ export namespace Analytics {
* await firebase().analytics().setAnalyticsCollectionEnabled(false);
* ```
*
* @note Analytics collection is enabled by default.
*
* @param enabled A boolean value representing whether Analytics collection is enabled or disabled.
*/
setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
@@ -73,16 +73,16 @@ export namespace Analytics {
/**
* Sets the current screen name.
*
* @note Whilst screenClassOverride is optional, it is recommended it is
* always sent as your current class name. For example on Android it will always
* show as 'MainActivity' if you do not specify it.
*
* #### Example
*
* ```js
* await firebase().analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
* ```
*
* @note Whilst screenClassOverride is optional, it is recommended it is
* always sent as your current class name. For example on Android it will always
* show as 'MainActivity' if you do not specify it.
*
* @param screenName A screen name, e.g. Product.
* @param screenClassOverride On Android, React Native runs in a single activity called
* 'MainActivity'. Setting this parameter overrides the default name shown on logs.

16
packages/analytics/lib/index.js.flow
View File

@@ -24,8 +24,6 @@ export interface Module extends ReactNativeFirebaseModule {
/**
* Log a custom event with optional params.
*
* @note 100 characters is the maximum length for param key names.
*
* #### Example
*
* ```js
@@ -34,6 +32,8 @@ export interface Module extends ReactNativeFirebaseModule {
* });
* ```
*
* @note 100 characters is the maximum length for param key names.
*
* @param name Event name must not conflict with any Reserved Events.
* @param params Parameters to be sent and displayed with the event.
*/
@@ -43,8 +43,6 @@ export interface Module extends ReactNativeFirebaseModule {
* If true, allows the device to collect analytical data and send it to Firebase.
* Useful for GDPR.
*
* @note Analytics collection is enabled by default.
*
* #### Example
*
* ```js
@@ -52,6 +50,8 @@ export interface Module extends ReactNativeFirebaseModule {
* await firebase().analytics().setAnalyticsCollectionEnabled(false);
* ```
*
* @note Analytics collection is enabled by default.
*
* @param enabled A boolean value representing whether Analytics collection is enabled or disabled.
*/
setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
@@ -59,16 +59,16 @@ export interface Module extends ReactNativeFirebaseModule {
/**
* Sets the current screen name.
*
* @note Whilst screenClassOverride is optional, it is recommended it is
* always sent as your current class name. For example on Android it will always
* show as 'MainActivity' if you do not specify it.
*
* #### Example
*
* ```js
* await firebase().analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
* ```
*
* @note Whilst screenClassOverride is optional, it is recommended it is
* always sent as your current class name. For example on Android it will always
* show as 'MainActivity' if you do not specify it.
*
* @param screenName A screen name, e.g. Product.
* @param screenClassOverride On Android, React Native runs in a single activity called
* 'MainActivity'. Setting this parameter overrides the default name shown on logs.