xyz.nickr.jitter.api

Interface MentionedUser

All Known Implementing Classes:

MentionedUserImpl

public interface MentionedUser

Represents a user mentioned using @user in a message.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
String	getDisplayName() Gets the mentioned user's display name.
String	getID() Gets the mentioned user's ID.
Jitter	getJitter() Gets the providing Jitter object.
Message	getMessage() Gets the Message in which this mention took place.

Method Detail

getJitter

Jitter getJitter()

Gets the providing Jitter object.

Returns:

The provider.

asJSON

org.json.JSONObject asJSON()

Gets the underlying JSON object.

Returns:

The JSON.

getMessage

Message getMessage()

Gets the Message in which this mention took place.

Returns:

The message.

getID

String getID()

Gets the mentioned user's ID.

Returns:

The ID.

getDisplayName

String getDisplayName()

Gets the mentioned user's display name.

Returns:

The display name.