kylefang/react-native-firebase
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-firebase.git synced 2026-04-12 22:39:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] docs

Browse Source
This commit is contained in:
ehesp
2019-04-30 09:56:44 +01:00
parent c0c4816983
commit ce186e2dd2
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
packages/invites/lib/index.js.flow
View File

@@ -34,7 +34,7 @@ export interface Statics {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.setAdditionalReferralParameters({
* screen: 'Profile',
* });
@@ -57,7 +57,7 @@ export interface AndroidInviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.setAdditionalReferralParameters({
* screen: 'Profile',
* });
@@ -83,7 +83,7 @@ export interface AndroidInviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.setEmailHtmlContent('<p><strong>Rich HTML content</strong></p>');
* ```
*
@@ -97,7 +97,7 @@ export interface AndroidInviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.emailSubject(`Hey ${user.name}, joint my app!`);
* ```
*
@@ -113,7 +113,7 @@ export interface AndroidInviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.setGoogleAnalyticsTrackingId('UA-1234-5');
* ```
*
@@ -132,7 +132,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.android.setGoogleAnalyticsTrackingId('UA-1234-5');
* ```
*/
@@ -144,7 +144,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.setAndroidClientId('xxxxxxxxxxxx');
* ```
*
@@ -158,7 +158,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.setAndroidMinimumVersionCode(18);
* ```
*
@@ -174,7 +174,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.setCallToActionText('Join the app!');
* ```
*
@@ -188,7 +188,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.setCustomImage('https://my-cdn.com/assets/invites.png');
* ```
*
@@ -204,7 +204,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.deepLink('/invites');
* ```
*
@@ -218,7 +218,7 @@ export interface InviteBuilder {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app with me and share content!');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app with me and share content!');
* invite.setIOSClientId('xxxxxxxxxxxx');
* ```
*
@@ -235,7 +235,7 @@ export interface InviteBuilder {
* When an invitation has been opened from a closed/terminated app.
*
* ```js
* const invite = invites().getInitialInvitation();
* const invite = firebase.invites().getInitialInvitation();
*
* if (invite) {
* console.log('Deeplink: ', invite.deepLink);
@@ -253,7 +253,7 @@ export interface InviteBuilder {
* console.log('ID: ', invitationId);
* }
*
* invites().onInvitation(handleInvitation);
* firebase.invites().onInvitation(handleInvitation);
* ```
*/
export interface NativeInvite {
@@ -274,7 +274,7 @@ export interface NativeInvite {
* #### Example
*
* ```js
* invites().onInvitation((invite) => {
* firebase.invites().onInvitation((invite) => {
* console.log('Deeplink: ', invite.deepLink);
* console.log('ID: ', invite.invitationId);
* });
@@ -289,7 +289,7 @@ export interface Module extends ReactNativeFirebaseModule {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app and share content');
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app and share content');
* ```
*
* @param title The title displayed in the invitation.
@@ -309,7 +309,7 @@ export interface Module extends ReactNativeFirebaseModule {
* console.log('ID: ', invitationId);
* }
*
* const subscriber = invites().onInvitation(handleInvitation);
* const subscriber = firebase.invites().onInvitation(handleInvitation);
*
* // Unsubscribe from invitation listener
* subscriber();
@@ -326,7 +326,7 @@ export interface Module extends ReactNativeFirebaseModule {
* #### Example
*
* ```js
* const invite = invites().getInitialInvitation();
* const invite = firebase.invites().getInitialInvitation();
*
* if (invite) {
* console.log('Deeplink: ', invite.deepLink);
@@ -344,8 +344,8 @@ export interface Module extends ReactNativeFirebaseModule {
* #### Example
*
* ```js
* const invite = invites().createInvitation('Join my app', 'Join my app and share content');
* const ids = await invites().sendInvitation(invite);
* const invite = firebase.invites().createInvitation('Join my app', 'Join my app and share content');
* const ids = await firebase.invites().sendInvitation(invite);
* ```
*
* @param invite The invitation to send. Must be an instance of InviteBuilder