|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.asteriskjava.manager.action.AbstractManagerAction
org.asteriskjava.manager.action.SipShowPeerAction
public class SipShowPeerAction
Retrieves a the details about a given SIP peer.
The result is returned in the response received in reply to this action.
Use ManagerResponse.getAttribute(String)
to retrieve the properties. Consider using SipPeersAction
instead.
Available since Asterisk 1.2
SipPeersAction
,
SipShowPeerResponse
,
Serialized FormConstructor Summary | |
---|---|
SipShowPeerAction()
Creates a new empty SipShowPeerAction. |
|
SipShowPeerAction(java.lang.String peer)
Creates a new SipShowPeerAction that requests the details about the given SIP peer. |
Method Summary | |
---|---|
java.lang.String |
getAction()
Returns the name of the action for example "Hangup". |
java.lang.String |
getPeer()
Returns the name of the peer to retrieve. |
void |
setPeer(java.lang.String peer)
Sets the name of the peer to retrieve. |
Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction |
---|
getActionId, setActionId, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SipShowPeerAction()
public SipShowPeerAction(java.lang.String peer)
This is just the peer name without the channel type prefix. For example if your channel is called "SIP/john", the peer name is just "john".
peer
- the name of the SIP peer to retrieve details for.Method Detail |
---|
public java.lang.String getAction()
ManagerAction
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.String getPeer()
This parameter is mandatory.
public void setPeer(java.lang.String peer)
This is just the peer name without the channel type prefix. For example if your channel is called "SIP/john", the peer name is just "john".
This parameter is mandatory.
peer
- the name of the peer to retrieve without the channel type prefix.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |