spotify-api-kotlin/com.adamratzman.spotify.auth.implicit/AbstractSpotifyAppCompatImplicitLoginActivity

AbstractSpotifyAppCompatImplicitLoginActivity

abstract class AbstractSpotifyAppCompatImplicitLoginActivity : AppCompatActivity, SpotifyImplicitLoginActivity(source)

Wrapper around spotify-auth's LoginActivity that allows configuration of the authentication process, along with callbacks on successful and failed authentication. Pair this with SpotifyDefaultCredentialStore to easily store credentials. Inherits from AppCompatActivity. If instead you want to inherit from Activity, please use AbstractSpotifyAppImplicitLoginActivity.

Constructors

constructor()

Properties

activity

open override val activity: Activity

activityResultRegistry

@get:NonNull

override val activityResultRegistry: ActivityResultRegistry

clientId

abstract val clientId: String

Your application's Spotify client id.

defaultViewModelCreationExtras

@get:NonNull

@get:CallSuper

open override val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

@get:NonNull

open override val defaultViewModelProviderFactory: ViewModelProvider.Factory

fullyDrawnReporter

@get:NonNull

open override val fullyDrawnReporter: FullyDrawnReporter

lifecycle

@get:NonNull

open override val lifecycle: Lifecycle

onBackPressedDispatcher

@get:NonNull

override val onBackPressedDispatcher: OnBackPressedDispatcher

redirectUri

abstract val redirectUri: String

Your application's Spotify redirect id - NOTE that this should be an android scheme (such as spotifyapp://authback) and that this must be registered in your manifest.

savedStateRegistry

@get:NonNull

override val savedStateRegistry: SavedStateRegistry

state

abstract val state: Int

The state to use to verify the login request.

useDefaultRedirectHandler

open override val useDefaultRedirectHandler: Boolean = true

Disable if you will not be using useDefaultRedirectHandler but will be setting SpotifyDefaultImplicitAuthHelper.activityBackOnImplicitAuth.

viewModelStore

@get:NonNull

open override val viewModelStore: ViewModelStore

Functions

addContentView

open override fun addContentView(p0: View, p1: ViewGroup.LayoutParams)

addMenuProvider

open override fun addMenuProvider(@NonNull p0: MenuProvider)

open override fun addMenuProvider(@NonNull p0: MenuProvider, @NonNull p1: LifecycleOwner)

open override fun addMenuProvider(@NonNull p0: MenuProvider, @NonNull p1: LifecycleOwner, @NonNull p2: Lifecycle.State)

addOnConfigurationChangedListener

override fun addOnConfigurationChangedListener(@NonNull p0: Consumer<Configuration>)

addOnContextAvailableListener

override fun addOnContextAvailableListener(@NonNull listener: OnContextAvailableListener)

addOnMultiWindowModeChangedListener

override fun addOnMultiWindowModeChangedListener(@NonNull p0: Consumer<MultiWindowModeChangedInfo>)

addOnNewIntentListener

override fun addOnNewIntentListener(@NonNull p0: Consumer<Intent>)

addOnPictureInPictureModeChangedListener

override fun addOnPictureInPictureModeChangedListener(@NonNull p0: Consumer<PictureInPictureModeChangedInfo>)

addOnTrimMemoryListener

override fun addOnTrimMemoryListener(@NonNull p0: Consumer<Int>)

applyOverrideConfiguration

open fun applyOverrideConfiguration(p0: Configuration)

bindIsolatedService

open override fun bindIsolatedService(p0: Intent, p1: Int, p2: String, p3: Executor, p4: ServiceConnection): Boolean

bindService

open override fun bindService(p0: Intent, p1: ServiceConnection, p2: Int): Boolean

open override fun bindService(p0: Intent, p1: Int, p2: Executor, p3: ServiceConnection): Boolean

bindServiceAsUser

open override fun bindServiceAsUser(p0: Intent, p1: ServiceConnection, p2: Int, p3: UserHandle): Boolean

checkCallingOrSelfPermission

open override fun checkCallingOrSelfPermission(p0: String): Int

checkCallingOrSelfUriPermission

open override fun checkCallingOrSelfUriPermission(p0: Uri, p1: Int): Int

checkCallingOrSelfUriPermissions

open override fun checkCallingOrSelfUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkCallingPermission

open override fun checkCallingPermission(p0: String): Int

checkCallingUriPermission

open override fun checkCallingUriPermission(p0: Uri, p1: Int): Int

checkCallingUriPermissions

