ShortcutManager 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.
ShortcutManager executes operations on an app's set of shortcuts, which
represent specific tasks and actions that users can perform within your app.
[Android.Runtime.Register("android/content/pm/ShortcutManager", ApiSince=25, DoNotGenerateAcw=true)]
public class ShortcutManager : Java.Lang.Object[<Android.Runtime.Register("android/content/pm/ShortcutManager", ApiSince=25, DoNotGenerateAcw=true)>]
type ShortcutManager = class
inherit Object- Inheritance
- Attributes
Remarks
ShortcutManager executes operations on an app's set of shortcuts, which represent specific tasks and actions that users can perform within your app. This page lists components of the ShortcutManager class that you can use to create and manage sets of shortcuts.
To learn about methods that retrieve information about a single shortcut—including identifiers, type, and status—read the <a href="/reference/android/content/pm/ShortcutInfo.html">ShortcutInfo</a> reference.
For guidance about using shortcuts, see App shortcuts.
<h3>Retrieving class instances</h3> <!-- Provides a heading for the content filled in by the
Java documentation for android.content.pm.ShortcutManager.
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.
Constructors
| Name | Description |
|---|---|
| ShortcutManager(IntPtr, JniHandleOwnership) |
Creates a managed instance that represents an existing Java object. |
Fields
| Name | Description |
|---|---|
| FlagMatchCached |
Obsolete.
Include cached shortcuts in the result. |
| FlagMatchDynamic |
Obsolete.
Include dynamic shortcuts in the result. |
| FlagMatchManifest |
Obsolete.
Include manifest shortcuts in the result. |
| FlagMatchPinned |
Obsolete.
Include pinned shortcuts in the result. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| DynamicShortcuts |
Return all dynamic shortcuts from the caller app. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IconMaxHeight |
Return the max height for icons, in pixels. |
| IconMaxWidth |
Return the max width for icons, in pixels. |
| IsRateLimitingActive |
Return |
| IsRequestPinShortcutSupported |
Returns |
| 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. |
| ManifestShortcuts |
Return all static (manifest) shortcuts from the caller app. |
| MaxShortcutCountPerActivity |
Return the maximum number of static and dynamic shortcuts that each launcher icon can have at a time. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| PinnedShortcuts |
Return all pinned shortcuts from the caller app. |
| ThresholdClass |
Gets the Java class used for virtual method dispatch. |
| ThresholdType |
Gets the managed type that declares this Java binding. |
Methods
| Name | Description |
|---|---|
| AddDynamicShortcuts(IList<ShortcutInfo>) |
Publish the list of dynamic shortcuts. |
| 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) |
| CreateShortcutResultIntent(ShortcutInfo) |
Returns an Intent which can be used by the default launcher to pin a shortcut containing the
given |
| DisableShortcuts(IList<String>, ICharSequence) |
Disable pinned shortcuts, showing the user a custom error message when they try to select the disabled shortcuts. |
| DisableShortcuts(IList<String>, String) |
Disable pinned shortcuts, showing the user a custom error message when they try to select the disabled shortcuts. |
| DisableShortcuts(IList<String>) |
Disable pinned shortcuts. |
| 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) |
| EnableShortcuts(IList<String>) |
Re-enable pinned shortcuts that were previously disabled. |
| 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) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetShortcuts(Int32) |
Returns |
| 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) |
| PushDynamicShortcut(ShortcutInfo) |
Publish a single dynamic shortcut. |
| RemoveAllDynamicShortcuts() |
Delete all dynamic shortcuts from the caller app. |
| RemoveDynamicShortcuts(IList<String>) |
Delete dynamic shortcuts by ID. |
| RemoveLongLivedShortcuts(IList<String>) |
Delete long lived shortcuts by ID. |
| ReportShortcutUsed(String) |
Apps that publish shortcuts should call this method whenever the user selects the shortcut containing the given ID or when the user completes an action in the app that is equivalent to selecting the shortcut. |
| RequestPinShortcut(ShortcutInfo, IntentSender) |
Request to create a pinned shortcut. |
| SetDynamicShortcuts(IList<ShortcutInfo>) |
Publish the list of shortcuts. |
| 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) |
| UpdateShortcuts(IList<ShortcutInfo>) |
Update all existing shortcuts with the same IDs. |
| 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) |
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) |
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 |