LauncherApps.PinItemRequest Class

Definition

Namespace:

Android.Content.PM

Assembly:

Mono.Android.dll

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, Java.Interop.IJavaPeerable

[<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

Object

Object

LauncherApps.PinItemRequest

Attributes

RegisterAttribute

Implements

IParcelable IJavaObject IJavaPeerable IDisposable

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

RequestTypeAppwidget	Obsolete. This is a request to pin app widget.
RequestTypeShortcut	Obsolete. This is a request to pin shortcut.

Properties

Class	Returns the runtime class of this Object. (Inherited from Object)
Creator
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	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
RequestType	Represents the type of a request, which is one of the REQUEST_TYPE_ constants.
ShortcutInfo	ShortcutInfo sent by the requesting app.
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

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)
DescribeContents()
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetAppWidgetProviderInfo(Context)	AppWidgetProviderInfo sent by the requesting app.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	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)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(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)	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, 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)
WriteToParcel(Parcel, ParcelableWriteFlags)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)