com.google.api.services.games

Class Games.Rooms

java.lang.Object

com.google.api.services.games.Games.Rooms

Enclosing class:

Games

public class Games.Rooms
extends java.lang.Object

The "rooms" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Games.Rooms.Create
class	Games.Rooms.Decline
class	Games.Rooms.Dismiss
class	Games.Rooms.Get
class	Games.Rooms.Join
class	Games.Rooms.Leave
class	Games.Rooms.List
class	Games.Rooms.ReportStatus

Constructor Summary

Constructors

Constructor and Description
Games.Rooms()

Method Summary

Methods

Modifier and Type	Method and Description
Games.Rooms.Create	create(RoomCreateRequest content) Create a room.
Games.Rooms.Decline	decline(java.lang.String roomId) Decline an invitation to join a room.
Games.Rooms.Dismiss	dismiss(java.lang.String roomId) Dismiss an invitation to join a room.
Games.Rooms.Get	get(java.lang.String roomId) Get the data for a room.
Games.Rooms.Join	join(java.lang.String roomId, RoomJoinRequest content) Join a room.
Games.Rooms.Leave	leave(java.lang.String roomId, RoomLeaveRequest content) Leave a room.
Games.Rooms.List	list() Returns invitations to join rooms.
Games.Rooms.ReportStatus	reportStatus(java.lang.String roomId, RoomP2PStatuses content) Updates sent by a client reporting the status of peers in a room.

Methods inherited from class java.lang.Object

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

Constructor Detail

Games.Rooms

public Games.Rooms()

Method Detail

create

public Games.Rooms.Create create(RoomCreateRequest content)
                          throws java.io.IOException

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.create". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the RoomCreateRequest

Returns:

the request

Throws:

java.io.IOException

decline

public Games.Rooms.Decline decline(java.lang.String roomId)
                            throws java.io.IOException

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.decline". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

Returns:

the request

Throws:

java.io.IOException

dismiss

public Games.Rooms.Dismiss dismiss(java.lang.String roomId)
                            throws java.io.IOException

Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.dismiss". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

Returns:

the request

Throws:

java.io.IOException

get

public Games.Rooms.Get get(java.lang.String roomId)
                    throws java.io.IOException

Get the data for a room. Create a request for the method "rooms.get". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

Returns:

the request

Throws:

java.io.IOException

join

public Games.Rooms.Join join(java.lang.String roomId,
                    RoomJoinRequest content)
                      throws java.io.IOException

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.join". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

content - the RoomJoinRequest

Returns:

the request

Throws:

java.io.IOException

leave

public Games.Rooms.Leave leave(java.lang.String roomId,
                      RoomLeaveRequest content)
                        throws java.io.IOException

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.leave". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

content - the RoomLeaveRequest

Returns:

the request

Throws:

java.io.IOException

list

public Games.Rooms.List list()
                      throws java.io.IOException

Returns invitations to join rooms. Create a request for the method "rooms.list". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

java.io.IOException

reportStatus

public Games.Rooms.ReportStatus reportStatus(java.lang.String roomId,
                                    RoomP2PStatuses content)
                                      throws java.io.IOException

Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.reportStatus". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

roomId - The ID of the room.

content - the RoomP2PStatuses

Returns:

the request

Throws:

java.io.IOException