xyz.nickr.jitter.api.event

Interface UserPresenceEvent

All Superinterfaces:

JitterEvent

All Known Implementing Classes:

UserPresenceEventImpl

public interface UserPresenceEvent
extends JitterEvent

Represents an event of when a user starts or stops watching a room.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
Room	getRoom() Gets the room that the user started/stopped watching.
String	getUserID() Gets the user ID of who is watching.
boolean	isIncoming() Gets whether or not the user has just started watching.

Methods inherited from interface xyz.nickr.jitter.api.event.JitterEvent

getJitter

Method Detail

asJSON

org.json.JSONObject asJSON()

Gets the underlying JSON object.

Returns:

The JSON.

getRoom

Room getRoom()

Gets the room that the user started/stopped watching.

Returns:

The room.

getUserID

String getUserID()

Gets the user ID of who is watching.

Returns:

The user ID.

isIncoming

boolean isIncoming()

Gets whether or not the user has just started watching.

Returns:

True if they have just started; false otherwise.