com.Upwork.api.Routers

Class Messages

java.lang.Object

com.Upwork.api.Routers.Messages

@ClassPreamble(author="Maksym Novozhylov <mnovozhilov@upwork.com>",
               date="6/6/2014",
               currentRevision=1,
               lastModified="6/6/2014",
               lastModifiedBy="Maksym Novozhylov",
               reviewers="Yiota Tsakiri")
public final class Messages
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Messages(OAuthClient client)

Method Summary

Modifier and Type	Method and Description
JSONObject	createRoom(java.lang.String company, java.util.HashMap<java.lang.String,java.lang.String> params) Create a new room
JSONObject	getRoomByApplication(java.lang.String company, java.lang.String applicationId, java.util.HashMap<java.lang.String,java.lang.String> params) Get a specific room by application ID
JSONObject	getRoomByContract(java.lang.String company, java.lang.String contractId, java.util.HashMap<java.lang.String,java.lang.String> params) Get a specific room by contract ID
JSONObject	getRoomByOffer(java.lang.String company, java.lang.String offerId, java.util.HashMap<java.lang.String,java.lang.String> params) Get a specific room by offer ID
JSONObject	getRoomDetails(java.lang.String company, java.lang.String roomId, java.util.HashMap<java.lang.String,java.lang.String> params) Get a specific room information
JSONObject	getRooms(java.lang.String company) Retrieve rooms information
JSONObject	getRooms(java.lang.String company, java.util.HashMap<java.lang.String,java.lang.String> params) Retrieve rooms information with params
JSONObject	sendMessageToRoom(java.lang.String company, java.lang.String roomId, java.util.HashMap<java.lang.String,java.lang.String> params) Send a message to a room
JSONObject	updateRoomMetadata(java.lang.String company, java.lang.String roomId, java.util.HashMap<java.lang.String,java.lang.String> params) Update the metadata of a room
JSONObject	updateRoomSettings(java.lang.String company, java.lang.String roomId, java.lang.String username, java.util.HashMap<java.lang.String,java.lang.String> params) Update a room settings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Messages

public Messages(OAuthClient client)

Method Detail

getRooms

public JSONObject getRooms(java.lang.String company)
                    throws JSONException

Retrieve rooms information

Parameters:

company - Company ID

Returns:

JSONObject

Throws:

JSONException - If error occurred

getRooms

public JSONObject getRooms(java.lang.String company,
                           java.util.HashMap<java.lang.String,java.lang.String> params)
                    throws JSONException

Retrieve rooms information with params

Parameters:

company - Company ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

getRoomDetails

public JSONObject getRoomDetails(java.lang.String company,
                                 java.lang.String roomId,
                                 java.util.HashMap<java.lang.String,java.lang.String> params)
                          throws JSONException

Get a specific room information

Parameters:

company - Company ID

roomId - Room ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

getRoomByOffer

public JSONObject getRoomByOffer(java.lang.String company,
                                 java.lang.String offerId,
                                 java.util.HashMap<java.lang.String,java.lang.String> params)
                          throws JSONException

Get a specific room by offer ID

Parameters:

company - Company ID

offerId - Offer ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

getRoomByApplication

public JSONObject getRoomByApplication(java.lang.String company,
                                       java.lang.String applicationId,
                                       java.util.HashMap<java.lang.String,java.lang.String> params)
                                throws JSONException

Get a specific room by application ID

Parameters:

company - Company ID

applicationId - Application ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

getRoomByContract

public JSONObject getRoomByContract(java.lang.String company,
                                    java.lang.String contractId,
                                    java.util.HashMap<java.lang.String,java.lang.String> params)
                             throws JSONException

Get a specific room by contract ID

Parameters:

company - Company ID

contractId - Contract ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

createRoom

public JSONObject createRoom(java.lang.String company,
                             java.util.HashMap<java.lang.String,java.lang.String> params)
                      throws JSONException

Create a new room

Parameters:

company - Company ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

sendMessageToRoom

public JSONObject sendMessageToRoom(java.lang.String company,
                                    java.lang.String roomId,
                                    java.util.HashMap<java.lang.String,java.lang.String> params)
                             throws JSONException

Send a message to a room

Parameters:

company - Company ID

roomId - Room ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

updateRoomSettings

public JSONObject updateRoomSettings(java.lang.String company,
                                     java.lang.String roomId,
                                     java.lang.String username,
                                     java.util.HashMap<java.lang.String,java.lang.String> params)
                              throws JSONException

Update a room settings

Parameters:

company - Company ID

roomId - Room ID

username - User ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred

updateRoomMetadata

public JSONObject updateRoomMetadata(java.lang.String company,
                                     java.lang.String roomId,
                                     java.util.HashMap<java.lang.String,java.lang.String> params)
                              throws JSONException

Update the metadata of a room

Parameters:

company - Company ID

roomId - Room ID

params - Parameters

Returns:

JSONObject

Throws:

JSONException - If error occurred