Package com.mongodb.stitch.android.core.auth

Interface StitchAuthListener

All Known Implementing Classes:

StitchAppClientImpl

public interface StitchAuthListener

StitchAuthListener listens to a StitchAuth instance for authentication events as they happen in a StitchAppClient.

The listener can be added with StitchAuth.addAuthListener(com.mongodb.stitch.android.core.auth.StitchAuthListener).

See Also:

StitchAuth, StitchAppClient

Method Summary

Modifier and Type	Method	Description
default void	onActiveUserChanged(StitchAuth auth, StitchUser currentActiveUser, StitchUser previousActiveUser)	Called whenever the active user changes.
default void	onAuthEvent(StitchAuth auth)	Deprecated.
default void	onListenerRegistered(StitchAuth auth)	Called whenever this listener is registered for the first time.
default void	onUserAdded(StitchAuth auth, StitchUser addedUser)	Called whenever a user is added to the device for the first time.
default void	onUserLinked(StitchAuth auth, StitchUser linkedUser)	Called whenever a user is linked to a new identity, as in StitchUser.linkWithCredential(com.mongodb.stitch.core.auth.StitchCredential).
default void	onUserLoggedIn(StitchAuth auth, StitchUser loggedInUser)	Called whenever a user is logged in.
default void	onUserLoggedOut(StitchAuth auth, StitchUser loggedOutUser)	Called whenever a user is logged out.
default void	onUserRemoved(StitchAuth auth, StitchUser removedUser)	Called whenever a user is removed from the list of users on the device.

Method Detail

onAuthEvent

@Deprecated
default void onAuthEvent(StitchAuth auth)

Deprecated.

onAuthEvent is called any time a notable event regarding authentication happens. Some of these events are:

• When a user logs in.
• When a user logs out.
• When a user is linked to another identity, i.e. with StitchUser.linkWithCredential(com.mongodb.stitch.core.auth.StitchCredential).
• When a listener is registered. This is to handle the case where during registration an event happens that the registerer would otherwise miss out on.
• When switching active users, e.g. with StitchAuth.switchToUserWithId(java.lang.String) or when another user logs in.

Parameters:

auth - the instance of StitchAuth where the event happened. It should be used to infer the current state of authentication.

onUserAdded

default void onUserAdded(StitchAuth auth,
                         StitchUser addedUser)

Called whenever a user is added to the device for the first time.

If this is as part of a login, this method will be called before onUserLoggedIn(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser), and onActiveUserChanged(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser, com.mongodb.stitch.android.core.auth.StitchUser) are called.

Parameters:

auth - The instance of StitchAuth where the user was added. It can be used to infer the current state of authentication.

addedUser - The user that was added to the device.

See Also:

StitchAuth.listUsers()

onUserLoggedIn

default void onUserLoggedIn(StitchAuth auth,
                            StitchUser loggedInUser)

Called whenever a user is logged in. This will be called before onActiveUserChanged(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser, com.mongodb.stitch.android.core.auth.StitchUser) is called.

Note: if an anonymous user was already logged in on the device, and you log in with an AnonymousCredential, this method will not be called, as the underlying StitchAuth will reuse the anonymous user's existing session, and will thus only trigger onActiveUserChanged(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser, com.mongodb.stitch.android.core.auth.StitchUser).

Parameters:

auth - The instance of StitchAuth where the user was logged in. It can be used to infer the current state of authentication.

loggedInUser - The user that was logged in.

onUserLinked

default void onUserLinked(StitchAuth auth,
                          StitchUser linkedUser)

Called whenever a user is linked to a new identity, as in StitchUser.linkWithCredential(com.mongodb.stitch.core.auth.StitchCredential).

Parameters:

auth - The instance of StitchAuth where the user was linked. It can be used to infer the current state of authentication.

linkedUser - The user that was linked to a new identity.

onUserLoggedOut

default void onUserLoggedOut(StitchAuth auth,
                             StitchUser loggedOutUser)

Called whenever a user is logged out.

The user logged out is not necessarily the active user. If the user logged out was the active user, then onActiveUserChanged(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser, com.mongodb.stitch.android.core.auth.StitchUser) will be called after this method.

If the user was an anonymous user, that user will also be removed and onUserRemoved(com.mongodb.stitch.android.core.auth.StitchAuth, com.mongodb.stitch.android.core.auth.StitchUser) will also be called.

Parameters:

auth - The instance of StitchAuth where the user was logged out. It can be used to infer the current state of authentication.

loggedOutUser - The user that was logged out.

onActiveUserChanged

default void onActiveUserChanged(StitchAuth auth,
                                 @Nullable
                                 StitchUser currentActiveUser,
                                 @Nullable
                                 StitchUser previousActiveUser)

Called whenever the active user changes.

This may be due to a call to:

• StitchAuth.loginWithCredential(com.mongodb.stitch.core.auth.StitchCredential)
• StitchAuth.switchToUserWithId(java.lang.String)
• StitchAuth.logout()
• StitchAuth.logoutUserWithId(java.lang.String)
• StitchAuth.removeUser()
• StitchAuth.removeUserWithId(java.lang.String), or
• Another method that issues a request, if the user's session is invalidated and they are forced to log out.

Parameters:

auth - The instance of StitchAuth where the active user changed. It can be used to infer the current state of authentication.

currentActiveUser - The active user after the change.

previousActiveUser - The active user before the change.

onUserRemoved

default void onUserRemoved(StitchAuth auth,
                           StitchUser removedUser)

Called whenever a user is removed from the list of users on the device.

Parameters:

auth - The instance of StitchAuth where the user was removed. It can be used to infer the current state of authentication.

removedUser - The user that was removed.

See Also:

StitchAuth.listUsers()

onListenerRegistered

default void onListenerRegistered(StitchAuth auth)

Called whenever this listener is registered for the first time.

This can be useful to infer the state of authentication, because any events that occurred before the listener was registered will not be seen by the listener.

Parameters:

auth - The instance of StitchAuth where the listener was registered. It can be used to infer the current state of authentication.

See Also:

StitchAuth.addAuthListener(com.mongodb.stitch.android.core.auth.StitchAuthListener)