Channel (Asterisk-Java 3.3.0 API)

All Known Implementing Classes:

ChannelImpl, ChannelProxy
```
public interface Channel
```
Provides an abstraction for an channel object which is independant of the underlying PBX.

Author:

bsutton

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addHangupListener(ChannelHangupListener listener)` Adds a listener to the channel.
`boolean`	`canDetectHangup()`
`CallerID`	`getCallerID()` Returns the current callerid for this channel.
`long`	`getChannelId()` Each channel is assigned a unique PBX independent id to help track the channels when logging.
`String`	`getChannelName()` returns a fully qualifed channel name which includes the tech.
`AgiChannelActivityAction`	`getCurrentActivityAction()`
`EndPoint`	`getEndPoint()`
`String`	`getExtendedChannelName()` Returns a PBX specific version of the Channel name.
`String`	`getUniqueId()`
`boolean`	`hasCallerID()`
`boolean`	`isConnectedTo(EndPoint endPoint)` Returns true if the given endpont is currently connected to this channel.
`boolean`	`isConsole()`
`boolean`	`isInAgi()`
`boolean`	`isLive()` Returns true if the channel is alive.
`boolean`	`isLocal()` In Asterisk speak, this method returns true if it is a LOCAL/ channel Not quite certain how this will map to other pbx's
`boolean`	`isMute()` Checks if this channel is currently mute.
`boolean`	`isParked()`
`boolean`	`isQuiescent()`
`boolean`	`isSame(Channel rhs)` Compares if two channels are the same logical channel on the pbx.
`boolean`	`isSame(String channelName, String uniqueID)`
`boolean`	`isZombie()` Returns true if the channel has been marked as in a zombie state.
`void`	`notifyHangupListeners(Integer cause, String causeText)`
`void`	`removeListener(ChannelHangupListener listener)`
`void`	`rename(String newName, String uniqueId)` Called to rename a channel
`boolean`	`sameEndPoint(Channel rhs)`
`boolean`	`sameEndPoint(EndPoint extensionRoaming)`
`boolean`	`sameExtenededChannelName(String channelName)` Compares if this channel is the same as the named channel.
`void`	`setCallerId(CallerID buildCallerID)`
`void`	`setCurrentActivityAction(AgiChannelActivityAction action)`
`void`	`setIsInAgi(boolean b)`
`void`	`setMute(boolean muteState)` This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
`void`	`setParked(boolean parked)` This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
`boolean`	`waitForChannelToReachAgi(long timeout, TimeUnit timeunit)`

- Method Detail
  - isSame
```
boolean isSame(Channel rhs)
```
    Compares if two channels are the same logical channel on the pbx. This comparison uses the full unique name of the channel not just the abbreviated peer name. e.g. SIP/100-00000100
    
    Parameters:
    
    rhs -
    
    Returns:
  - isSame
```
boolean isSame(String channelName,
               String uniqueID)
```
  - sameEndPoint
```
boolean sameEndPoint(Channel rhs)
```
  - sameEndPoint
```
boolean sameEndPoint(EndPoint extensionRoaming)
```
  - sameExtenededChannelName
```
boolean sameExtenededChannelName(String channelName)
```
    Compares if this channel is the same as the named channel.
    
    Parameters:
    
    channelName -
    
    Returns:
  - setParked
```
void setParked(boolean parked)
```
    This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
    
    See Also:
    
    iPBX.iParkCallActivity park(iChannel channel, Direction direction, boolean parkState) for a method which actually parks the channel.
  - setMute
```
void setMute(boolean muteState)
```
    This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
    
    See Also:
    
    iPBX.iMuteCallActivity mute(iChannel channel, Direction direction, boolean muteState) for a method which actually mutes the channel.
  - getChannelId
```
long getChannelId()
```
    Each channel is assigned a unique PBX independent id to help track the channels when logging.
    
    Returns:
  - isLive
```
boolean isLive()
```
    Returns true if the channel is alive. A channel is considered to be alive from the moment it is created until we get a notification that it has been hungup.
    
    Returns:
  - addHangupListener
```
void addHangupListener(ChannelHangupListener listener)
```
    Adds a listener to the channel. The channel will send a hungup notification to the listener when it hungup. A channel must be able to support multiple listeners.
    
    Parameters:
    
    call -
  - removeListener
```
void removeListener(ChannelHangupListener listener)
```
  - isConnectedTo
```
boolean isConnectedTo(EndPoint endPoint)
```
    Returns true if the given endpont is currently connected to this channel.
    
    Parameters:
    
    extension -
    
    Returns:
  - getChannelName
```
String getChannelName()
```
    returns a fully qualifed channel name which includes the tech. e.g. SIP/100-00000342
    
    Returns:
  - getEndPoint
```
EndPoint getEndPoint()
```
  - isMute
```
boolean isMute()
```
    Checks if this channel is currently mute. A channel is mute if the party connected to this channel cannot hear any audio.
    
    Returns:
  - isLocal
```
boolean isLocal()
```
    In Asterisk speak, this method returns true if it is a LOCAL/ channel Not quite certain how this will map to other pbx's
    
    Returns:
  - isParked
```
boolean isParked()
```
    Returns:
    
    true if the channel is currently parked.
  - isZombie
```
boolean isZombie()
```
    Returns true if the channel has been marked as in a zombie state.
    
    Returns:
  - isConsole
```
boolean isConsole()
```
    Returns:
    
    true if the channel was originated from the console (Console/DSP).
  - getCallerID
```
CallerID getCallerID()
```
    Returns the current callerid for this channel. Note: on some systems this involves a round trip to the pbx.
    
    Returns:
  - getExtendedChannelName
```
String getExtendedChannelName()
```
    Returns a PBX specific version of the Channel name.
    
    Returns:
  - notifyHangupListeners
```
void notifyHangupListeners(Integer cause,
                           String causeText)
```
  - canDetectHangup
```
boolean canDetectHangup()
```
  - isQuiescent
```
boolean isQuiescent()
```
  - hasCallerID
```
boolean hasCallerID()
```
  - getCurrentActivityAction
```
AgiChannelActivityAction getCurrentActivityAction()
```
  - setCurrentActivityAction
```
void setCurrentActivityAction(AgiChannelActivityAction action)
```
  - setIsInAgi
```
void setIsInAgi(boolean b)
```
  - isInAgi
```
boolean isInAgi()
```
  - getUniqueId
```
String getUniqueId()
```
  - waitForChannelToReachAgi
```
boolean waitForChannelToReachAgi(long timeout,
                                 TimeUnit timeunit)
                          throws InterruptedException
```
    Throws:
    
    InterruptedException
  - setCallerId
```
void setCallerId(CallerID buildCallerID)
```
  - rename
```
void rename(String newName,
            String uniqueId)
     throws InvalidChannelName
```
    Called to rename a channel
    
    Parameters:
    
    newname - the new name of the channel
    
    Throws:
    
    InvalidChannelName

Interface Channel

Method Summary

Method Detail

isSame

isSame

sameEndPoint

sameEndPoint

sameExtenededChannelName

setParked

setMute

getChannelId

isLive

addHangupListener

removeListener

isConnectedTo

getChannelName

getEndPoint

isMute

isLocal

isParked

isZombie

isConsole

getCallerID

getExtendedChannelName

notifyHangupListeners

canDetectHangup

isQuiescent

hasCallerID

getCurrentActivityAction

setCurrentActivityAction

setIsInAgi

isInAgi

getUniqueId

waitForChannelToReachAgi

setCallerId

rename