# KeyboardShortcutInfo

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary: [Inherited Constants](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#lfields) \| [Ctors](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#pubctors) \| [Methods](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#inhmethods)  

# KeyboardShortcutInfo

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/KeyboardShortcutInfo "View this page in Kotlin") \|Java


`
public

final

class
KeyboardShortcutInfo
`


`

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.view.KeyboardShortcutInfo |

<br />

*** ** * ** ***

Information about a Keyboard Shortcut.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ### 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)`<`[KeyboardShortcutInfo](https://developer.android.com/reference/android/view/KeyboardShortcutInfo)`>` | [CREATOR](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#CREATOR) |

|                                                                                                                                      ### Public constructors                                                                                                                                      ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[KeyboardShortcutInfo](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#KeyboardShortcutInfo(java.lang.CharSequence,%20char,%20int))`(`[CharSequence](https://developer.android.com/reference/java/lang/CharSequence)` label, char baseCharacter, int modifiers) ` |
| ` `[KeyboardShortcutInfo](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#KeyboardShortcutInfo(java.lang.CharSequence,%20int,%20int))`(`[CharSequence](https://developer.android.com/reference/java/lang/CharSequence)` label, int keycode, int modifiers) `         |

|                                                                                                                                                                   ### Public methods                                                                                                                                                                   ||
|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                            | ` `[describeContents](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    |
| ` char`                                                                           | ` `[getBaseCharacter](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#getBaseCharacter())`() ` Returns the base character that, combined with the modifiers, triggers this shortcut.                                                      |
| ` int`                                                                            | ` `[getKeycode](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#getKeycode())`() ` Returns the base keycode that, combined with the modifiers, triggers this shortcut.                                                                    |
| ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getLabel](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#getLabel())`() ` Returns the label to be used to describe this shortcut.                                                                                                    |
| ` int`                                                                            | ` `[getModifiers](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#getModifiers())`() ` Returns the set of modifiers that, combined with the key, trigger this shortcut.                                                                   |
| ` void`                                                                           | ` `[writeToParcel](https://developer.android.com/reference/android/view/KeyboardShortcutInfo#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. | ||

## Fields

### CREATOR

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<KeyboardShortcutInfo> CREATOR
```

<br />

<br />

## Public constructors

### KeyboardShortcutInfo

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public KeyboardShortcutInfo (CharSequence label, 
                char baseCharacter, 
                int modifiers)
```

<br />

<br />

|                                                                                                                                                                                                                                                                                                                                                                                   Parameters                                                                                                                                                                                                                                                                                                                                                                                   ||
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `label`         | `CharSequence`: The label that identifies the action performed by this shortcut. <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `baseCharacter` | `char`: The character that triggers the shortcut. <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `modifiers`     | `int`: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of [KeyEvent.META_CTRL_ON](https://developer.android.com/reference/android/view/KeyEvent#META_CTRL_ON), [KeyEvent.META_SHIFT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SHIFT_ON), [KeyEvent.META_META_ON](https://developer.android.com/reference/android/view/KeyEvent#META_META_ON), [KeyEvent.META_ALT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_ALT_ON), [KeyEvent.META_FUNCTION_ON](https://developer.android.com/reference/android/view/KeyEvent#META_FUNCTION_ON) and [KeyEvent.META_SYM_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SYM_ON). <br /> |

### KeyboardShortcutInfo

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public KeyboardShortcutInfo (CharSequence label, 
                int keycode, 
                int modifiers)
```

<br />

<br />

|                                                                                                                                                                                                                                                                                                                                                                                 Parameters                                                                                                                                                                                                                                                                                                                                                                                 ||
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `label`     | `CharSequence`: The label that identifies the action performed by this shortcut. <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `keycode`   | `int`: The keycode that triggers the shortcut. This should be a valid constant defined in [KeyEvent](https://developer.android.com/reference/android/view/KeyEvent). <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `modifiers` | `int`: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of [KeyEvent.META_CTRL_ON](https://developer.android.com/reference/android/view/KeyEvent#META_CTRL_ON), [KeyEvent.META_SHIFT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SHIFT_ON), [KeyEvent.META_META_ON](https://developer.android.com/reference/android/view/KeyEvent#META_META_ON), [KeyEvent.META_ALT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_ALT_ON), [KeyEvent.META_FUNCTION_ON](https://developer.android.com/reference/android/view/KeyEvent#META_FUNCTION_ON) and [KeyEvent.META_SYM_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SYM_ON). <br /> |

## Public methods

### describeContents

Added in [API level 24](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.

<br />

|                                                                                                                          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) <br /> |

### getBaseCharacter

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public char getBaseCharacter ()
```

Returns the base character that, combined with the modifiers, triggers this shortcut. If the
keycode was set instead, returns [Character.MIN_VALUE](https://developer.android.com/reference/java/lang/Character#MIN_VALUE).

<br />

|    Returns     ||
|--------|--------|
| `char` | <br /> |

### getKeycode

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int getKeycode ()
```

Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the
base character was set instead, returns [KeyEvent.KEYCODE_UNKNOWN](https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_UNKNOWN). Valid keycodes are
defined as constants in [KeyEvent](https://developer.android.com/reference/android/view/KeyEvent).

<br />

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### getLabel

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public CharSequence getLabel ()
```

Returns the label to be used to describe this shortcut.

<br />

|                                                     Returns                                                      ||
|--------------------------------------------------------------------------------|----------------------------------|
| [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be `null`. <br /> |

### getModifiers

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int getModifiers ()
```

Returns the set of modifiers that, combined with the key, trigger this shortcut. These can
be a combination of [KeyEvent.META_CTRL_ON](https://developer.android.com/reference/android/view/KeyEvent#META_CTRL_ON), [KeyEvent.META_SHIFT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SHIFT_ON),
[KeyEvent.META_META_ON](https://developer.android.com/reference/android/view/KeyEvent#META_META_ON), [KeyEvent.META_ALT_ON](https://developer.android.com/reference/android/view/KeyEvent#META_ALT_ON),
[KeyEvent.META_FUNCTION_ON](https://developer.android.com/reference/android/view/KeyEvent#META_FUNCTION_ON) and [KeyEvent.META_SYM_ON](https://developer.android.com/reference/android/view/KeyEvent#META_SYM_ON).

<br />

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### writeToParcel

Added in [API level 24](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.

<br />

|                                                                                                                                                                                                                                 Parameters                                                                                                                                                                                                                                  ||
|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br />                                                                                                                                                                                                                                                                                                                                                                    |
| `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 <br /> |