QueueMemberEvent (Asterisk-Java 3.1.0 API)

java.lang.Object
- java.util.EventObject
- - org.asteriskjava.manager.event.ManagerEvent
  - - org.asteriskjava.manager.event.ResponseEvent
    - - org.asteriskjava.manager.event.QueueMemberEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

QueueMemberStatusEvent
```
public class QueueMemberEvent
extends ResponseEvent
```
A QueueMemberEvent is triggered in response to a QueueStatusAction and contains information about a member of a queue.
It is implemented in apps/app_queue.c

Version:

$Id$

Author:

srt

See Also:

QueueStatusAction, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AST_DEVICE_BUSY`
`static int`	`AST_DEVICE_INUSE`
`static int`	`AST_DEVICE_INVALID`
`static int`	`AST_DEVICE_NOT_INUSE` Queue member is available.
`static int`	`AST_DEVICE_ONHOLD`
`static int`	`AST_DEVICE_RINGING`
`static int`	`AST_DEVICE_RINGINUSE`
`static int`	`AST_DEVICE_UNAVAILABLE`
`static int`	`AST_DEVICE_UNKNOWN`
`static String`	`MEMBERSHIP_DYNAMIC`
`static String`	`MEMBERSHIP_STATIC`

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent
callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description

QueueMemberEvent(Object source)

Constructors
Constructor and Description
`QueueMemberEvent(Object source)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`getCallsTaken()` Returns the number of calls answered by the member.
`Integer`	`getIncall()`
`String`	`getInterface()` Returns the name of the member's interface.
`Long`	`getLastCall()` Returns the time the last successful call answered by the added member was hungup.
`Long`	`getLastPause()` The time when started last pause for queue member.
`String`	`getLocation()` Deprecated. since Asterisk 12
`String`	`getMemberName()` Deprecated. since 1.0.0. Use `getName()` instead.
`String`	`getMembership()` Returns if this member has been dynamically added by the QueueAdd command (in the dialplan or via the Manager API) or if this member is has been statically defined in `queues.conf`.
`String`	`getName()` Returns the name of the member.
`Boolean`	`getPaused()` Is this queue member paused (not accepting calls)?
`String`	`getPausedreason()`
`Integer`	`getPenalty()` Returns the penalty for the added member.
`String`	`getQueue()` Returns the name of the queue.
`String`	`getStateinterface()`
`Integer`	`getStatus()` Returns the status of this queue member.
`boolean`	`isDynamic()` Convenience method that checks whether this member has been dynamically added by the QueueAdd command.
`boolean`	`isStatic()` Convenience method that checks whether this member has been statically defined in `queues.conf`.
`void`	`setCallsTaken(Integer callsTaken)` Sets the number of calls answered by the added member.
`void`	`setIncall(Integer incall)`
`void`	`setInterface(String _interface)` Sets the name of the member's interface.
`void`	`setLastCall(Long lastCall)` Sets the time the last successful call answered by this member was hungup.
`void`	`setLastPause(Long lastPause)` Sets the time when started last pause for queue member.
`void`	`setLocation(String _interface)` Deprecated. since Asterisk 12
`void`	`setMemberName(String memberName)`
`void`	`setMembership(String membership)` Sets if this member has been dynamically or statically added.
`void`	`setName(String name)`
`void`	`setPaused(Boolean paused)` Sets if this member has been paused.
`void`	`setPausedreason(String pausedreason)`
`void`	`setPenalty(Integer penalty)` Sets the penalty for this member.
`void`	`setQueue(String queue)` Sets the name of the queue.
`void`	`setStateinterface(String stateinterface)`
`void`	`setStatus(Integer status)` Sets the status of this queue member.

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent
getActionId, getInternalActionId, setActionId, setInternalActionId

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, toString

Methods inherited from class java.util.EventObject
getSource

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

- Field Detail
  - AST_DEVICE_UNKNOWN
```
public static final int AST_DEVICE_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_NOT_INUSE
```
public static final int AST_DEVICE_NOT_INUSE
```
    Queue member is available.
    
    See Also:
    
    Constant Field Values
  - AST_DEVICE_INUSE
```
public static final int AST_DEVICE_INUSE
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_BUSY
```
public static final int AST_DEVICE_BUSY
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_INVALID
```
public static final int AST_DEVICE_INVALID
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_UNAVAILABLE
```
public static final int AST_DEVICE_UNAVAILABLE
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_RINGING
```
public static final int AST_DEVICE_RINGING
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_RINGINUSE
```
public static final int AST_DEVICE_RINGINUSE
```
    See Also:
    
    Constant Field Values
  - AST_DEVICE_ONHOLD
```
public static final int AST_DEVICE_ONHOLD
```
    See Also:
    
    Constant Field Values
  - MEMBERSHIP_STATIC
```
public static final String MEMBERSHIP_STATIC
```
    See Also:
    
    Constant Field Values
  - MEMBERSHIP_DYNAMIC
```
public static final String MEMBERSHIP_DYNAMIC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QueueMemberEvent
```
public QueueMemberEvent(Object source)
```
    Parameters:
    
    source -
- Method Detail
  - getQueue
```
public String getQueue()
```
    Returns the name of the queue.
    
    Returns:
    
    the name of the queue.
  - setQueue
```
public void setQueue(String queue)
```
    Sets the name of the queue.
    
    Parameters:
    
    queue - the name of the queue.
  - getInterface
```
public final String getInterface()
```
    Returns the name of the member's interface.
    E.g. the channel name or agent group.
    
    Returns:
    
    the name of the member's interface.
  - setInterface
```
public final void setInterface(String _interface)
```
    Sets the name of the member's interface.
    
    Parameters:
    
    member - the name of the member's interface.
  - getLocation
```
@Deprecated
public final String getLocation()
```
    Deprecated. since Asterisk 12
    
    Returns the name of the member's interface.
    E.g. the channel name or agent group.
    
    Returns:
    
    the name of the member's interface.
  - setLocation
```
@Deprecated
public final void setLocation(String _interface)
```
    Deprecated. since Asterisk 12
    
    Sets the name of the member's interface.
    
    Parameters:
    
    member - the name of the member's interface.
  - getMembership
```
public String getMembership()
```
    Returns if this member has been dynamically added by the QueueAdd command (in the dialplan or via the Manager API) or if this member is has been statically defined in queues.conf.
    
    Returns:
    
    "dynamic" if the added member is a dynamic queue member, "static" if the added member is a static queue member.
  - isStatic
```
public boolean isStatic()
```
    Convenience method that checks whether this member has been statically defined in queues.conf.
    
    Returns:
    
    true if this member has been statically defined in queues.conf, false otherwise.
    
    Since:
    
    0.3
  - isDynamic
```
public boolean isDynamic()
```
    Convenience method that checks whether this member has been dynamically added by the QueueAdd command.
    
    Returns:
    
    true if this member has been dynamically added by the QueueAdd command, false otherwise.
    
    Since:
    
    0.3
  - setMembership
```
public void setMembership(String membership)
```
    Sets if this member has been dynamically or statically added.
    
    Parameters:
    
    membership - "dynamic" if the added member is a dynamic queue member, "static" if the added member is a static queue member.
  - getPenalty
```
public Integer getPenalty()
```
    Returns the penalty for the added member. When calls are distributed members with higher penalties are considered last.
    
    Returns:
    
    the penalty for the added member.
  - setPenalty
```
public void setPenalty(Integer penalty)
```
    Sets the penalty for this member.
    
    Parameters:
    
    penalty - the penalty for this member.
  - getCallsTaken
```
public Integer getCallsTaken()
```
    Returns the number of calls answered by the member.
    
    Returns:
    
    the number of calls answered by the member.
  - setCallsTaken
```
public void setCallsTaken(Integer callsTaken)
```
    Sets the number of calls answered by the added member.
    
    Parameters:
    
    callsTaken - the number of calls answered by the added member.
  - getLastCall
```
public Long getLastCall()
```
    Returns the time the last successful call answered by the added member was hungup.
    
    Returns:
    
    the time (in seconds since 01/01/1970) the last successful call answered by the added member was hungup.
  - setLastCall
```
public void setLastCall(Long lastCall)
```
    Sets the time the last successful call answered by this member was hungup.
    
    Parameters:
    
    lastCall - the time (in seconds since 01/01/1970) the last successful call answered by the added member was hungup.
  - getLastPause
```
public Long getLastPause()
```
    The time when started last pause for queue member.
    
    Returns:
    
    the time (in seconds since 01/01/1970)
  - setLastPause
```
public void setLastPause(Long lastPause)
```
    Sets the time when started last pause for queue member.
    
    Parameters:
    
    lastPause - the time (in seconds since 01/01/1970)
  - getStatus
```
public Integer getStatus()
```
    Returns the status of this queue member.
    Available since Asterisk 1.2
    Valid status codes are:
    
    AST_DEVICE_UNKNOWN (0)
    
    Device valid but unknown channel state
    
    AST_DEVICE_NOT_INUSE (1)
    
    Device is not used
    
    AST_DEVICE_INUSE (2)
    
    Device is in use
    
    AST_DEVICE_BUSY (3)
    
    Device is Busy
    
    AST_DEVICE_INVALID (4)
    
    Device is invalid
    
    AST_DEVICE_UNAVAILABLE (5)
    
    Device is unavaiable
    
    AST_DEVICE_RINGING (6)
    
    Device is ringing
    
    AST_DEVICE_RINGINUSE (7)
    
    Device is ringing and in use
    
    AST_DEVICE_ONHOLD (8)
    
    Device is on hold
    
    Returns:
    
    the status of this queue member or null if this attribute is not supported by your version of Asterisk.
    
    Since:
    
    0.2
  - setStatus
```
public void setStatus(Integer status)
```
    Sets the status of this queue member.
    
    Parameters:
    
    status - the status of this queue member
    
    Since:
    
    0.2
  - getPaused
```
public Boolean getPaused()
```
    Is this queue member paused (not accepting calls)?
    Available since Asterisk 1.2.
    
    Returns:
    
    Boolean.TRUE if this member has been paused, Boolean.FALSE if not or null if pausing is not supported by your version of Asterisk.
    
    Since:
    
    0.2
  - setPaused
```
public void setPaused(Boolean paused)
```
    Sets if this member has been paused.
    
    Since:
    
    0.2
  - getName
```
public String getName()
```
    Returns the name of the member.
    
    Returns:
    
    the name of the member supplied for logging when the member is added
    
    Since:
    
    1.0.0
  - setName
```
public void setName(String name)
```
  - getMemberName
```
@Deprecated
public String getMemberName()
```
    Deprecated. since 1.0.0. Use getName() instead.
    
    Returns the name of the member.
    
    Returns:
    
    the name of the member supplied for logging when the member is added
  - setMemberName
```
public void setMemberName(String memberName)
```
  - getStateinterface
```
public String getStateinterface()
```
    Returns:
    
    Name of the interface where device state is taken from.
  - setStateinterface
```
public void setStateinterface(String stateinterface)
```
  - getIncall
```
public Integer getIncall()
```
    Returns:
    
    1 if is incall 0 if not
  - setIncall
```
public void setIncall(Integer incall)
```
  - getPausedreason
```
public String getPausedreason()
```
  - setPausedreason
```
public void setPausedreason(String pausedreason)
```

Class QueueMemberEvent

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

AST_DEVICE_UNKNOWN

AST_DEVICE_NOT_INUSE

AST_DEVICE_INUSE

AST_DEVICE_BUSY

AST_DEVICE_INVALID

AST_DEVICE_UNAVAILABLE

AST_DEVICE_RINGING

AST_DEVICE_RINGINUSE

AST_DEVICE_ONHOLD

MEMBERSHIP_STATIC

MEMBERSHIP_DYNAMIC

Constructor Detail

QueueMemberEvent

Method Detail

getQueue

setQueue

getInterface

setInterface

getLocation

setLocation

getMembership

isStatic

isDynamic

setMembership

getPenalty

setPenalty

getCallsTaken

setCallsTaken

getLastCall

setLastCall

getLastPause

setLastPause

getStatus

setStatus

getPaused

setPaused

getName

setName

getMemberName

setMemberName

getStateinterface

setStateinterface

getIncall

setIncall

getPausedreason

setPausedreason