org.asteriskjava.manager.action

Class MessageSendAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MessageSendAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MessageSendAction
extends AbstractManagerAction

Send a custom SIP message to the specified peer. Available since Asterisk 11

Since:

1.0.0

Version:

$Id$

Author:

Michael Will

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageSendAction()

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action for example "Hangup".
String	getBase64body() Retrieves content encoded in base64
String	getBody() Content of the message in plain text ascii Please consider to use getBase64Body instead to avoid encoding problems
String	getFrom() get From String
String	getTo() Retrives destination of message
Map<String,String>	getVariables() Returns the variables to set on the originated call.
void	setBase64body(String base64body) Sets the content of the message body encode in base64 MessageSendAction sipSendMessage = new MessageSendAction(); sipSendMessage.setTo("sip:phoneuserid"); sipSendMessage.setVariable("Content-Type", "text/plain"); sipSendMessage.setVariable("P-hint", "usrloc applied"); sipSendMessage.setActionId(UUID.randomUUID().toString()); sipSendMessage.setBase64body(new String(Base64.encodeBase64(message.getBytes("UTF-8")), "UTF-8"));
void	setBody(String body) Sets the content of the message Please consider to use setBase64Body instead to avoid encoding problems
void	setFrom(String from) set From String
void	setTo(String to) Set destination of message
void	setVariable(String name, String value) Sets an variable 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

MessageSendAction

public MessageSendAction()

Method Detail

getAction

public String getAction()

Description copied from interface: ManagerAction

Returns the name of the action for example "Hangup".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getVariables

public Map<String,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(String name,
                        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

getTo

public String getTo()

Retrives destination of message

Returns:

String in format like sip:userid

setTo

public void setTo(String to)

Set destination of message

Parameters:

to - String in format like sip:userid

getFrom

public String getFrom()

get From String

Returns:

String in form like sip:asterisk@server-ip

setFrom

public void setFrom(String from)

set From String

Parameters:

String - from in form like sip:asterisk@server-ip

getBody

public String getBody()

Content of the message in plain text ascii Please consider to use getBase64Body instead to avoid encoding problems

Returns:

String with Message content

setBody

public void setBody(String body)

Sets the content of the message Please consider to use setBase64Body instead to avoid encoding problems

Parameters:

body - String with plain ascii content

getBase64body

public String getBase64body()

Retrieves content encoded in base64

Returns:

Base64 encoded String

setBase64body

public void setBase64body(String base64body)

Sets the content of the message body encode in base64 MessageSendAction sipSendMessage = new MessageSendAction(); sipSendMessage.setTo("sip:phoneuserid"); sipSendMessage.setVariable("Content-Type", "text/plain"); sipSendMessage.setVariable("P-hint", "usrloc applied"); sipSendMessage.setActionId(UUID.randomUUID().toString()); sipSendMessage.setBase64body(new String(Base64.encodeBase64(message.getBytes("UTF-8")), "UTF-8"));

Parameters:

base64body -