org.asteriskjava.manager.action

Class UserEventAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.UserEventAction

All Implemented Interfaces:

Serializable, ManagerAction

public class UserEventAction
extends AbstractManagerAction

The UserEventAction will send a custom user event to the Asterisk server. This is equivalent to using the UserEvent application in your dial plan. Before you send this event, you must register your event class with the registerUserEventClass method of the ManagerConnection.

Author:

Martin

See Also:

UserEvent, ManagerConnection.registerUserEventClass(Class), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserEventAction()
UserEventAction(UserEvent userEvent) Create the userevent action with userEvent as the event it will send

Method Summary

Modifier and Type	Method and Description
String	getAction() Get the name of this action
UserEvent	getUserEvent()
void	setUserEvent(UserEvent userEvent)

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

UserEventAction

public UserEventAction()

UserEventAction

public UserEventAction(UserEvent userEvent)

Create the userevent action with userEvent as the event it will send

Parameters:

userEvent - the subclass representing a custom event

Method Detail

getAction

public String getAction()

Get the name of this action

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getUserEvent

public UserEvent getUserEvent()

Returns:

the userEvent

setUserEvent

public void setUserEvent(UserEvent userEvent)

Parameters:

userEvent - the userEvent to set

See Also:

UserEvent