firebase::auth::FederatedAuthProvider::Handler

This is an abstract class.

#include <auth.h>

Handlers for client applications to facilitate federated auth requests on non-mobile systems.

Summary

Constructors and Destructors

~Handler()

Public functions

LinkComplete(AuthCompletionHandle *completion_handle, const AuthenticatedUserData & user_data, AuthError auth_error, const char *error_message)
void
Completion for non-mobile user authorization handlers.
OnLink(const T & provider_data, AuthCompletionHandle *completion_handle)=0
virtual void
Application user account link handler.
OnReauthenticate(const T & provider_data, AuthCompletionHandle *completion_handle)=0
virtual void
Application user re-authentication handler.
OnSignIn(const T & provider_data, AuthCompletionHandle *completion_handle)=0
virtual void
Application sign-in handler.
ReauthenticateComplete(AuthCompletionHandle *completion_handle, const AuthenticatedUserData & user_data, AuthError auth_error, const char *error_message)
void
Completion for non-mobile user authorization handlers.
SignInComplete(AuthCompletionHandle *completion_handle, const AuthenticatedUserData & user_data, AuthError auth_error, const char *error_message)
void
Completion for OnSignIn events.

Public functions

LinkComplete

void LinkComplete(
  AuthCompletionHandle *completion_handle,
  const AuthenticatedUserData & user_data,
  AuthError auth_error,
  const char *error_message
)

Completion for non-mobile user authorization handlers.

Invoke this method once the OnLine process has been fulfilled. This method will trigger the associated Future previously returned from an invocation of User::LinkWithProvider.

See also: OnLink See also: User::LinkWithProvider

Details
Parameters
completion_handle
The handle provided to the application's FederatedAuthProvider::Handler::OnLink method.
user_data
The application's resulting Firebase user values following the user link request.
auth_error
The enumerated status code of the user link request.
error_message
An optional error message to be set in the Future.

OnLink

virtual void OnLink(
  const T & provider_data,
  AuthCompletionHandle *completion_handle
)=0

Application user account link handler.

The application must implement this method to handle federated auth user link requests on non-mobile systems.

See also: User::LinkWithProvider

Details
Parameters
provider_data
Contains information on the provider to authenticate with.
completion_handle
Internal data pertaining to this operation which must be passed to LinkComplete once the handler has completed the user link operation.

OnReauthenticate

virtual void OnReauthenticate(
  const T & provider_data,
  AuthCompletionHandle *completion_handle
)=0

Application user re-authentication handler.

The application must implement this method to handle federated auth user re-authentication requests on non-mobile systems.

See also:User::ReauthenticateWithProviderComplete

Details
Parameters
provider_data
Contains information on the provider to authenticate with.
completion_handle
Internal data pertaining to this operation which must be passed to ReauthenticateComplete once the handler has completed the reauthentication operation.

OnSignIn

virtual void OnSignIn(
  const T & provider_data,
  AuthCompletionHandle *completion_handle
)=0

Application sign-in handler.

The application must implement this method to handle federated auth user sign-in requests on non-mobile systems.

See also: Auth::SignInWithProvider See also: SignInComplete

Details
Parameters
provider_data
Contains information on the provider to authenticate with.
completion_handle
Internal data pertaining to this operation which must be passed to SignInComplete once the handler has completed the sign in operation.

ReauthenticateComplete

void ReauthenticateComplete(
  AuthCompletionHandle *completion_handle,
  const AuthenticatedUserData & user_data,
  AuthError auth_error,
  const char *error_message
)

Completion for non-mobile user authorization handlers.

Invoke this method once the OnReauthenticate process has been fulfilled. This method will trigger the associated Future previously returned from an invocation of User::ReauthenticateWithProvider.

See also:OnReauthenticateSee also:User::ReuthenticateWithProvider

Details
Parameters
completion_handle
The handle provided to the application's FederatedAuthProvider::Handler::OnReauthenticate method.
user_data
The application's resulting Firebase user values following the user re-authentication request.
auth_error
The enumerated status code of the reauthentication request.
error_message
An optional error message to be set in the Future.

SignInComplete

void SignInComplete(
  AuthCompletionHandle *completion_handle,
  const AuthenticatedUserData & user_data,
  AuthError auth_error,
  const char *error_message
)

Completion for OnSignIn events.

Invoke this method once the corresponding OnSignIn has been fulfilled. This method will trigger the associated Future previously returned from the Auth::SignInWithProvider method.

See also: OnSignIn See also: Auth::SignInWithProvider

Details
Parameters
completion_handle
The handle provided to the application's FederatedAuthProvider::Handler::OnSignIn method.
user_data
The application's resulting Firebase user values following the authorization request.
auth_error
The enumerated status code of the authorization request.
error_message
An optional error message to be set in the Future.

~Handler

virtual  ~Handler()