doc: Play Tone command proposed d-bus API.

This commit is contained in:
Andrzej Zaborowski 2010-10-06 12:35:00 +02:00 committed by Denis Kenzior
parent f1be4b2375
commit 8080f233f3
1 changed files with 40 additions and 0 deletions

View File

@ -203,6 +203,46 @@ Methods byte RequestSelection(string title, byte icon_id,
Possible Errors: [service].Error.SimToolkit.EndSession
void PlayTone(string tone, string text, byte icon_id)
Tells the agent to play an audio tone once. The
method should return once the tone is finished
playing. The text parameter contains an optional
text to be displayed to the user. The following
tones are defined:
"dial-tone"
"busy"
"congestion"
"radio-path-acknowledge"
"radio-path-not-available"
"error"
"call-waiting"
"ringing-tone"
"general-beep"
"positive-acknowledgement"
"negative-acknowledgement"
"user-ringing-tone"
"user-sms-alert"
"critical" (high priority)
"vibrate"
"happy"
"sad"
"urgent-action"
"question"
"message-received"
Possible Errors: [service].Error.SimToolkit.EndSession
void LoopTone(string tone, string text, byte icon_id)
Tells the agent to reproduce an audio tone in a
loop until the method call is cancelled. See
PlayTone() above for the list of possible tone names.
The text parameter contains an optional text to
be displayed to the user.
Possible Errors: [service].Error.SimToolkit.EndSession
void Cancel()
Asks the agent to cancel any ongoing operation in