All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.telephony.phone.PhoneRinger

public interface PhoneRinger
extends Component

Variable Index

 o FULL
Ringer volume definition for the ringer at maximum volume.
 o MIDDLE
Ringer volume definition for the middle volume.
 o OFF
Ringer volume definition for the ringer off.

Method Index

 o getNumberOfRingPatterns()
Returns the number of available ringing patterns.
 o getNumberOfRings()
Returns the number of complete ring cycles that the ringer has been ringing.
 o getRingerPattern()
Returns the current ringer pattern.
 o getRingerVolume()
Returns the current ringer volume.
 o isRingerOn()
Returns true if the ringer is on, false otherwise.
 o setRingerPattern(int)
Set the ringer pattern given an valid index number returned by getNumberOfRingPatterns().
 o setRingerVolume(int)
Sets the ringer volume between ZERO or FULL, inclusive.

Variables

 o OFF
 public static final int OFF
Ringer volume definition for the ringer off.

 o MIDDLE
 public static final int MIDDLE
Ringer volume definition for the middle volume.

 o FULL
 public static final int FULL
Ringer volume definition for the ringer at maximum volume.

Methods

 o isRingerOn
 public abstract int isRingerOn() throws PlatformException
Returns true if the ringer is on, false otherwise.

Returns:
True if the ringer is on, false otherwise
Throws: PlatformException
A platform-specific exception occurred.
 o getRingerVolume
 public abstract int getRingerVolume() throws PlatformException
Returns the current ringer volume.

Returns:
The current ringer volume
Throws: PlatformException
A platform-specific exception occurred.
 o setRingerVolume
 public abstract void setRingerVolume(int volume) throws InvalidArgumentException, PlatformException
Sets the ringer volume between ZERO or FULL, inclusive.

Parameters:
volume - The ringer volume, between ZERO and FULL, inclusive.
Throws: InvalidArgumentException
The volume provided was not valid.
Throws: PlatformException
A platform-specific exception occurred.
 o getRingerPattern
 public abstract int getRingerPattern() throws PlatformException
Returns the current ringer pattern.

Returns:
The current ringer pattern.
Throws: PlatformException
A platform-specific exception occurred.
 o getNumberOfRingPatterns
 public abstract int getNumberOfRingPatterns() throws PlatformException
Returns the number of available ringing patterns. An index between zero and the returns value minus one may be used for the setRingerPattern() method.

Returns:
The number of available ringer patterns.
Throws: PlatformException
A platform-specific exception occurred.
 o setRingerPattern
 public abstract void setRingerPattern(int ringerPattern) throws InvalidArgumentException, PlatformException
Set the ringer pattern given an valid index number returned by getNumberOfRingPatterns().

Parameters:
ringerPattern - The desired ringer pattern.
Throws: InvalidArgumentException
The ring pattern provided was not valid.
Throws: PlatformException
A platform-specific exception occurred.
 o getNumberOfRings
 public abstract int getNumberOfRings() throws PlatformException
Returns the number of complete ring cycles that the ringer has been ringing. A value of 0 indicates that the ringer is not being rung.

Returns:
The current ringer count.
Throws: PlatformException
A platform-specific exception occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index