AppWidgetEvent | API reference | Android Developers

public final class AppWidgetEvent
extends Object implements Parcelable

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

Summary

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<AppWidgetEvent>`	`CREATOR` Parcelable.Creator that instantiates AppWidgetEvent objects

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.
`int[]`	`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.
`int[]`	`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.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

public static final Creator<AppWidgetEvent> CREATOR

Parcelable.Creator that instantiates AppWidgetEvent objects

Public methods

describeContents

public int describeContents ()

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(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`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

public int getAppWidgetId ()

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

Returns
`int`

getClickedIds

public int[] getClickedIds ()

This returns the set of View IDs of the views which have been clicked during the event time range. Use 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.

Returns
`int[]`	This value may be `null`.

getEnd

public Instant getEnd ()

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

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

getPosition

public Rect getPosition ()

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

Returns
`Rect`	This value may be `null`.

getScrolledIds

public int[] getScrolledIds ()

This returns the set of View IDs of the views which have been scrolled during the event time range. Use 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.

Returns
`int[]`	This value may be `null`.

getStart

public Instant getStart ()

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

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

getVisibleDuration

public Duration getVisibleDuration ()

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.

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

toString

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.