Share via


ShortcutManager Class

Definition

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
ShortcutManager
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&mdash;including identifiers, type, and status&mdash;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

ShortcutManager(IntPtr, JniHandleOwnership)

Fields

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

Class

Returns the runtime class of this Object.

(Inherited from Object)
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 true when rate-limiting is active for the caller app.

IsRequestPinShortcutSupported

Return TRUE if the app is running on a device whose default launcher supports #requestPinShortcut(ShortcutInfo, IntentSender).

JniIdentityHashCode (Inherited from Object)
JniPeerMembers
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 (Inherited from Object)
PinnedShortcuts

Return all pinned shortcuts from the caller app.

ThresholdClass
ThresholdType

Methods

AddDynamicShortcuts(IList<ShortcutInfo>)

Publish the list of dynamic shortcuts.

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
CreateShortcutResultIntent(ShortcutInfo)

Returns an Intent which can be used by the default launcher to pin a shortcut containing the given ShortcutInfo.

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() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
EnableShortcuts(IList<String>)

Re-enable pinned shortcuts that were previously disabled.

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 ShortcutInfos that match matchFlags.

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)
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)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (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

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)

Applies to