spotify-api-kotlin/com.adamratzman.spotify.auth.pkce/AbstractSpotifyPkceLoginActivity

AbstractSpotifyPkceLoginActivity

abstract class AbstractSpotifyPkceLoginActivity : AppCompatActivity(source)

This class hooks into spotify-web-api-kotlin to provide PKCE authorization for Android application. Paired with SpotifyDefaultCredentialStore to easily store credentials. To use, you must extend this class and follow the instructions in the spotify-web-api-kotlin README.

Constructors

constructor()

Properties

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

options

open val options: SpotifyApiOptions.() -> Unit? = null

Provide if you would like to customize the returned SpotifyClientApi.

pkceCodeVerifier

open val pkceCodeVerifier: String

The code verifier generated that the client will be authenticated with (using its code challenge). Must be between 43-128 alphanumeric characters

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

scopes

abstract val scopes: List<SpotifyScope>

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

state

open val state: String

The state to use to verify the login request.

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?

getAuthorizationUrl

fun getAuthorizationUrl(): Uri

Get the authorization url that the client will be redirected to during PKCE authorization.

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?

getPkceCodeChallenge

fun getPkceCodeChallenge(): String

Get the code challenge for the pkceCodeVerifier that will be used to confirm token identity.

getPreferences

open fun getPreferences(p0: Int): SharedPreferences

getReferrer

open fun getReferrer(): Uri?

getRequestedOrientation

open fun getRequestedOrientation(): Int

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