Asterisk-Java

org.asteriskjava.manager.action
Class SipNotifyAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.SipNotifyAction
All Implemented Interfaces:
java.io.Serializable, ManagerAction

public class SipNotifyAction
extends AbstractManagerAction

Send a custom SIP notify message to the specified peer.

All parameters for this event must be specified in the body of this request via multiple variables. At least one variable pair must be specified.

Available since Asterisk 1.6

Since:
1.0.0
Version:
$Id: SipNotifyAction.java 1152 2008-08-22 07:15:35Z srt $
Author:
Laureano
See Also:
Serialized Form

Constructor Summary
SipNotifyAction()
          Creates a new SipNotifyAction.
SipNotifyAction(java.lang.String channel)
          Creates a new SipNotifyAction that will be sent to the specified peer.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getChannel()
          Returns the peer that will receive the notify.
 java.util.Map<java.lang.String,java.lang.String> getVariables()
          Returns the variables to set on the originated call.
 void setChannel(java.lang.String channel)
          Sets the peer to receive the notify to.
 void setVariable(java.lang.String name, java.lang.String value)
          Sets an variable on the originated call.
 void setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
          Sets the variables to set on the originated call.
 
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

SipNotifyAction

public SipNotifyAction()
Creates a new SipNotifyAction.


SipNotifyAction

public SipNotifyAction(java.lang.String channel)
Creates a new SipNotifyAction that will be sent to the specified peer.

Parameters:
channel - the peer to send the notify to either "SIP/peer" or just "peer".
Method Detail

getAction

public java.lang.String getAction()
Returns the name of this action, i.e. "SipNotify".

Specified by:
getAction in interface ManagerAction
Specified by:
getAction in class AbstractManagerAction

setChannel

public void setChannel(java.lang.String channel)
Sets the peer to receive the notify to.

Parameters:
channel - peer to receive the notify to either "SIP/peer" or just "peer".

getChannel

public java.lang.String getChannel()
Returns the peer that will receive the notify.

Returns:
peer

getVariables

public java.util.Map<java.lang.String,java.lang.String> getVariables()
Returns the variables to set on the originated call.

Returns:
a Map containing the variable names as key and their values as value.
Since:
1.0.0

setVariable

public void setVariable(java.lang.String name,
                        java.lang.String value)
Sets an variable on the originated call.

Parameters:
name - the name of the variable to set.
value - the value of the variable to set.
Since:
1.0.0

setVariables

public void setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
Sets the variables to set on the originated call.

Parameters:
variables - a Map containing the variable names as key and their values as value.
Since:
1.0.0

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.