open override fun checkCallingUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkPermission

open override fun checkPermission(p0: String, p1: Int, p2: Int): Int

checkSelfPermission

open override fun checkSelfPermission(p0: String): Int

checkUriPermission

open override fun checkUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int): Int

open override fun checkUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int): Int

checkUriPermissions

open override fun checkUriPermissions(p0: MutableList<Uri>, p1: Int, p2: Int, p3: Int): IntArray

closeContextMenu

open fun closeContextMenu()

closeOptionsMenu

open override fun closeOptionsMenu()

createAttributionContext

open override fun createAttributionContext(p0: String?): Context

createConfigurationContext

open override fun createConfigurationContext(p0: Configuration): Context

createContext

open override fun createContext(p0: ContextParams): Context

createContextForSplit

open override fun createContextForSplit(p0: String): Context

createDeviceProtectedStorageContext

open override fun createDeviceProtectedStorageContext(): Context

createDisplayContext

open override fun createDisplayContext(p0: Display): Context

createPackageContext

open override fun createPackageContext(p0: String, p1: Int): Context

createPendingResult

open fun createPendingResult(p0: Int, p1: Intent, p2: Int): PendingIntent

createWindowContext

open override fun createWindowContext(p0: Int, p1: Bundle?): Context

open override fun createWindowContext(p0: Display, p1: Int, p2: Bundle?): Context

databaseList

open override fun databaseList(): Array<String>

deleteDatabase

open override fun deleteDatabase(p0: String): Boolean

deleteFile

open override fun deleteFile(p0: String): Boolean

deleteSharedPreferences

open override fun deleteSharedPreferences(p0: String): Boolean

dismissKeyboardShortcutsHelper

fun dismissKeyboardShortcutsHelper()

dispatchGenericMotionEvent

open override fun dispatchGenericMotionEvent(p0: MotionEvent): Boolean

dispatchKeyEvent

open override fun dispatchKeyEvent(p0: KeyEvent): Boolean

dispatchKeyShortcutEvent

open override fun dispatchKeyShortcutEvent(p0: KeyEvent): Boolean

dispatchPopulateAccessibilityEvent

open override fun dispatchPopulateAccessibilityEvent(p0: AccessibilityEvent): Boolean

dispatchTouchEvent

open override fun dispatchTouchEvent(p0: MotionEvent): Boolean

dispatchTrackballEvent

open override fun dispatchTrackballEvent(p0: MotionEvent): Boolean

dump

open override fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)

enforceCallingOrSelfPermission

open override fun enforceCallingOrSelfPermission(p0: String, p1: String?)

enforceCallingOrSelfUriPermission

open override fun enforceCallingOrSelfUriPermission(p0: Uri, p1: Int, p2: String)

enforceCallingPermission

open override fun enforceCallingPermission(p0: String, p1: String?)

enforceCallingUriPermission

open override fun enforceCallingUriPermission(p0: Uri, p1: Int, p2: String)

enforcePermission

open override fun enforcePermission(p0: String, p1: Int, p2: Int, p3: String?)

enforceUriPermission

open override fun enforceUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int, p4: String)

open override fun enforceUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int, p6: String?)

enterPictureInPictureMode

open fun enterPictureInPictureMode(p0: PictureInPictureParams): Boolean

fileList

open override fun fileList(): Array<String>

findViewById

open override fun <T : View> findViewById(@IdRes p0: Int): T

finish

open fun finish()

finishActivity

open fun finishActivity(p0: Int)

finishAffinity

open fun finishAffinity()

finishAfterTransition

open fun finishAfterTransition()

finishAndRemoveTask

open fun finishAndRemoveTask()

getActionBar

open fun getActionBar(): ActionBar?

getApplication

fun getApplication(): Application

getApplicationContext

open override fun getApplicationContext(): Context

getApplicationInfo

open override fun getApplicationInfo(): ApplicationInfo

getAssets

open override fun getAssets(): AssetManager

getAttributionSource

open override fun getAttributionSource(): AttributionSource

getAttributionTag

open override fun getAttributionTag(): String?

getBaseContext

open fun getBaseContext(): Context

getCacheDir

open override fun getCacheDir(): File

getCallingActivity

open fun getCallingActivity(): ComponentName?

getCallingPackage

open fun getCallingPackage(): String?

getChangingConfigurations

open fun getChangingConfigurations(): Int

getClassLoader

open override fun getClassLoader(): ClassLoader

getCodeCacheDir

open override fun getCodeCacheDir(): File

