Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions) Summary: [Inherited Constants](https://developer.android.com/reference/android/appwidget/AppWidgetEvent#inhconstants) \| [Fields](https://developer.android.com/reference/android/appwidget/AppWidgetEvent#lfields) \| [Methods](https://developer.android.com/reference/android/appwidget/AppWidgetEvent#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/appwidget/AppWidgetEvent#inhmethods)

# AppWidgetEvent

*** ** * ** ***

` public final class AppWidgetEvent `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.appwidget.AppWidgetEvent |

<br />

*** ** * ** ***

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

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/appwidget/AppWidgetEvent>` | `https://developer.android.com/reference/android/appwidget/AppWidgetEvent#CREATOR` Parcelable.Creator that instantiates AppWidgetEvent objects |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getAppWidgetId()() ` The app widget ID of the widget that generated this event. |
| ` int[]` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getClickedIds()() ` This returns the set of View IDs of the views which have been clicked during the event time range. |
| ` https://developer.android.com/reference/java/time/Instant` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getEnd()() ` Describes the end of the time range that this event contains data for. |
| ` https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getPosition()() ` This rect with describes the global coordinates of the widget at the end of the event time range. |
| ` int[]` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getScrolledIds()() ` This returns the set of View IDs of the views which have been scrolled during the event time range. |
| ` https://developer.android.com/reference/java/time/Instant` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getStart()() ` Describes the start of the time range that this event contains data for. |
| ` https://developer.android.com/reference/java/time/Duration` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getVisibleDuration()() ` Describes the total duration of time during which the widget was visible. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/appwidget/AppWidgetEvent#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel out, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final Creator<AppWidgetEvent> CREATOR
```

Parcelable.Creator that instantiates AppWidgetEvent objects

<br />

## Public methods

### describeContents

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getAppWidgetId

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int getAppWidgetId ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/appwidget/AppWidgetManager#getAppWidgetInfo(int)`

### getClickedIds

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int[] getClickedIds ()
```

This returns the set of View IDs of the views which have been clicked during the event time range. Use `https://developer.android.com/reference/android/widget/RemoteViews#setAppWidgetEventTag(int,%20int)` 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.

<br />

| Returns ||
|---|---|
| `int[]` | This value may be `null`. <br /> |

### getEnd

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public Instant getEnd ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/time/Instant` | This value cannot be `null`. <br /> |

### getPosition

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public Rect getPosition ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Rect` | This value may be `null`. <br /> |

### getScrolledIds

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int[] getScrolledIds ()
```

This returns the set of View IDs of the views which have been scrolled during the event time range. Use `https://developer.android.com/reference/android/widget/RemoteViews#setAppWidgetEventTag(int,%20int)` 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.

<br />

| Returns ||
|---|---|
| `int[]` | This value may be `null`. <br /> |

### getStart

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public Instant getStart ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/time/Instant` | This value cannot be `null`. <br /> |

### getVisibleDuration

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
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 `https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getStart()` and `https://developer.android.com/reference/android/appwidget/AppWidgetEvent#getEnd()` if the widget was hidden and shown multiple times during the event time range.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/time/Duration` | This value cannot be `null`. <br /> |

### toString

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public void writeToParcel (Parcel out, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `out` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |