AppWidgetEvent

Kotlin |Java

class AppWidgetEvent : Parcelable

kotlin.Any
↳	android.appwidget.AppWidgetEvent

An immutable class that describes the event data for an app widget interaction event.

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Int	`getAppWidgetId()` The app widget ID of the widget that generated this event.
IntArray?	`getClickedIds()` This returns the set of View IDs of the views which have been clicked during the event time range.
Instant	`getEnd()` Describes the end of the time range that this event contains data for.
Rect?	`getPosition()` This rect with describes the global coordinates of the widget at the end of the event time range.
IntArray?	`getScrolledIds()` This returns the set of View IDs of the views which have been scrolled during the event time range.
Instant	`getStart()` Describes the start of the time range that this event contains data for.
Duration	`getVisibleDuration()` Describes the total duration of time during which the widget was visible.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AppWidgetEvent!>	`CREATOR` Parcelable.

Public methods

describeContents

Added in API level 36.1

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getAppWidgetId

Added in API level 36.1

fun getAppWidgetId(): Int

The app widget ID of the widget that generated this event.

See Also

android.appwidget.AppWidgetManager#getAppWidgetInfo(int)

getClickedIds

Added in API level 36.1

fun getClickedIds(): IntArray?

This returns the set of View IDs of the views which have been clicked during the event time range. Use android.widget.RemoteViews#setAppWidgetEventTag(int, int) to set a custom integer tag on a view for reporting clicks. If the tag is set, it will be used here instead of the View ID.

Return
`IntArray?`	This value may be `null`.

getEnd

Added in API level 36.1

fun getEnd(): Instant

Describes the end of the time range that this event contains data for.

Return
`Instant`	This value cannot be `null`.

getPosition

Added in API level 36.1

fun getPosition(): Rect?

This rect with describes the global coordinates of the widget at the end of the event time range.

Return
`Rect?`	This value may be `null`.

getScrolledIds

Added in API level 36.1

fun getScrolledIds(): IntArray?

This returns the set of View IDs of the views which have been scrolled during the event time range. Use android.widget.RemoteViews#setAppWidgetEventTag(int, int) to set a custom integer tag on a view for reporting scrolls. If the tag is set, it will be used here instead of the View ID.

Return
`IntArray?`	This value may be `null`.

getStart

Added in API level 36.1

fun getStart(): Instant

Describes the start of the time range that this event contains data for.

Return
`Instant`	This value cannot be `null`.

getVisibleDuration

Added in API level 36.1

fun getVisibleDuration(): Duration

Describes the total duration of time during which the widget was visible. This may be different than the event time range (between getStart() and getEnd() if the widget was hidden and shown multiple times during the event time range.

Return
`Duration`	This value cannot be `null`.

toString

Added in API level 36.1

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 36.1

fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`
`out`	Parcel: This value cannot be `null`.

Properties

CREATOR

Added in API level 36.1

static val CREATOR: Parcelable.Creator<AppWidgetEvent!>

Parcelable.Creator that instantiates AppWidgetEvent objects