AGIChannelImpl (Asterisk-Java 0.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.asterisk.fastagi.impl
Class AGIChannelImpl

java.lang.Object
  net.sf.asterisk.fastagi.impl.AGIChannelImpl

All Implemented Interfaces:: AGIChannel

public class AGIChannelImpl
extends java.lang.Object
implements AGIChannel
extends java.lang.Object
implements AGIChannel

Default implementation of the AGIChannel interface.

Version:: $Id: AGIChannelImpl.java,v 1.8 2005/11/27 17:31:05 srt Exp $
Author:: srt

Constructor Summary
`AGIChannelImpl(AGIWriter agiWriter, AGIReader agiReader)`
`AGIChannelImpl(SocketConnectionFacade socket)`

Method Summary
`void`	`answer()` Answers the channel.
`int`	`exec(java.lang.String application)` Executes the given command.
`int`	`exec(java.lang.String application, java.lang.String options)` Executes the given command.
`int`	`getChannelStatus()` Returns the status of the channel. Return values: 0 Channel is down and available 1 Channel is down, but reserved 2 Channel is off hook 3 Digits (or equivalent) have been dialed 4 Line is ringing 5 Remote end is ringing 6 Line is up 7 Line is busy
`java.lang.String`	`getData(java.lang.String file)` Plays the given file and waits for the user to enter DTMF digits until he presses '#'.
`java.lang.String`	`getData(java.lang.String file, long timeout)` Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs.
`java.lang.String`	`getData(java.lang.String file, long timeout, int maxDigits)` Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs or the maximum number of digits has been entered.
`java.lang.String`	`getFullVariable(java.lang.String name)` Returns the value of the current channel variable, unlike getVariable() this method understands complex variable names and builtin variables. Available since Asterisk 1.2.
`java.lang.String`	`getFullVariable(java.lang.String name, java.lang.String channel)` Returns the value of the given channel variable. Available since Asterisk 1.2.
`char`	`getOption(java.lang.String file, java.lang.String escapeDigits)` Plays the given file, and waits for the user to press one of the given digits.
`char`	`getOption(java.lang.String file, java.lang.String escapeDigits, int timeout)` Plays the given file, and waits for the user to press one of the given digits.
`java.lang.String`	`getVariable(java.lang.String name)` Returns the value of the current channel variable.
`void`	`hangup()` Hangs the channel up.
`void`	`playMusicOnHold()` Plays music on hold from the default music on hold class.
`void`	`playMusicOnHold(java.lang.String musicOnHoldClass)` Plays music on hold from the given music on hold class.
`void`	`sayAlpha(java.lang.String text)` Says the given character string.
`char`	`sayAlpha(java.lang.String text, java.lang.String escapeDigits)` Says the given character string, returning early if any of the given DTMF number are received on the channel.
`void`	`sayDateTime(long time)` Says the given time. Available since Asterisk 1.2.
`char`	`sayDateTime(long time, java.lang.String escapeDigits)` Says the given time and allows interruption by one of the given escape digits. Available since Asterisk 1.2.
`char`	`sayDateTime(long time, java.lang.String escapeDigits, java.lang.String format)` Says the given time in the given format and allows interruption by one of the given escape digits. Available since Asterisk 1.2.
`char`	`sayDateTime(long time, java.lang.String escapeDigits, java.lang.String format, java.lang.String timezone)` Says the given time in the given format and timezone and allows interruption by one of the given escape digits. Available since Asterisk 1.2.
`void`	`sayDigits(java.lang.String digits)` Says the given digit string.
`char`	`sayDigits(java.lang.String digits, java.lang.String escapeDigits)` Says the given number, returning early if any of the given DTMF number are received on the channel.
`void`	`sayNumber(java.lang.String number)` Says the given number.
`char`	`sayNumber(java.lang.String number, java.lang.String escapeDigits)` Says the given number, returning early if any of the given DTMF number are received on the channel.
`void`	`sayPhonetic(java.lang.String text)` Says the given character string with phonetics.
`char`	`sayPhonetic(java.lang.String text, java.lang.String escapeDigits)` Says the given character string with phonetics, returning early if any of the given DTMF number are received on the channel.
`void`	`sayTime(long time)` Says the given time.
`char`	`sayTime(long time, java.lang.String escapeDigits)` Says the given time, returning early if any of the given DTMF number are received on the channel.
`AGIReply`	`sendCommand(AGICommand command)` Sends a command to asterisk and returns the corresponding reply.
`void`	`setAutoHangup(int time)` Cause the channel to automatically hangup at the given number of seconds in the future.
`void`	`setCallerId(java.lang.String callerId)` Sets the caller id on the current channel.
`void`	`setContext(java.lang.String context)` Sets the context for continuation upon exiting the application.
`void`	`setExtension(java.lang.String extension)` Sets the extension for continuation upon exiting the application.
`void`	`setPriority(java.lang.String priority)` Sets the priority or label for continuation upon exiting the application.
`void`	`setVariable(java.lang.String name, java.lang.String value)` Sets the value of the current channel variable to a new value.
`void`	`stopMusicOnHold()` Stops playing music on hold.
`void`	`streamFile(java.lang.String file)` Plays the given file.
`char`	`streamFile(java.lang.String file, java.lang.String escapeDigits)` Plays the given file and allows the user to escape by pressing one of the given digit.
`char`	`waitForDigit(int timeout)` Waits up to 'timeout' milliseconds to receive a DTMF digit.

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

Constructor Detail

AGIChannelImpl

public AGIChannelImpl(SocketConnectionFacade socket)

AGIChannelImpl

public AGIChannelImpl(AGIWriter agiWriter,
                      AGIReader agiReader)

Method Detail