AppWidgetHost

AppWidgetHost

AppWidgetHost(
    context: Context!, 
    hostId: Int)

allocateAppWidgetId

open fun allocateAppWidgetId(): Int

Get a appWidgetId for a host in the calling process.

createView

fun createView(
    context: Context!, 
    appWidgetId: Int, 
    appWidget: AppWidgetProviderInfo!
): AppWidgetHostView!

Create the AppWidgetHostView for the given widget. The AppWidgetHost retains a pointer to the newly-created View.

deleteAllHosts

open static fun deleteAllHosts(): Unit

Remove all records about all hosts for your package.

• Call this when initializing your database, as it might be because of a data wipe.
• Call this to have the AppWidget manager release all resources associated with your host. Any future calls about this host will cause the records to be re-allocated.

deleteAppWidgetId

open fun deleteAppWidgetId(appWidgetId: Int): Unit

Stop listening to changes for this AppWidget.

deleteHost

open fun deleteHost(): Unit

Remove all records about this host from the AppWidget manager.

• Call this when initializing your database, as it might be because of a data wipe.
• Call this to have the AppWidget manager release all resources associated with your host. Any future calls about this host will cause the records to be re-allocated.

getAppWidgetIds

open fun getAppWidgetIds(): IntArray!

Gets a list of all the appWidgetIds that are bound to the current host

onAppWidgetRemoved

open fun onAppWidgetRemoved(appWidgetId: Int): Unit

Called when the app widget is removed for appWidgetId

startAppWidgetConfigureActivityForResult

fun startAppWidgetConfigureActivityForResult(
    activity: Activity, 
    appWidgetId: Int, 
    intentFlags: Int, 
    requestCode: Int, 
    options: Bundle?
): Unit

Starts an app widget provider configure activity for result on behalf of the caller. Use this method if the provider is in another profile as you are not allowed to start an activity in another profile. You can optionally provide a request code that is returned in Activity#onActivityResult(int, int, android.content.Intent) and an options bundle to be passed to the started activity.

Note that the provided app widget has to be bound for this method to work.

startListening

open fun startListening(): Unit

Start receiving onAppWidgetChanged calls for your AppWidgets. Call this when your activity becomes visible, i.e. from onStart() in your Activity.

stopListening

open fun stopListening(): Unit

Stop receiving onAppWidgetChanged calls for your AppWidgets. Call this when your activity is no longer visible, i.e. from onStop() in your Activity.

clearViews

protected open fun clearViews(): Unit

Clear the list of Views that have been created by this AppWidgetHost.

onCreateView

protected open fun onCreateView(
    context: Context!, 
    appWidgetId: Int, 
    appWidget: AppWidgetProviderInfo!
): AppWidgetHostView!

Called to create the AppWidgetHostView. Override to return a custom subclass if you need it. {@more}

onProviderChanged

protected open fun onProviderChanged(
    appWidgetId: Int, 
    appWidget: AppWidgetProviderInfo!
): Unit

Called when the AppWidget provider for a AppWidget has been upgraded to a new apk.

onProvidersChanged

protected open fun onProvidersChanged(): Unit

Called when the set of available widgets changes (ie. widget containing packages are added, updated or removed, or widget components are enabled or disabled.)