Skip to content

Commit

Permalink
Update readme with doNotRedirect documentation
Browse files Browse the repository at this point in the history
Update the readme to include documentation on the functionality of the
doNotRedirect parameter for logoutConfirmed.
  • Loading branch information
justinsa committed Oct 24, 2017
1 parent b9cb59f commit 0578e72
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,13 @@ $authentication.loginRequired();
```
Broadcast via: ```event:auth-loginRequired```.

### logoutConfirmed()
### logoutConfirmed(doNotRedirect)
```JAVASCRIPT
// Remove any existing profile from local storage, notify all listeners of logout, and redirect to:
// 1. lastAttemptedUrl if defined and trackLastAttemptedUrl is true
// 2. onLogoutRedirectUrl if defined
// 3. do not redirect
// 1. do not redirect if @doNotRedirect === true
// 2. lastAttemptedUrl if defined and trackLastAttemptedUrl is true
// 3. onLogoutRedirectUrl if defined
// 4. do not redirect
$authentication.logoutConfirmed();
```
Broadcast via: ```event:auth-logoutConfirmed```.
Expand Down

0 comments on commit 0578e72

Please sign in to comment.