|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.asteriskjava.fastagi.command.AbstractAgiCommand
org.asteriskjava.fastagi.command.ReceiveTextCommand
public class ReceiveTextCommand
Receives a string of text on a channel.
Specify timeout to be the maximum time to wait for input in milliseconds, or 0 for infinite.
Most channels do not support the reception of text.
Returns -1 for failure or 1 for success, and the string in parentheses.
Available since Asterisk 1.2.
| Constructor Summary | |
|---|---|
ReceiveTextCommand()
Creates a new ReceiveTextCommand with a default timeout of 0 meaning to wait for ever. |
|
ReceiveTextCommand(int timeout)
Creates a new ReceiveTextCommand. |
|
| Method Summary | |
|---|---|
java.lang.String |
buildCommand()
Returns a string suitable to be sent to asterisk. |
int |
getTimeout()
Returns the milliseconds to wait for the channel to receive the text. |
void |
setTimeout(int timeout)
Sets the milliseconds to wait for the channel to receive the text. |
| Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand |
|---|
escapeAndQuote, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ReceiveTextCommand()
public ReceiveTextCommand(int timeout)
timeout - the milliseconds to wait for the channel to receive the
text.| Method Detail |
|---|
public int getTimeout()
public void setTimeout(int timeout)
timeout - the milliseconds to wait for the channel to receive the
text.public java.lang.String buildCommand()
AgiCommand
buildCommand in interface AgiCommandbuildCommand in class AbstractAgiCommand
|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||