# LauncherApps.PinItemRequest Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Constants](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#constants)\|[Inherited Constants](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#inhconstants)\|[Fields](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#lfields)\|[Methods](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#inhmethods) # LauncherApps.PinItemRequest *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps.PinItemRequest "View this page in Kotlin")\|Java ` public static final class LauncherApps.PinItemRequest ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` implements `[Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |---|------------------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.content.pm.LauncherApps.PinItemRequest |
*** ** * ** *** Represents a "pin shortcut" or a "pin appwidget" request made by an app, which is sent with an[LauncherApps.ACTION_CONFIRM_PIN_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps#ACTION_CONFIRM_PIN_SHORTCUT)or[LauncherApps.ACTION_CONFIRM_PIN_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps#ACTION_CONFIRM_PIN_APPWIDGET)intent respectively to the default launcher app. ### Request of the[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT)type. A[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT)request represents a request to pin a[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo). If the launcher accepts a request, call[accept()](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept()), or[accept(android.os.Bundle)](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept(android.os.Bundle))with a null or empty Bundle. No options are defined for pin-shortcuts requests. [getShortcutInfo()](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getShortcutInfo())always returns a non-null[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)for this type. The launcher may receive a request with a[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)that is already pinned, in which case[ShortcutInfo.isPinned()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isPinned())returns true. This means the user wants to create another pinned shortcut for a shortcut that's already pinned. If the launcher accepts it,[accept()](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept())must still be called even though the shortcut is already pinned, and create a new pinned shortcut icon for it. See also[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)for more details. ### Request of the[REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET)type. A[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT)request represents a request to pin a an AppWidget. If the launcher accepts a request, call[accept(android.os.Bundle)](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept(android.os.Bundle))with the appwidget integer ID set to the[AppWidgetManager.EXTRA_APPWIDGET_ID](https://developer.android.com/reference/android/appwidget/AppWidgetManager#EXTRA_APPWIDGET_ID)extra. [getAppWidgetProviderInfo(android.content.Context)](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getAppWidgetProviderInfo(android.content.Context))always returns a non-null[AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo)for this type. See also[AppWidgetManager](https://developer.android.com/reference/android/appwidget/AppWidgetManager)for more details. **See also:** - [LauncherApps.EXTRA_PIN_ITEM_REQUEST](https://developer.android.com/reference/android/content/pm/LauncherApps#EXTRA_PIN_ITEM_REQUEST) - [LauncherApps.getPinItemRequest(Intent)](https://developer.android.com/reference/android/content/pm/LauncherApps#getPinItemRequest(android.content.Intent)) ## Summary | ### Constants || |-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET) This is a request to pin app widget. | | `int` | [REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT) This is a request to pin shortcut. | | ### Inherited constants | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](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 `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[LauncherApps.PinItemRequest](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest)`>` | [CREATOR](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#CREATOR)
| | ### Public methods || |-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` boolean` | ` `[accept](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle)` options) ` Called by the receiving launcher app when the user accepts the request. | | ` boolean` | ` `[accept](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept())`() ` Called by the receiving launcher app when the user accepts the request, with no options. | | ` int` | ` `[describeContents](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` `[AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo) | ` `[getAppWidgetProviderInfo](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getAppWidgetProviderInfo(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context)` context) ` [AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo)sent by the requesting app. | | ` `[Bundle](https://developer.android.com/reference/android/os/Bundle) | ` `[getExtras](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getExtras())`() ` Any extras sent by the requesting app. | | ` int` | ` `[getRequestType](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getRequestType())`() ` Represents the type of a request, which is one of the`REQUEST_TYPE_`constants. | | ` `[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo) | ` `[getShortcutInfo](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#getShortcutInfo())`() ` [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)sent by the requesting app. | | ` boolean` | ` `[isValid](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#isValid())`() ` Return whether a request is still valid. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](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` | ` `[wait](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` | ` `[wait](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` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](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` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | || ## Constants ### REQUEST_TYPE_APPWIDGET Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int REQUEST_TYPE_APPWIDGET ``` This is a request to pin app widget.
Constant Value: 2 (0x00000002) ### REQUEST_TYPE_SHORTCUT Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int REQUEST_TYPE_SHORTCUT ``` This is a request to pin shortcut.
Constant Value: 1 (0x00000001) ## Fields ### CREATOR Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final Creator CREATOR ```

## Public methods ### accept Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean accept (Bundle options) ``` Called by the receiving launcher app when the user accepts the request.
| Parameters || |-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `options` | `Bundle`: must be set for a[REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET)request. This value may be`null`.
| | Returns || |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | `TRUE`if the shortcut or the AppWidget has actually been pinned.`FALSE`if the item hasn't been pinned, for example, because the request had already been canceled, in which case the launcher must not pin the requested item.
| ### accept Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean accept () ``` Called by the receiving launcher app when the user accepts the request, with no options.
| Returns || |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | `TRUE`if the shortcut or the AppWidget has actually been pinned.`FALSE`if the item hasn't been pinned, for example, because the request had already been canceled, in which case the launcher must not pin the requested item.
| ### describeContents Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` 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(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#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](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
| ### getAppWidgetProviderInfo Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public AppWidgetProviderInfo getAppWidgetProviderInfo (Context context) ``` [AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo)sent by the requesting app. Always non-null for a[REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET)request, and always null for a different request type. Launcher should not show any configuration activity associated with the provider, and assume that the widget is already fully configured. Upon accepting the widget, it should pass the widgetId in[accept(android.os.Bundle)](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept(android.os.Bundle)).
| Parameters || |-----------|------------------| | `context` | `Context`
| | Returns || |----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo) | requested[AppWidgetProviderInfo](https://developer.android.com/reference/android/appwidget/AppWidgetProviderInfo)when a request is of the[REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET)type. Null otherwise.
| ### getExtras Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Bundle getExtras () ``` Any extras sent by the requesting app.
| Returns || |---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Bundle](https://developer.android.com/reference/android/os/Bundle) | For a shortcut request, this method always return null. For an AppWidget request, this method returns the extras passed to the[AppWidgetManager.requestPinAppWidget(ComponentName, Bundle, PendingIntent)](https://developer.android.com/reference/android/appwidget/AppWidgetManager#requestPinAppWidget(android.content.ComponentName,%20android.os.Bundle,%20android.app.PendingIntent))API. See[AppWidgetManager](https://developer.android.com/reference/android/appwidget/AppWidgetManager)for details.
| ### getRequestType Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getRequestType () ``` Represents the type of a request, which is one of the`REQUEST_TYPE_`constants.
| Returns || |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | one of the`REQUEST_TYPE_`constants. Value is[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT), or[REQUEST_TYPE_APPWIDGET](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_APPWIDGET)
| ### getShortcutInfo Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public ShortcutInfo getShortcutInfo () ``` [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)sent by the requesting app. Always non-null for a[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT)request, and always null for a different request type.
| Returns || |-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo) | requested[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)when a request is of the[REQUEST_TYPE_SHORTCUT](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#REQUEST_TYPE_SHORTCUT)type. Null otherwise.
| ### isValid Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isValid () ``` Return whether a request is still valid.
| Returns || |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `boolean` | `TRUE`if a request is valid and[accept(android.os.Bundle)](https://developer.android.com/reference/android/content/pm/LauncherApps.PinItemRequest#accept(android.os.Bundle))may be called.
| ### writeToParcel Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void writeToParcel (Parcel dest, int flags) ``` Flatten this object in to a Parcel.
| Parameters || |---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dest` | `Parcel`: 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.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|