public abstract class

JunctionActor

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

Class Overview

The JunctionActor is the primary class used to communicate within a Junction activity.

Primarily, you will need to override the onMessageReceived method to handle inbound messages, and use the sendMessageTo* methods to transmit them.

Summary

Fields
protected Junction mJunction
Public Constructors
JunctionActor()
JunctionActor(String role)
JunctionActor(String[] roles)
Public Methods
String getActorID()
List<JunctionExtra> getInitialExtras()
Returns a list of JunctionExtras that should be loaded when the actor joins an activity
Junction getJunction()
String[] getRoles()
final void leave()
void onActivityCreate()
void onActivityJoin()
void onActivityStart()
abstract void onMessageReceived(MessageHeader header, JSONObject message)
Asynchronously handle an inbound message.
void registerExtra(JunctionExtra extra)
void sendMessageToActor(String actorID, JSONObject message)
Send a message to an individual actor, identified by actorID
void sendMessageToRole(String role, JSONObject message)
Send a message to an actor claiming a certain role.
void sendMessageToSession(JSONObject message)
Send a message for anyone in the Junction session.
void setJunction(Junction j)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected Junction mJunction

Public Constructors

public JunctionActor ()

public JunctionActor (String role)

public JunctionActor (String[] roles)

Public Methods

public String getActorID ()

public List<JunctionExtra> getInitialExtras ()

Returns a list of JunctionExtras that should be loaded when the actor joins an activity

public Junction getJunction ()

public String[] getRoles ()

public final void leave ()

public void onActivityCreate ()

public void onActivityJoin ()

public void onActivityStart ()

public abstract void onMessageReceived (MessageHeader header, JSONObject message)

Asynchronously handle an inbound message.

public void registerExtra (JunctionExtra extra)

public void sendMessageToActor (String actorID, JSONObject message)

Send a message to an individual actor, identified by actorID

public void sendMessageToRole (String role, JSONObject message)

Send a message to an actor claiming a certain role.

public void sendMessageToSession (JSONObject message)

Send a message for anyone in the Junction session.

public void setJunction (Junction j)