getColor

fun getColor(p0: Int): Int

getColorStateList

fun getColorStateList(p0: Int): ColorStateList

getComponentName

open fun getComponentName(): ComponentName

getContentResolver

open override fun getContentResolver(): ContentResolver

getContentScene

open fun getContentScene(): Scene

getContentTransitionManager

open fun getContentTransitionManager(): TransitionManager

getCurrentFocus

open fun getCurrentFocus(): View?

getDatabasePath

open override fun getDatabasePath(p0: String): File

getDataDir

open override fun getDataDir(): File

getDelegate

@NonNull

open fun getDelegate(): AppCompatDelegate

getDir

open override fun getDir(p0: String, p1: Int): File

getDisplay

open override fun getDisplay(): Display?

getDrawable

fun getDrawable(p0: Int): Drawable?

getDrawerToggleDelegate

@Nullable

open override fun getDrawerToggleDelegate(): ActionBarDrawerToggle.Delegate?

getExternalCacheDir

open override fun getExternalCacheDir(): File?

getExternalCacheDirs

open override fun getExternalCacheDirs(): Array<File>

getExternalFilesDir

open override fun getExternalFilesDir(p0: String?): File?

getExternalFilesDirs

open override fun getExternalFilesDirs(p0: String): Array<File>

getExternalMediaDirs

open override fun getExternalMediaDirs(): Array<File>

getFilesDir

open override fun getFilesDir(): File

getFileStreamPath

open override fun getFileStreamPath(p0: String): File

getIntent

open fun getIntent(): Intent

getLastNonConfigurationInstance

open fun getLastNonConfigurationInstance(): Any?

getLayoutInflater

open fun getLayoutInflater(): LayoutInflater

getLocalClassName

open fun getLocalClassName(): String

getMainExecutor

open override fun getMainExecutor(): Executor

getMainLooper

open override fun getMainLooper(): Looper

getMaxNumPictureInPictureActions

open fun getMaxNumPictureInPictureActions(): Int

getMediaController

fun getMediaController(): MediaController

getMenuInflater

@NonNull

open override fun getMenuInflater(): MenuInflater

getNoBackupFilesDir

open override fun getNoBackupFilesDir(): File

getObbDir

open override fun getObbDir(): File

getObbDirs

open override fun getObbDirs(): Array<File>

getOpPackageName

open override fun getOpPackageName(): String

getPackageCodePath

open override fun getPackageCodePath(): String

getPackageManager

open override fun getPackageManager(): PackageManager

getPackageName

open override fun getPackageName(): String

getPackageResourcePath

open override fun getPackageResourcePath(): String

getParams

open override fun getParams(): ContextParams?

getParent

fun getParent(): Activity

getParentActivityIntent

open fun getParentActivityIntent(): Intent?

getPreferences

open fun getPreferences(p0: Int): SharedPreferences

getReferrer

open fun getReferrer(): Uri?

getRequestedOrientation

open fun getRequestedOrientation(): Int

getRequestingScopes

abstract fun getRequestingScopes(): List<SpotifyScope>

Return the scopes that you are going to request from the user here.

getResources

open override fun getResources(): Resources

getSearchEvent

fun getSearchEvent(): SearchEvent

getSharedPreferences

open override fun getSharedPreferences(p0: String, p1: Int): SharedPreferences

getSplashScreen

fun getSplashScreen(): SplashScreen

getString

fun getString(p0: Int): String

fun getString(p0: Int, vararg p1: Any): String

getSupportActionBar

@Nullable

open fun getSupportActionBar(): ActionBar?

getSupportFragmentManager

@NonNull

open fun getSupportFragmentManager(): FragmentManager

getSupportParentActivityIntent

@Nullable

open override fun getSupportParentActivityIntent(): Intent?

getSystemService

open override fun getSystemService(p0: String): Any

fun <T : Any> getSystemService(p0: Class<T>): T

getSystemServiceName

open override fun getSystemServiceName(p0: Class<*>): String?

getTaskId

open fun getTaskId(): Int

getText

fun getText(p0: Int): CharSequence

getTheme

open override fun getTheme(): Resources.Theme

getTitle

fun getTitle(): CharSequence

getTitleColor

fun getTitleColor(): Int

getVoiceInteractor

open fun getVoiceInteractor(): VoiceInteractor

getVolumeControlStream

fun getVolumeControlStream(): Int

getWindow

open fun getWindow(): Window

getWindowManager

open fun getWindowManager(): WindowManager

grantUriPermission

