xyz.nickr.jitter.api

Interface User

All Known Subinterfaces:

RoomUser

All Known Implementing Classes:

RoomUserImpl, UserImpl

public interface User

Represents a Gitter User.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
String	getDisplayName() Gets this User's display name.
String	getID() Gets this User's ID.
Jitter	getJitter() Gets the providing Jitter object.
String	getMediumAvatarURL() Gets this User's medium-size avatar URL.
String	getSmallAvatarURL() Gets this User's small-size avatar URL.
String	getURL() Gets this User's URL.
String	getUsername() Gets this User's username.
Message	sendMessage(String message) Send this User a message.

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.

getID

String getID()

Gets this User's ID.

Returns:

The ID.

getUsername

String getUsername()

Gets this User's username.

Returns:

The username.

getDisplayName

String getDisplayName()

Gets this User's display name.

Returns:

The display name.

getURL

String getURL()

Gets this User's URL.

Returns:

The URL.

getSmallAvatarURL

String getSmallAvatarURL()

Gets this User's small-size avatar URL.

Returns:

The avatar URL.

getMediumAvatarURL

String getMediumAvatarURL()

Gets this User's medium-size avatar URL.

Returns:

The avatar URL.

sendMessage

Message sendMessage(String message)

Send this User a message.

Parameters:

message - The message.

Returns:

The message.