LauncherApps.PinItemRequest Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a "pin shortcut" or a "pin appwidget" request made by an app, which is sent with
an #ACTION_CONFIRM_PIN_SHORTCUT or #ACTION_CONFIRM_PIN_APPWIDGET intent
respectively to the default launcher app.
[Android.Runtime.Register("android/content/pm/LauncherApps$PinItemRequest", ApiSince=26, DoNotGenerateAcw=true)]
public sealed class LauncherApps.PinItemRequest : Java.Lang.Object, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/content/pm/LauncherApps$PinItemRequest", ApiSince=26, DoNotGenerateAcw=true)>]
type LauncherApps.PinItemRequest = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable
- Inheritance
- Attributes
- Implements
Remarks
Represents a "pin shortcut" or a "pin appwidget" request made by an app, which is sent with an #ACTION_CONFIRM_PIN_SHORTCUT or #ACTION_CONFIRM_PIN_APPWIDGET intent respectively to the default launcher app.
<h3>Request of the #REQUEST_TYPE_SHORTCUT type.</h3>
A #REQUEST_TYPE_SHORTCUT request represents a request to pin a ShortcutInfo. If the launcher accepts a request, call #accept(), or #accept(Bundle) with a null or empty Bundle. No options are defined for pin-shortcuts requests.
#getShortcutInfo() always returns a non-null ShortcutInfo for this type.
The launcher may receive a request with a ShortcutInfo that is already pinned, in which case 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() must still be called even though the shortcut is already pinned, and create a new pinned shortcut icon for it.
See also ShortcutManager for more details.
<h3>Request of the #REQUEST_TYPE_APPWIDGET type.</h3>
A #REQUEST_TYPE_SHORTCUT request represents a request to pin a an AppWidget. If the launcher accepts a request, call #accept(Bundle) with the appwidget integer ID set to the android.appwidget.AppWidgetManager#EXTRA_APPWIDGET_ID extra.
#getAppWidgetProviderInfo(Context) always returns a non-null AppWidgetProviderInfo for this type.
See also AppWidgetManager for more details.
Java documentation for android.content.pm.LauncherApps.PinItemRequest.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| Name | Description |
|---|---|
| RequestTypeAppwidget |
Obsolete.
This is a request to pin app widget. |
| RequestTypeShortcut |
Obsolete.
This is a request to pin shortcut. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Creator |
A creator that generates instances of android.content.pm.LauncherApps.PinItemRequest from a Parcel. |
| Extras |
Any extras sent by the requesting app. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IsValid |
Return whether a request is still valid. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| RequestType |
Represents the type of a request, which is one of the |
| ShortcutInfo |
|
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| Name | Description |
|---|---|
| Accept() |
Called by the receiving launcher app when the user accepts the request, with no options. |
| Accept(Bundle) |
Called by the receiving launcher app when the user accepts the request. |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| DescribeContents() |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetAppWidgetProviderInfo(Context) |
|
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Flatten this object in to a Parcel. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
Removes this instance from the runtime's Java object lookup. |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |