Skip to content

Readme improvements #728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2019
Merged

Readme improvements #728

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
859a6b0
readme: how to enable auto-upgrade of anonymous users
Johnson145 Jul 10, 2019
c53683f
readme: how to set the privacy policy url
Johnson145 Jul 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion Auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Auth.defaultAuthUI.handleOpenURL(url, sourceApplication: sourceApplication)
We support cross device email link sign in for the normal flows. It is not supported with anonymous user upgrade. By default, cross device support is enabled. You can disable it setting `forceSameDevice` to false in the `FUIEmailAuth` initializer.

## Customizing FirebaseUI for authentication
### Custom terms of Service (ToS) URL
### Custom Terms of Service (ToS) and privacy policy URLs

The Terms of Service URL for your application, which is displayed on the
email/password account creation screen, can be specified as follows:
Expand All @@ -229,6 +229,13 @@ authUI?.tosurl = kFirebaseTermsOfService
authUI.TOSURL = [NSURL URLWithString:@"https://example.com/tos"];
```

The same applies to the URL of your privacy policy:
```swift
// Swift
let kFirebasePrivacyPolicy = URL(string: "https://policies.google.com/privacy")!
authUI?.privacyPolicyURL = kFirebasePrivacyPolicy
```

### Custom strings

You can override the default messages and prompts shown to your users. This can
Expand Down Expand Up @@ -361,6 +368,11 @@ Refer to the Objective-C and Swift samples for examples of how you can customize
these views.

## Handling auto-upgrade of anonymous users
By default, the auto-upgrade of anonymous users is disabled. You can enable it
by simply changing the associated attribute of your Firebase Auth instance:
```swift
authUI?.shouldAutoUpgradeAnonymousUsers = true
```

Enabling auto-upgrade of anonymous users increases the complexity of your auth
flow by adding several more edge cases that need to be handled. As opposed to
Expand Down