com.firebase.ui.auth.core

Class FirebaseLoginBaseActivity

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.view.ContextThemeWrapper

android.app.Activity

android.support.v4.app.FragmentActivity

android.support.v7.app.AppCompatActivity

com.firebase.ui.auth.core.FirebaseLoginBaseActivity

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.support.v4.app.TaskStackBuilder.SupportParentable, android.support.v7.app.ActionBarDrawerToggle.DelegateProvider, android.support.v7.app.AppCompatCallback, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.LayoutInflater.Factory2, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback

public abstract class FirebaseLoginBaseActivity
extends android.support.v7.app.AppCompatActivity

You can subclass this activity in your app to easily get authentication working. If you already have a base class and cannot switch, copy the relevant parts of this base activity into your own activity.

Field Summary

Fields inherited from class android.app.Activity

DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, FOCUSED_STATE_SET, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
FirebaseLoginBaseActivity()

Method Summary

Methods

Modifier and Type	Method and Description
void	dismissFirebaseLoginPrompt()
com.firebase.client.AuthData	getAuth() Returns the data for the currently authenticated users, or null if no user is authenticated.
protected abstract com.firebase.client.Firebase	getFirebaseRef() Subclasses of this activity must implement this method and return a valid Firebase reference that can be used to call authentication related methods on.
void	logout() Calling this method will log out the currently authenticated user.
void	onActivityResult(int requestCode, int resultCode, android.content.Intent data)
protected void	onDestroy()
protected void	onFirebaseLoggedIn(com.firebase.client.AuthData authData) Subclasses of this activity may implement this method to handle when a user logs in.
protected void	onFirebaseLoggedOut() Subclasses of this activity may implement this method to handle when a user logs out.
protected abstract void	onFirebaseLoginProviderError(FirebaseLoginError firebaseError) Subclasses of this activity should implement this method to handle any potential provider errors like OAuth or other internal errors.
protected abstract void	onFirebaseLoginUserError(FirebaseLoginError firebaseError) Subclasses of this activity should implement this method to handle any potential user errors like entering an incorrect password or closing the login dialog.
protected void	onPause()
protected void	onStart()
protected void	onStop()
void	resetFirebaseLoginPrompt()
void	setEnabledAuthProvider(AuthProviderType provider) Enables authentication with the specified provider.
void	showFirebaseLoginPrompt() Calling this method displays the Firebase login dialog over the current activity, allowing the user to authenticate with any of the configured providers.

Methods inherited from class android.support.v7.app.AppCompatActivity

addContentView, getDelegate, getDrawerToggleDelegate, getMenuInflater, getSupportActionBar, getSupportParentActivityIntent, invalidateOptionsMenu, onConfigurationChanged, onContentChanged, onCreate, onCreateSupportNavigateUpTaskStack, onMenuItemSelected, onPostCreate, onPostResume, onPrepareSupportNavigateUpTaskStack, onSupportActionModeFinished, onSupportActionModeStarted, onSupportContentChanged, onSupportNavigateUp, onTitleChanged, onWindowStartingSupportActionMode, setContentView, setContentView, setContentView, setSupportActionBar, setSupportProgress, setSupportProgressBarIndeterminate, setSupportProgressBarIndeterminateVisibility, setSupportProgressBarVisibility, startSupportActionMode, supportInvalidateOptionsMenu, supportNavigateUpTo, supportRequestWindowFeature, supportShouldUpRecreateTask

Methods inherited from class android.support.v4.app.FragmentActivity

dump, getLastCustomNonConfigurationInstance, getSupportFragmentManager, getSupportLoaderManager, onAttachFragment, onBackPressed, onCreatePanelMenu, onCreateView, onKeyDown, onLowMemory, onNewIntent, onPanelClosed, onPrepareOptionsPanel, onPreparePanel, onResume, onResumeFragments, onRetainCustomNonConfigurationInstance, onRetainNonConfigurationInstance, onSaveInstanceState, setEnterSharedElementCallback, setExitSharedElementCallback, startActivityForResult, startActivityFromFragment, supportFinishAfterTransition, supportPostponeEnterTransition, supportStartPostponedEnterTransition

Methods inherited from class android.app.Activity