open override fun grantUriPermission(p0: String, p1: Uri, p2: Int)

guardValidImplicitSpotifyApi

fun <T> Activity.guardValidImplicitSpotifyApi(spotifyImplicitLoginImplementationClass: Class<out SpotifyImplicitLoginActivity>, classBackTo: Class<out Activity>? = null, block: () -> T): T?

Basic implicit authentication guard - verifies that the user is logged in to Spotify and uses SpotifyDefaultImplicitAuthHelper to handle re-authentication and redirection back to the activity.

hasWindowFocus

open fun hasWindowFocus(): Boolean

invalidateMenu

open override fun invalidateMenu()

invalidateOptionsMenu

open override fun invalidateOptionsMenu()

isActivityTransitionRunning

open fun isActivityTransitionRunning(): Boolean

isChangingConfigurations

open fun isChangingConfigurations(): Boolean

isChild

fun isChild(): Boolean

isDestroyed

open fun isDestroyed(): Boolean

isDeviceProtectedStorage

open override fun isDeviceProtectedStorage(): Boolean

isFinishing

open fun isFinishing(): Boolean

isImmersive

open fun isImmersive(): Boolean

isInMultiWindowMode

open fun isInMultiWindowMode(): Boolean

isInPictureInPictureMode

open fun isInPictureInPictureMode(): Boolean

isLaunchedFromBubble

open fun isLaunchedFromBubble(): Boolean

isLocalVoiceInteractionSupported

open fun isLocalVoiceInteractionSupported(): Boolean

isRestricted

open override fun isRestricted(): Boolean

isTaskRoot

open fun isTaskRoot(): Boolean

isUiContext

open override fun isUiContext(): Boolean

isVoiceInteraction

open fun isVoiceInteraction(): Boolean

isVoiceInteractionRoot

open fun isVoiceInteractionRoot(): Boolean

moveDatabaseFrom

open override fun moveDatabaseFrom(p0: Context, p1: String): Boolean

moveSharedPreferencesFrom

open override fun moveSharedPreferencesFrom(p0: Context, p1: String): Boolean

moveTaskToBack

open fun moveTaskToBack(p0: Boolean): Boolean

navigateUpTo

open fun navigateUpTo(p0: Intent): Boolean

obtainStyledAttributes

fun obtainStyledAttributes(p0: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: Int, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray, p2: Int, p3: Int): TypedArray

onActionModeFinished

open override fun onActionModeFinished(p0: ActionMode)

onActionModeStarted

open override fun onActionModeStarted(p0: ActionMode)

onActivityReenter

open fun onActivityReenter(p0: Int, p1: Intent)

onAttachedToWindow

open override fun onAttachedToWindow()

onBackPressed

@MainThread

open override fun onBackPressed()

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContentChanged

open override fun onContentChanged()

onContextItemSelected

open fun onContextItemSelected(p0: MenuItem): Boolean

onContextMenuClosed

open fun onContextMenuClosed(p0: Menu)

onCreate

open fun onCreate(p0: Bundle?, p1: PersistableBundle?)

onCreateContextMenu

open override fun onCreateContextMenu(p0: ContextMenu, p1: View, p2: ContextMenu.ContextMenuInfo)

onCreateDescription

open fun onCreateDescription(): CharSequence?

onCreateNavigateUpTaskStack

open fun onCreateNavigateUpTaskStack(p0: TaskStackBuilder)

onCreateOptionsMenu

open fun onCreateOptionsMenu(p0: Menu): Boolean

onCreatePanelMenu

open override fun onCreatePanelMenu(p0: Int, @NonNull p1: Menu): Boolean

onCreatePanelView

open override fun onCreatePanelView(p0: Int): View?

onCreateSupportNavigateUpTaskStack

open fun onCreateSupportNavigateUpTaskStack(@NonNull p0: TaskStackBuilder)

onCreateView

@Nullable

open override fun onCreateView(@NonNull p0: String, @NonNull p1: Context, @NonNull p2: AttributeSet): View?

@Nullable

open override fun onCreateView(@Nullable p0: View?, @NonNull p1: String, @NonNull p2: Context, @NonNull p3: AttributeSet): View?

onDetachedFromWindow

open override fun onDetachedFromWindow()

onEnterAnimationComplete

open fun onEnterAnimationComplete()

onFailure

abstract fun onFailure(errorMessage: String)

Override this to define what to do after authentication has failed. You may want to use SpotifyDefaultCredentialStore to remove any stored token.

