|
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
public abstract class AbstractManagerAction
This class implements the ManagerAction interface and can serve as base class for your concrete Action implementations.
Constructor Summary | |
---|---|
AbstractManagerAction()
|
Method Summary | |
---|---|
abstract java.lang.String |
getAction()
Returns the name of the action for example "Hangup". |
java.lang.String |
getActionId()
Returns the action id. |
void |
setActionId(java.lang.String actionId)
Sets the action id. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractManagerAction()
Method Detail |
---|
public abstract java.lang.String getAction()
ManagerAction
getAction
in interface ManagerAction
public java.lang.String getActionId()
ManagerAction
getActionId
in interface ManagerAction
public void setActionId(java.lang.String actionId)
ManagerAction
If the action id is set and sent to the asterisk server any response returned by the Asterisk server will include the same id. This way the action id can be used to track actions and their corresponding responses and response events.
Note that Asterisk-Java uses its own internal action id to match actions with the corresponding responses and events. Though the internal action is never exposed to the application code. So if you want to handle reponses or response events on your own your application must set a unique action id using this method otherwise the action id of the reponse and response event objects passed to your application will be null.
setActionId
in interface ManagerAction
actionId
- the user provided action id to set.ManagerResponse.getActionId()
,
ResponseEvent.getActionId()
public java.lang.String toString()
toString
in class java.lang.Object
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |