# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

# VibrationAttributes

`public final class VibrationAttributes`
`extends Object` `implements Parcelable`

java.lang.Object
↳ | android.os.VibrationAttributes

A class to encapsulate a collection of attributes describing information about a vibration

## Summary

### Nested classes
`class` | `VibrationAttributes.Builder` Builder class for `VibrationAttributes` objects.

### Constants
`int` | `FLAG_BYPASS_INTERRUPTION_POLICY` Flag requesting vibration effect to be played even under limited interruptions.
`int` | `USAGE_ALARM` Usage value to use for alarm vibrations.
`int` | `USAGE_CLASS_ALARM` Vibration usage class value to use when the vibration is initiated to catch user's attention, such as alarm, ringtone, and notification vibrations.
`int` | `USAGE_CLASS_FEEDBACK` Vibration usage class value to use when the vibration is initiated as a response to user's actions, such as emulation of physical effects, and texting feedback vibration.
`int` | `USAGE_CLASS_MASK` Mask for vibration usage class value.
`int` | `USAGE_CLASS_UNKNOWN` Vibration usage class value to use when the vibration usage class is unknown.
`int` | `USAGE_COMMUNICATION_REQUEST` Usage value to use for vibrations which mean a request to enter/end a communication, such as a VoIP communication or video-conference.
`int` | `USAGE_HARDWARE_FEEDBACK` Usage value to use for vibrations which provide a feedback for hardware interaction, such as a fingerprint sensor.
`int` | `USAGE_NOTIFICATION` Usage value to use for notification vibrations.
`int` | `USAGE_PHYSICAL_EMULATION` Usage value to use for vibrations which emulate physical effects, such as edge squeeze.
`int` | `USAGE_RINGTONE` Usage value to use for ringtone vibrations.
`int` | `USAGE_TOUCH` Usage value to use for touch vibrations.
`int` | `USAGE_UNKNOWN` Usage value to use when usage is unknown.

### Inherited constants
From interface `android.os.Parcelable`
`int` | `CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` | `PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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<VibrationAttributes>` | `CREATOR`

### Public methods
`int` | `describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean` | `equals(Object o)` Indicates whether some other object is "equal to" this one.
`int` | `getFlags()` Return the flags.
`int` | `getUsage()` Return the vibration usage.
`int` | `getUsageClass()` Return the vibration usage class.
`int` | `hashCode()` Returns a hash code value for the object.
`boolean` | `isFlagSet(int flag)` Check whether a flag is set
`String` | `toString()` Returns a string representation of the object.
`void` | `writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
From interface `android.os.Parcelable`
`abstract int` | `describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void` | `writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

## Constants

### FLAG_BYPASS_INTERRUPTION_POLICY

    public static final int FLAG_BYPASS_INTERRUPTION_POLICY

Flag requesting vibration effect to be played even under limited interruptions.

Constant Value: 1 (0x00000001)

### USAGE_ALARM

    public static final int USAGE_ALARM

Usage value to use for alarm vibrations.

Constant Value: 17 (0x00000011)

### USAGE_CLASS_ALARM

    public static final int USAGE_CLASS_ALARM

Vibration usage class value to use when the vibration is initiated to catch user's attention, such as alarm, ringtone, and notification vibrations.

Constant Value: 1 (0x00000001)

### USAGE_CLASS_FEEDBACK

    public static final int USAGE_CLASS_FEEDBACK

Vibration usage class value to use when the vibration is initiated as a response to user's actions, such as emulation of physical effects, and texting feedback vibration.

Constant Value: 2 (0x00000002)

### USAGE_CLASS_MASK

    public static final int USAGE_CLASS_MASK

Mask for vibration usage class value.

Constant Value: 15 (0x0000000f)

### USAGE_CLASS_UNKNOWN

    public static final int USAGE_CLASS_UNKNOWN

Vibration usage class value to use when the vibration usage class is unknown.

Constant Value: 0 (0x00000000)

### USAGE_COMMUNICATION_REQUEST

    public static final int USAGE_COMMUNICATION_REQUEST

Usage value to use for vibrations which mean a request to enter/end a communication, such as a VoIP communication or video-conference.

Constant Value: 65 (0x00000041)

### USAGE_HARDWARE_FEEDBACK

    public static final int USAGE_HARDWARE_FEEDBACK

Usage value to use for vibrations which provide a feedback for hardware interaction, such as a fingerprint sensor.

Constant Value: 50 (0x00000032)

### USAGE_NOTIFICATION

    public static final int USAGE_NOTIFICATION

Usage value to use for notification vibrations.

Constant Value: 49 (0x00000031)

### USAGE_PHYSICAL_EMULATION

    public static final int USAGE_PHYSICAL_EMULATION

Usage value to use for vibrations which emulate physical effects, such as edge squeeze.

Constant Value: 34 (0x00000022)

### USAGE_RINGTONE

    public static final int USAGE_RINGTONE

Usage value to use for ringtone vibrations.

Constant Value: 33 (0x00000021)

### USAGE_TOUCH

    public static final int USAGE_TOUCH

Usage value to use for touch vibrations.

Constant Value: 18 (0x00000012)

### USAGE_UNKNOWN

    public static final int USAGE_UNKNOWN

Usage value to use when usage is unknown.

Constant Value: 0 (0x00000000)

## Fields

### CREATOR

    public static final Creator<VibrationAttributes> CREATOR

## Public methods

### describeContents

    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)`, the return value of this method must include the `CONTENTS_FILE_DESCRIPTOR` bit.

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`

### equals

    public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The `equals` method implements an equivalence relation on non-null object references:

- It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

The `equals` method for class `Object` implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values `x` and `y`, this method returns `true` if and only if `x` and `y` refer to the same object (`x == y` has the value `true`).

Note that it is generally necessary to override the `hashCode` method whenever this method is overridden, so as to maintain the general contract for the `hashCode` method, which states that equal objects must have equal hash codes.

Parameters
`o` | `Object`: the reference object with which to compare.

Returns
`boolean` | `true` if this object is the same as the obj argument; `false` otherwise.

### getFlags

    public int getFlags ()

Return the flags.

Returns
`int` | a combined mask of all flags

### getUsage

    public int getUsage ()

Return the vibration usage.

Returns
`int` | one of the values that can be set in `Builder#setUsage(int)`

### getUsageClass

    public int getUsageClass ()

Return the vibration usage class.

Returns
`int` | USAGE_CLASS_ALARM, USAGE_CLASS_FEEDBACK or USAGE_CLASS_UNKNOWN

### hashCode

    public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `HashMap`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `equals(Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is not required that if two objects are unequal according to the `equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class `Object` does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int` | a hash code value for this object.

### isFlagSet

    public boolean isFlagSet (int flag)

Check whether a flag is set

Parameters
`flag` | `int`

Returns
`boolean` | true if a flag is set and false otherwise

### toString

    public String toString ()

Returns a string representation of the object. In general, the `toString` method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The `toString` method for class `Object` returns a string consisting of the name of the class of which the object is an instance, the at-sign character ``@`', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

>      getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String` | a string representation of the object.

### writeToParcel

    public void writeToParcel (Parcel dest,
                    int flags)

Flatten this object in to a Parcel.

Parameters
`dest` | `Parcel`: This value cannot be `null`.
`flags` | `int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*