VibrationAlert (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.blackberry.api.profiles
Class VibrationAlert

java.lang.Object
  net.rim.blackberry.api.profiles.NotificationAlert
      net.rim.blackberry.api.profiles.VibrationAlert

public class VibrationAlert
extends NotificationAlert
extends NotificationAlert

Represents vibration alert properties.

The VibrationAlert class defines vibration alert properties for alerts that occur in response to an event. This includes properties such as vibration duration, vibration repeat count, and so on.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

Field Summary
	`static byte`	`ALWAYS` Indicates that the sound notification should be performed regardless of the holster condition.
	`static byte`	`IN_HOLSTER_ONLY` Indicates that the sound notification should be performed only when the device is in the holster.
	`static byte`	`LENGTH_LONG` Specifies the long vibration duration.
	`static byte`	`LENGTH_MEDIUM` Specifies the medium vibration duration.
	`static byte`	`LENGTH_SHORT` Specifies the short vibration duration.
	`static byte`	`OUT_OF_HOLSTER_ONLY` Indicates that the sound notification should be performed only when the device is not in the holster.

Constructor Summary
	`VibrationAlert()` Empty constructor for VibrationAlert

Method Summary
	`int`	`getCount()` Returns the vibration repeat count.
	`byte`	`getHolsterCondition()` Returns the holster condition for this vibration alert.
	`byte`	`getLength()` Returns the vibration duration.
	`boolean`	`isCountInherited()` Indicates whether the vibration count is inherited from a higher level profile.
	`boolean`	`isCustomInherited()` Indicates whether the custom property is inherited from a higher level profile.
	`boolean`	`isEnabledInherited()` Indicates whether the enabled property is inherited from a higher level profile.
	`boolean`	`isHolsterConditionInherited()` Indicates whether the holster condition is inherited from a higher level profile.
	`boolean`	`isLengthInherited()` Indicates whether the vibration duration is inherited from a higher level profile.
	`void`	`setCount(int count)` Sets the vibration repeat count.
	`void`	`setCountInherited(boolean countInherited)` Sets whether the vibration count is inherited from a higher level profile.
	`void`	`setCustomInherited(boolean customInherited)` Sets whether the custom property is inherited from a higher level profile.
	`void`	`setEnabled(boolean enabled)` Sets whether this vibration alert is enabled.
	`void`	`setEnabledInherited(boolean enabledInherited)` Sets whether the enabled property is inherited from a higher level profile.
	`void`	`setHolsterCondition(byte holsterCondition)` Sets the holster condition for this vibration alert.
	`void`	`setHolsterConditionInherited(boolean holsterConditionInherited)` Sets whether the holster condition is inherited from a higher level profile.
	`void`	`setLength(byte length)` Sets the vibration duration.
	`void`	`setLengthInherited(boolean lengthInherited)` Sets whether the vibration duration is inherited from a higher level profile.

Methods inherited from class net.rim.blackberry.api.profiles.NotificationAlert
`isEnabled`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ALWAYS

public static final byte ALWAYS

Indicates that the sound notification should be performed regardless of the holster condition.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

IN_HOLSTER_ONLY

public static final byte IN_HOLSTER_ONLY

Indicates that the sound notification should be performed only when the device is in the holster.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

OUT_OF_HOLSTER_ONLY

public static final byte OUT_OF_HOLSTER_ONLY

Indicates that the sound notification should be performed only when the device is not in the holster.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

LENGTH_LONG

public static final byte LENGTH_LONG

Specifies the long vibration duration.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

LENGTH_MEDIUM

public static final byte LENGTH_MEDIUM

Specifies the medium vibration duration.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

LENGTH_SHORT

public static final byte LENGTH_SHORT

Specifies the short vibration duration.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

Constructor Detail

VibrationAlert

public VibrationAlert()

Empty constructor for VibrationAlert

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

Method Detail

getHolsterCondition

public byte getHolsterCondition()

Returns the holster condition for this vibration alert.

Returns:: The holster condition. This value is one of VibrationAlert.ALWAYS, VibrationAlert.IN_HOLSTER_ONLY, or VibrationAlert.OUT_OF_HOLSTER_ONLY.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setHolsterCondition

public void setHolsterCondition(byte holsterCondition)

Sets the holster condition for this vibration alert.

Parameters:: holsterCondition - The new holster condition. This parameter must be one of VibrationAlert.ALWAYS, VibrationAlert.IN_HOLSTER_ONLY, or VibrationAlert.OUT_OF_HOLSTER_ONLY.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

isCountInherited

public boolean isCountInherited()

Indicates whether the vibration count is inherited from a higher level profile.

Returns:: true if the vibration count is inherited, false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setCountInherited

public void setCountInherited(boolean countInherited)

Sets whether the vibration count is inherited from a higher level profile.

Parameters:: countInherited - If true the vibration count is inherited, if false the vibration count is not inherited.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

isLengthInherited

public boolean isLengthInherited()

Indicates whether the vibration duration is inherited from a higher level profile.

Returns:: true if the vibration duration is inherited, false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setLengthInherited

public void setLengthInherited(boolean lengthInherited)

Sets whether the vibration duration is inherited from a higher level profile.

Parameters:: lengthInherited - If true the vibration duration is inherited, if false the vibration duration is not inherited.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

isHolsterConditionInherited

public boolean isHolsterConditionInherited()

Indicates whether the holster condition is inherited from a higher level profile.

Returns:: true if the holster condition is inherited, false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setHolsterConditionInherited

public void setHolsterConditionInherited(boolean holsterConditionInherited)

Sets whether the holster condition is inherited from a higher level profile.

Parameters:: holsterConditionInherited - If true the holster condition is inherited, if false the holster condition is not inherited.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

getCount

public int getCount()

Returns the vibration repeat count.

Returns:: The vibration repeat count.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setCount

public void setCount(int count)

Sets the vibration repeat count.

Parameters:: count - The new vibration repeat count.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

getLength

public byte getLength()

Returns the vibration duration.

Returns:: The vibration duration. This value is one of VibrationAlert.LENGTH_LONG, VibrationAlert.LENGTH_MEDIUM, or VibrationAlert.LENGTH_SHORT.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setLength

public void setLength(byte length)

Sets the vibration duration.

Parameters:: length - The new vibration duration. This parameter must be one of VibrationAlert.LENGTH_LONG, VibrationAlert.LENGTH_MEDIUM, or VibrationAlert.LENGTH_SHORT.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setEnabled

public void setEnabled(boolean enabled)

Sets whether this vibration alert is enabled.

Parameters:: enabled - If true the vibration alert is enabled, if false the vibration alert is disabled.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

isEnabledInherited

public boolean isEnabledInherited()

Indicates whether the enabled property is inherited from a higher level profile.

Returns:: true if the enabled property is inherited, false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setEnabledInherited

public void setEnabledInherited(boolean enabledInherited)

Sets whether the enabled property is inherited from a higher level profile.

Parameters:: enabledInherited - If true the enabled property is inherited, if false the enabled property is not inherited.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

isCustomInherited

public boolean isCustomInherited()

Indicates whether the custom property is inherited from a higher level profile.

Returns:: true if the custom property is inherited, false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0

setCustomInherited

public void setCustomInherited(boolean customInherited)

Sets whether the custom property is inherited from a higher level profile.

Parameters:: customInherited - If true the custom property is inherited, if false the custom property is not inherited.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 7.1.0