closeContextMenu, closeOptionsMenu, createPendingResult, dismissDialog, dispatchGenericMotionEvent, dispatchKeyEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, findViewById, finish, finishActivity, finishActivityFromChild, finishAffinity, finishAfterTransition, finishAndRemoveTask, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getContentScene, getContentTransitionManager, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMediaController, getParent, getParentActivityIntent, getPreferences, getReferrer, getRequestedOrientation, getSystemService, getTaskId, getTitle, getTitleColor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, isChangingConfigurations, isChild, isDestroyed, isFinishing, isImmersive, isTaskRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onActivityReenter, onApplyThemeResource, onAttachedToWindow, onAttachFragment, onChildTitleChanged, onContextItemSelected, onContextMenuClosed, onCreate, onCreateContextMenu, onCreateDescription, onCreateDialog, onCreateDialog, onCreateNavigateUpTaskStack, onCreateOptionsMenu, onCreatePanelView, onCreateThumbnail, onCreateView, onDetachedFromWindow, onEnterAnimationComplete, onGenericMotionEvent, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onMenuOpened, onNavigateUp, onNavigateUpFromChild, onOptionsItemSelected, onOptionsMenuClosed, onPostCreate, onPrepareDialog, onPrepareDialog, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onProvideAssistData, onRestart, onRestoreInstanceState, onRestoreInstanceState, onSaveInstanceState, onSearchRequested, onTouchEvent, onTrackballEvent, onTrimMemory, onUserInteraction, onUserLeaveHint, onVisibleBehindCanceled, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, openContextMenu, openOptionsMenu, overridePendingTransition, postponeEnterTransition, recreate, registerForContextMenu, releaseInstance, removeDialog, reportFullyDrawn, requestVisibleBehind, requestWindowFeature, runOnUiThread, setActionBar, setContentTransitionManager, setDefaultKeyMode, setEnterSharedElementCallback, setExitSharedElementCallback, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setImmersive, setIntent, setMediaController, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setTaskDescription, setTitle, setTitle, setTitleColor, setVisible, setVolumeControlStream, shouldUpRecreateTask, showDialog, showDialog, startActionMode, startActivities, startActivities, startActivity, startActivity, startActivityForResult, startActivityFromChild, startActivityFromChild, startActivityFromFragment, startActivityFromFragment, startActivityIfNeeded, startActivityIfNeeded, startIntentSender, startIntentSender, startIntentSenderForResult, startIntentSenderForResult, startIntentSenderFromChild, startIntentSenderFromChild, startLockTask, startManagingCursor, startNextMatchingActivity, startNextMatchingActivity, startPostponedEnterTransition, startSearch, stopLockTask, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu

Methods inherited from class android.view.ContextThemeWrapper

applyOverrideConfiguration, attachBaseContext, getResources, getTheme, setTheme

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getSharedPreferences, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, setWallpaper, startInstrumentation, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getDrawable, getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirebaseLoginBaseActivity

public FirebaseLoginBaseActivity()

Method Detail

getFirebaseRef

protected abstract com.firebase.client.Firebase getFirebaseRef()

Subclasses of this activity must implement this method and return a valid Firebase reference that can be used to call authentication related methods on. The method is guaranteed *not* to be called before onCreate() has finished.

Returns:

a Firebase reference that can be used to call authentication related methods on

getAuth

public com.firebase.client.AuthData getAuth()

Returns the data for the currently authenticated users, or null if no user is authenticated.

Returns:

the data for the currently authenticated users, or null if no user is authenticated.

onFirebaseLoggedIn

protected void onFirebaseLoggedIn(com.firebase.client.AuthData authData)

Subclasses of this activity may implement this method to handle when a user logs in.

onFirebaseLoggedOut

protected void onFirebaseLoggedOut()

Subclasses of this activity may implement this method to handle when a user logs out.

onFirebaseLoginProviderError

protected abstract void onFirebaseLoginProviderError(FirebaseLoginError firebaseError)

Subclasses of this activity should implement this method to handle any potential provider errors like OAuth or other internal errors.

onFirebaseLoginUserError

protected abstract void onFirebaseLoginUserError(FirebaseLoginError firebaseError)

Subclasses of this activity should implement this method to handle any potential user errors like entering an incorrect password or closing the login dialog.

logout

public void logout()

Calling this method will log out the currently authenticated user. It is only legal to call this method after the `onStart()` method has completed.

onActivityResult

public void onActivityResult(int requestCode,
                    int resultCode,
                    android.content.Intent data)

Overrides:

onActivityResult in class android.support.v4.app.FragmentActivity

showFirebaseLoginPrompt

public void showFirebaseLoginPrompt()

Calling this method displays the Firebase login dialog over the current activity, allowing the user to authenticate with any of the configured providers. It is only legal to call this method after the `onStart()` method has completed.

dismissFirebaseLoginPrompt

public void dismissFirebaseLoginPrompt()

resetFirebaseLoginPrompt

public void resetFirebaseLoginPrompt()

setEnabledAuthProvider

public void setEnabledAuthProvider(AuthProviderType provider)

Enables authentication with the specified provider.

Parameters:

provider - the provider to enable.

onStart

protected void onStart()

Overrides:

onStart in class android.support.v4.app.FragmentActivity

onStop

protected void onStop()

Overrides:

onStop in class android.support.v7.app.AppCompatActivity

onPause

protected void onPause()

Overrides:

onPause in class android.support.v4.app.FragmentActivity

onDestroy

protected void onDestroy()

Overrides:

onDestroy in class android.support.v7.app.AppCompatActivity