onGenericMotionEvent

open fun onGenericMotionEvent(p0: MotionEvent): Boolean

onGetDirectActions

open fun onGetDirectActions(p0: CancellationSignal, p1: Consumer<MutableList<DirectAction>>)

onKeyDown

open override fun onKeyDown(p0: Int, p1: KeyEvent): Boolean

onKeyLongPress

open override fun onKeyLongPress(p0: Int, p1: KeyEvent): Boolean

onKeyMultiple

open override fun onKeyMultiple(p0: Int, p1: Int, p2: KeyEvent): Boolean

onKeyShortcut

open fun onKeyShortcut(p0: Int, p1: KeyEvent): Boolean

onKeyUp

open override fun onKeyUp(p0: Int, p1: KeyEvent): Boolean

onLocalVoiceInteractionStarted

open fun onLocalVoiceInteractionStarted()

onLocalVoiceInteractionStopped

open fun onLocalVoiceInteractionStopped()

onLowMemory

open override fun onLowMemory()

onMenuItemSelected

override fun onMenuItemSelected(p0: Int, @NonNull p1: MenuItem): Boolean

onMenuOpened

open override fun onMenuOpened(p0: Int, p1: Menu): Boolean

onMultiWindowModeChanged

@CallSuper

open override fun onMultiWindowModeChanged(p0: Boolean)

@RequiresApi(api = 26)

@CallSuper

open override fun onMultiWindowModeChanged(p0: Boolean, @NonNull p1: Configuration)

onNavigateUp

open fun onNavigateUp(): Boolean

onOptionsItemSelected

open fun onOptionsItemSelected(p0: MenuItem): Boolean

onOptionsMenuClosed

open fun onOptionsMenuClosed(p0: Menu)

onPanelClosed

open override fun onPanelClosed(p0: Int, @NonNull p1: Menu)

onPerformDirectAction

open fun onPerformDirectAction(p0: String, p1: Bundle, p2: CancellationSignal, p3: Consumer<Bundle>)

onPictureInPictureModeChanged

@CallSuper

open override fun onPictureInPictureModeChanged(p0: Boolean)

@RequiresApi(api = 26)

@CallSuper

open override fun onPictureInPictureModeChanged(p0: Boolean, @NonNull p1: Configuration)

onPictureInPictureRequested

open fun onPictureInPictureRequested(): Boolean

onPictureInPictureUiStateChanged

open fun onPictureInPictureUiStateChanged(p0: PictureInPictureUiState)

onPointerCaptureChanged

open fun onPointerCaptureChanged(p0: Boolean)

onPostCreate

open fun onPostCreate(p0: Bundle?, p1: PersistableBundle?)

onPrepareNavigateUpTaskStack

open fun onPrepareNavigateUpTaskStack(p0: TaskStackBuilder)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(p0: Menu): Boolean

onPreparePanel

open override fun onPreparePanel(p0: Int, @Nullable p1: View?, @NonNull p2: Menu): Boolean

onPrepareSupportNavigateUpTaskStack

open fun onPrepareSupportNavigateUpTaskStack(@NonNull p0: TaskStackBuilder)

onProvideAssistContent

open fun onProvideAssistContent(p0: AssistContent)

onProvideAssistData

open fun onProvideAssistData(p0: Bundle)

onProvideKeyboardShortcuts

open override fun onProvideKeyboardShortcuts(p0: MutableList<KeyboardShortcutGroup>, p1: Menu?, p2: Int)

onProvideReferrer

open fun onProvideReferrer(): Uri

onRequestPermissionsResult

@CallSuper

open override fun onRequestPermissionsResult(p0: Int, @NonNull p1: Array<String>, @NonNull p2: IntArray)

onRestoreInstanceState

open fun onRestoreInstanceState(p0: Bundle?, p1: PersistableBundle?)

onRetainNonConfigurationInstance

@Nullable

override fun onRetainNonConfigurationInstance(): Any?

onSaveInstanceState

open fun onSaveInstanceState(p0: Bundle, p1: PersistableBundle)

onSearchRequested

open override fun onSearchRequested(): Boolean

open override fun onSearchRequested(p0: SearchEvent?): Boolean

onStateNotSaved

open override fun onStateNotSaved()

onSuccess

abstract fun onSuccess(spotifyApi: SpotifyImplicitGrantApi)

Override this to define what to do after authentication has been successfully completed. A valid, usable spotifyApi is provided to you. You may likely want to use SpotifyDefaultCredentialStore to store/retrieve this token.