am 4056ab97: Merge "Add permission requirements to SipAudioCall and SipManager javadoc." into gingerbread

Merge commit '4056ab97be6224dcc00ac70843544790f2d65fb7' into gingerbread-plus-aosp

* commit '4056ab97be6224dcc00ac70843544790f2d65fb7':
  Add permission requirements to SipAudioCall and SipManager javadoc.
This commit is contained in:
Hung-ying Tyan
2010-10-20 14:03:54 -07:00
committed by Android Git Automerger
2 changed files with 22 additions and 1 deletions

View File

@ -41,6 +41,16 @@ import java.util.Map;
* facilitates instantiating a {@code SipAudioCall} object for making/receiving
* calls. See {@link SipManager#makeAudioCall} and
* {@link SipManager#takeAudioCall}.
*
* <p>Requires permissions to use this class:
* {@link android.Manifest.permission#INTERNET} and
* {@link android.Manifest.permission#USE_SIP}.
* <br/>Requires permissions to {@link #startAudio}:
* {@link android.Manifest.permission#RECORD_AUDIO},
* {@link android.Manifest.permission#ACCESS_WIFI_STATE} and
* {@link android.Manifest.permission#WAKE_LOCK}.
* <br/>Requires permissions to {@link #setSpeakerMode}:
* {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS}.
*/
public class SipAudioCall {
private static final String TAG = SipAudioCall.class.getSimpleName();
@ -774,7 +784,11 @@ public class SipAudioCall {
}
}
/** Puts the device to speaker mode. */
/**
* Puts the device to speaker mode.
* <p>Requires permission:
* {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS}.
*/
public void setSpeakerMode(boolean speakerMode) {
synchronized (this) {
((AudioManager) mContext.getSystemService(Context.AUDIO_SERVICE))
@ -874,6 +888,10 @@ public class SipAudioCall {
/**
* Starts the audio for the established call. This method should be called
* after {@link Listener#onCallEstablished} is called.
* <p>Requires permission:
* {@link android.Manifest.permission#RECORD_AUDIO},
* {@link android.Manifest.permission#ACCESS_WIFI_STATE} and
* {@link android.Manifest.permission#WAKE_LOCK}.
*/
public void startAudio() {
try {

View File

@ -50,6 +50,9 @@ import java.text.ParseException;
* </ul>
* {@code SipManager} can only be instantiated if SIP API is supported by the
* device. (See {@link #isApiSupported}).
* <p>Requires permissions to use this class:
* {@link android.Manifest.permission#INTERNET} and
* {@link android.Manifest.permission#USE_SIP}.
*/
public class SipManager {
/**