Google_Service_Games_Rooms_Resource

The "rooms" collection of methods.

Defined (2)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Games.php  
  1. class Google_Service_Games_Rooms_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Create a room. For internal use by the Games SDK only. Calling this method 
  5. * directly is unsupported. (rooms.create) 
  6. * @param Google_RoomCreateRequest $postBody 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string language The preferred language to use for strings returned 
  9. * by this method. 
  10. * @return Google_Service_Games_Room 
  11. */ 
  12. public function create(Google_Service_Games_RoomCreateRequest $postBody, $optParams = array()) 
  13. $params = array('postBody' => $postBody); 
  14. $params = array_merge($params, $optParams); 
  15. return $this->call('create', array($params), "Google_Service_Games_Room"); 
  16.  
  17. /** 
  18. * Decline an invitation to join a room. For internal use by the Games SDK only. 
  19. * Calling this method directly is unsupported. (rooms.decline) 
  20. * @param string $roomId The ID of the room. 
  21. * @param array $optParams Optional parameters. 
  22. * @opt_param string language The preferred language to use for strings returned 
  23. * by this method. 
  24. * @return Google_Service_Games_Room 
  25. */ 
  26. public function decline($roomId, $optParams = array()) 
  27. $params = array('roomId' => $roomId); 
  28. $params = array_merge($params, $optParams); 
  29. return $this->call('decline', array($params), "Google_Service_Games_Room"); 
  30.  
  31. /** 
  32. * Dismiss an invitation to join a room. For internal use by the Games SDK only. 
  33. * Calling this method directly is unsupported. (rooms.dismiss) 
  34. * @param string $roomId The ID of the room. 
  35. * @param array $optParams Optional parameters. 
  36. */ 
  37. public function dismiss($roomId, $optParams = array()) 
  38. $params = array('roomId' => $roomId); 
  39. $params = array_merge($params, $optParams); 
  40. return $this->call('dismiss', array($params)); 
  41.  
  42. /** 
  43. * Get the data for a room. (rooms.get) 
  44. * @param string $roomId The ID of the room. 
  45. * @param array $optParams Optional parameters. 
  46. * @opt_param string language The preferred language to use for strings returned 
  47. * by this method. 
  48. * @return Google_Service_Games_Room 
  49. */ 
  50. public function get($roomId, $optParams = array()) 
  51. $params = array('roomId' => $roomId); 
  52. $params = array_merge($params, $optParams); 
  53. return $this->call('get', array($params), "Google_Service_Games_Room"); 
  54.  
  55. /** 
  56. * Join a room. For internal use by the Games SDK only. Calling this method 
  57. * directly is unsupported. (rooms.join) 
  58. * @param string $roomId The ID of the room. 
  59. * @param Google_RoomJoinRequest $postBody 
  60. * @param array $optParams Optional parameters. 
  61. * @opt_param string language The preferred language to use for strings returned 
  62. * by this method. 
  63. * @return Google_Service_Games_Room 
  64. */ 
  65. public function join($roomId, Google_Service_Games_RoomJoinRequest $postBody, $optParams = array()) 
  66. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  67. $params = array_merge($params, $optParams); 
  68. return $this->call('join', array($params), "Google_Service_Games_Room"); 
  69.  
  70. /** 
  71. * Leave a room. For internal use by the Games SDK only. Calling this method 
  72. * directly is unsupported. (rooms.leave) 
  73. * @param string $roomId The ID of the room. 
  74. * @param Google_RoomLeaveRequest $postBody 
  75. * @param array $optParams Optional parameters. 
  76. * @opt_param string language The preferred language to use for strings returned 
  77. * by this method. 
  78. * @return Google_Service_Games_Room 
  79. */ 
  80. public function leave($roomId, Google_Service_Games_RoomLeaveRequest $postBody, $optParams = array()) 
  81. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  82. $params = array_merge($params, $optParams); 
  83. return $this->call('leave', array($params), "Google_Service_Games_Room"); 
  84.  
  85. /** 
  86. * Returns invitations to join rooms. (rooms.listRooms) 
  87. * @param array $optParams Optional parameters. 
  88. * @opt_param string pageToken The token returned by the previous request. 
  89. * @opt_param int maxResults The maximum number of rooms to return in the 
  90. * response, used for paging. For any response, the actual number of rooms to 
  91. * return may be less than the specified maxResults. 
  92. * @opt_param string language The preferred language to use for strings returned 
  93. * by this method. 
  94. * @return Google_Service_Games_RoomList 
  95. */ 
  96. public function listRooms($optParams = array()) 
  97. $params = array(); 
  98. $params = array_merge($params, $optParams); 
  99. return $this->call('list', array($params), "Google_Service_Games_RoomList"); 
  100.  
  101. /** 
  102. * Updates sent by a client reporting the status of peers in a room. For 
  103. * internal use by the Games SDK only. Calling this method directly is 
  104. * unsupported. (rooms.reportStatus) 
  105. * @param string $roomId The ID of the room. 
  106. * @param Google_RoomP2PStatuses $postBody 
  107. * @param array $optParams Optional parameters. 
  108. * @opt_param string language The preferred language to use for strings returned 
  109. * by this method. 
  110. * @return Google_Service_Games_RoomStatus 
  111. */ 
  112. public function reportStatus($roomId, Google_Service_Games_RoomP2PStatuses $postBody, $optParams = array()) 
  113. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  114. $params = array_merge($params, $optParams); 
  115. return $this->call('reportStatus', array($params), "Google_Service_Games_RoomStatus"); 
  1. class Google_Service_Games_Rooms_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Create a room. For internal use by the Games SDK only. Calling this method 
  5. * directly is unsupported. (rooms.create) 
  6. * @param Google_RoomCreateRequest $postBody 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string language The preferred language to use for strings returned 
  9. * by this method. 
  10. * @return Google_Service_Games_Room 
  11. */ 
  12. public function create(Google_Service_Games_RoomCreateRequest $postBody, $optParams = array()) 
  13. $params = array('postBody' => $postBody); 
  14. $params = array_merge($params, $optParams); 
  15. return $this->call('create', array($params), "Google_Service_Games_Room"); 
  16.  
  17. /** 
  18. * Decline an invitation to join a room. For internal use by the Games SDK only. 
  19. * Calling this method directly is unsupported. (rooms.decline) 
  20. * @param string $roomId The ID of the room. 
  21. * @param array $optParams Optional parameters. 
  22. * @opt_param string language The preferred language to use for strings returned 
  23. * by this method. 
  24. * @return Google_Service_Games_Room 
  25. */ 
  26. public function decline($roomId, $optParams = array()) 
  27. $params = array('roomId' => $roomId); 
  28. $params = array_merge($params, $optParams); 
  29. return $this->call('decline', array($params), "Google_Service_Games_Room"); 
  30.  
  31. /** 
  32. * Dismiss an invitation to join a room. For internal use by the Games SDK only. 
  33. * Calling this method directly is unsupported. (rooms.dismiss) 
  34. * @param string $roomId The ID of the room. 
  35. * @param array $optParams Optional parameters. 
  36. */ 
  37. public function dismiss($roomId, $optParams = array()) 
  38. $params = array('roomId' => $roomId); 
  39. $params = array_merge($params, $optParams); 
  40. return $this->call('dismiss', array($params)); 
  41.  
  42. /** 
  43. * Get the data for a room. (rooms.get) 
  44. * @param string $roomId The ID of the room. 
  45. * @param array $optParams Optional parameters. 
  46. * @opt_param string language The preferred language to use for strings returned 
  47. * by this method. 
  48. * @return Google_Service_Games_Room 
  49. */ 
  50. public function get($roomId, $optParams = array()) 
  51. $params = array('roomId' => $roomId); 
  52. $params = array_merge($params, $optParams); 
  53. return $this->call('get', array($params), "Google_Service_Games_Room"); 
  54.  
  55. /** 
  56. * Join a room. For internal use by the Games SDK only. Calling this method 
  57. * directly is unsupported. (rooms.join) 
  58. * @param string $roomId The ID of the room. 
  59. * @param Google_RoomJoinRequest $postBody 
  60. * @param array $optParams Optional parameters. 
  61. * @opt_param string language The preferred language to use for strings returned 
  62. * by this method. 
  63. * @return Google_Service_Games_Room 
  64. */ 
  65. public function join($roomId, Google_Service_Games_RoomJoinRequest $postBody, $optParams = array()) 
  66. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  67. $params = array_merge($params, $optParams); 
  68. return $this->call('join', array($params), "Google_Service_Games_Room"); 
  69.  
  70. /** 
  71. * Leave a room. For internal use by the Games SDK only. Calling this method 
  72. * directly is unsupported. (rooms.leave) 
  73. * @param string $roomId The ID of the room. 
  74. * @param Google_RoomLeaveRequest $postBody 
  75. * @param array $optParams Optional parameters. 
  76. * @opt_param string language The preferred language to use for strings returned 
  77. * by this method. 
  78. * @return Google_Service_Games_Room 
  79. */ 
  80. public function leave($roomId, Google_Service_Games_RoomLeaveRequest $postBody, $optParams = array()) 
  81. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  82. $params = array_merge($params, $optParams); 
  83. return $this->call('leave', array($params), "Google_Service_Games_Room"); 
  84.  
  85. /** 
  86. * Returns invitations to join rooms. (rooms.listRooms) 
  87. * @param array $optParams Optional parameters. 
  88. * @opt_param string pageToken The token returned by the previous request. 
  89. * @opt_param int maxResults The maximum number of rooms to return in the 
  90. * response, used for paging. For any response, the actual number of rooms to 
  91. * return may be less than the specified maxResults. 
  92. * @opt_param string language The preferred language to use for strings returned 
  93. * by this method. 
  94. * @return Google_Service_Games_RoomList 
  95. */ 
  96. public function listRooms($optParams = array()) 
  97. $params = array(); 
  98. $params = array_merge($params, $optParams); 
  99. return $this->call('list', array($params), "Google_Service_Games_RoomList"); 
  100.  
  101. /** 
  102. * Updates sent by a client reporting the status of peers in a room. For 
  103. * internal use by the Games SDK only. Calling this method directly is 
  104. * unsupported. (rooms.reportStatus) 
  105. * @param string $roomId The ID of the room. 
  106. * @param Google_RoomP2PStatuses $postBody 
  107. * @param array $optParams Optional parameters. 
  108. * @opt_param string language The preferred language to use for strings returned 
  109. * by this method. 
  110. * @return Google_Service_Games_RoomStatus 
  111. */ 
  112. public function reportStatus($roomId, Google_Service_Games_RoomP2PStatuses $postBody, $optParams = array()) 
  113. $params = array('roomId' => $roomId, 'postBody' => $postBody); 
  114. $params = array_merge($params, $optParams); 
  115. return $this->call('reportStatus', array($params), "Google_Service_Games_RoomStatus");