public abstract class

JunctionExtra

extends Object
java.lang.Object
   ↳ edu.stanford.junction.api.activity.JunctionExtra
Known Direct Subclasses
Known Indirect Subclasses

Summary

Public Constructors
JunctionExtra()
Public Methods
void afterActivityCreate()
void afterActivityJoin()
void afterOnMessageReceived(MessageHeader h, JSONObject msg)
boolean beforeActivityCreate()
Called before an actor joins an activity.
boolean beforeActivityJoin()
Called before an actor joins an activity.
boolean beforeOnMessageReceived(MessageHeader h, JSONObject msg)
Returns true if the normal event handling should proceed; Return false to stop cascading.
boolean beforeSendMessage(JSONObject msg)
Convenience method to which, by default, all message sending methods call through.
boolean beforeSendMessageToActor(String actorID, JSONObject msg)
boolean beforeSendMessageToRole(String role, JSONObject msg)
boolean beforeSendMessageToSession(JSONObject msg)
final JunctionActor getActor()
Provides access to the associated JunctionActor.
Integer getPriority()
Returns an integer priority for this Extra.
void setActor(JunctionActor actor)
This method should only be called internally.
void test()
void updateInvitationParameters(Map<String, String> params)
Update the parameters that will be sent in an invitation
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public JunctionExtra ()

Public Methods

public void afterActivityCreate ()

public void afterActivityJoin ()

public void afterOnMessageReceived (MessageHeader h, JSONObject msg)

public boolean beforeActivityCreate ()

Called before an actor joins an activity. Returning false aborts the attempted join.

public boolean beforeActivityJoin ()

Called before an actor joins an activity. Returning false aborts the attempted join.

public boolean beforeOnMessageReceived (MessageHeader h, JSONObject msg)

Returns true if the normal event handling should proceed; Return false to stop cascading.

public boolean beforeSendMessage (JSONObject msg)

Convenience method to which, by default, all message sending methods call through.

public boolean beforeSendMessageToActor (String actorID, JSONObject msg)

public boolean beforeSendMessageToRole (String role, JSONObject msg)

public boolean beforeSendMessageToSession (JSONObject msg)

public final JunctionActor getActor ()

Provides access to the associated JunctionActor.

public Integer getPriority ()

Returns an integer priority for this Extra. Lower priority means closer to switchboard; Higher means closer to actor.

public void setActor (JunctionActor actor)

This method should only be called internally.

public void test ()

public void updateInvitationParameters (Map<String, String> params)

Update the parameters that will be sent in an invitation