/webui/google-api/contrib/apiOrkutService.php
PHP | 2531 lines | 1985 code | 92 blank | 454 comment | 56 complexity | a0699c2959b994d46546200d8b09fb2e MD5 | raw file
Possible License(s): GPL-3.0
Large files files are truncated, but you can click here to view the full file
- <?php
- /*
- * Copyright (c) 2010 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
- require_once 'service/apiModel.php';
- require_once 'service/apiService.php';
- require_once 'service/apiServiceRequest.php';
- /**
- * The "communityMembers" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityMembers = $orkutService->communityMembers;
- * </code>
- */
- class CommunityMembersServiceResource extends apiServiceResource {
- /**
- * Makes the user join a community. (communityMembers.insert)
- *
- * @param int $communityId ID of the community.
- * @param string $userId ID of the user.
- * @return CommunityMembers
- */
- public function insert($communityId, $userId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityMembers($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves the relationship between a user and a community. (communityMembers.get)
- *
- * @param int $communityId ID of the community.
- * @param string $userId ID of the user.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityMembers
- */
- public function get($communityId, $userId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new CommunityMembers($data);
- } else {
- return $data;
- }
- }
- /**
- * Lists members of a community. (communityMembers.list)
- *
- * @param int $communityId The ID of the community whose members will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param bool friendsOnly Whether to list only community members who are friends of the user.
- * @opt_param string maxResults The maximum number of members to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityMembersList
- */
- public function listCommunityMembers($communityId, $optParams = array()) {
- $params = array('communityId' => $communityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityMembersList($data);
- } else {
- return $data;
- }
- }
- /**
- * Makes the user leave a community. (communityMembers.delete)
- *
- * @param int $communityId ID of the community.
- * @param string $userId ID of the user.
- */
- public function delete($communityId, $userId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "activities" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $activities = $orkutService->activities;
- * </code>
- */
- class ActivitiesServiceResource extends apiServiceResource {
- /**
- * Retrieves a list of activities. (activities.list)
- *
- * @param string $userId The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user).
- * @param string $collection The collection of activities to list.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of activities to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return ActivityList
- */
- public function listActivities($userId, $collection, $optParams = array()) {
- $params = array('userId' => $userId, 'collection' => $collection);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new ActivityList($data);
- } else {
- return $data;
- }
- }
- /**
- * Deletes an existing activity, if the access controls allow it. (activities.delete)
- *
- * @param string $activityId ID of the activity to remove.
- */
- public function delete($activityId, $optParams = array()) {
- $params = array('activityId' => $activityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "communityPollComments" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityPollComments = $orkutService->communityPollComments;
- * </code>
- */
- class CommunityPollCommentsServiceResource extends apiServiceResource {
- /**
- * Adds a comment on a community poll. (communityPollComments.insert)
- *
- * @param int $communityId The ID of the community whose poll is being commented.
- * @param string $pollId The ID of the poll being commented.
- * @param CommunityPollComment $postBody
- * @return CommunityPollComment
- */
- public function insert($communityId, $pollId, CommunityPollComment $postBody, $optParams = array()) {
- $params = array('communityId' => $communityId, 'pollId' => $pollId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityPollComment($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves the comments of a community poll. (communityPollComments.list)
- *
- * @param int $communityId The ID of the community whose poll is having its comments listed.
- * @param string $pollId The ID of the community whose polls will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of comments to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityPollCommentList
- */
- public function listCommunityPollComments($communityId, $pollId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'pollId' => $pollId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityPollCommentList($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "communityPolls" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityPolls = $orkutService->communityPolls;
- * </code>
- */
- class CommunityPollsServiceResource extends apiServiceResource {
- /**
- * Retrieves the polls of a community. (communityPolls.list)
- *
- * @param string $communityId The ID of the community which polls will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of polls to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityPollList
- */
- public function listCommunityPolls($communityId, $optParams = array()) {
- $params = array('communityId' => $communityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityPollList($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves one specific poll of a community. (communityPolls.get)
- *
- * @param int $communityId The ID of the community for whose poll will be retrieved.
- * @param string $pollId The ID of the poll to get.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityPoll
- */
- public function get($communityId, $pollId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'pollId' => $pollId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new CommunityPoll($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "communityMessages" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityMessages = $orkutService->communityMessages;
- * </code>
- */
- class CommunityMessagesServiceResource extends apiServiceResource {
- /**
- * Adds a message to a given community topic. (communityMessages.insert)
- *
- * @param int $communityId The ID of the community the message should be added to.
- * @param string $topicId The ID of the topic the message should be added to.
- * @param CommunityMessage $postBody
- * @return CommunityMessage
- */
- public function insert($communityId, $topicId, CommunityMessage $postBody, $optParams = array()) {
- $params = array('communityId' => $communityId, 'topicId' => $topicId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityMessage($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves the messages of a topic of a community. (communityMessages.list)
- *
- * @param int $communityId The ID of the community which messages will be listed.
- * @param string $topicId The ID of the topic which messages will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of messages to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityMessageList
- */
- public function listCommunityMessages($communityId, $topicId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'topicId' => $topicId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityMessageList($data);
- } else {
- return $data;
- }
- }
- /**
- * Moves a message of the community to the trash folder. (communityMessages.delete)
- *
- * @param int $communityId The ID of the community whose message will be moved to the trash folder.
- * @param string $topicId The ID of the topic whose message will be moved to the trash folder.
- * @param string $messageId The ID of the message to be moved to the trash folder.
- */
- public function delete($communityId, $topicId, $messageId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'topicId' => $topicId, 'messageId' => $messageId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "communityTopics" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityTopics = $orkutService->communityTopics;
- * </code>
- */
- class CommunityTopicsServiceResource extends apiServiceResource {
- /**
- * Adds a topic to a given community. (communityTopics.insert)
- *
- * @param int $communityId The ID of the community the topic should be added to.
- * @param CommunityTopic $postBody
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param bool isShout Whether this topic is a shout.
- * @return CommunityTopic
- */
- public function insert($communityId, CommunityTopic $postBody, $optParams = array()) {
- $params = array('communityId' => $communityId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityTopic($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves a topic of a community. (communityTopics.get)
- *
- * @param int $communityId The ID of the community whose topic will be retrieved.
- * @param string $topicId The ID of the topic to get.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityTopic
- */
- public function get($communityId, $topicId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'topicId' => $topicId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new CommunityTopic($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves the topics of a community. (communityTopics.list)
- *
- * @param int $communityId The ID of the community which topics will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of topics to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityTopicList
- */
- public function listCommunityTopics($communityId, $optParams = array()) {
- $params = array('communityId' => $communityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityTopicList($data);
- } else {
- return $data;
- }
- }
- /**
- * Moves a topic of the community to the trash folder. (communityTopics.delete)
- *
- * @param int $communityId The ID of the community whose topic will be moved to the trash folder.
- * @param string $topicId The ID of the topic to be moved to the trash folder.
- */
- public function delete($communityId, $topicId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'topicId' => $topicId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "comments" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $comments = $orkutService->comments;
- * </code>
- */
- class CommentsServiceResource extends apiServiceResource {
- /**
- * Inserts a new comment to an activity. (comments.insert)
- *
- * @param string $activityId The ID of the activity to contain the new comment.
- * @param Comment $postBody
- * @return Comment
- */
- public function insert($activityId, Comment $postBody, $optParams = array()) {
- $params = array('activityId' => $activityId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Comment($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves an existing comment. (comments.get)
- *
- * @param string $commentId ID of the comment to get.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return Comment
- */
- public function get($commentId, $optParams = array()) {
- $params = array('commentId' => $commentId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Comment($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves a list of comments, possibly filtered. (comments.list)
- *
- * @param string $activityId The ID of the activity containing the comments.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string orderBy Sort search results.
- * @opt_param string pageToken A continuation token that allows pagination.
- * @opt_param string maxResults The maximum number of activities to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommentList
- */
- public function listComments($activityId, $optParams = array()) {
- $params = array('activityId' => $activityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommentList($data);
- } else {
- return $data;
- }
- }
- /**
- * Deletes an existing comment. (comments.delete)
- *
- * @param string $commentId ID of the comment to remove.
- */
- public function delete($commentId, $optParams = array()) {
- $params = array('commentId' => $commentId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "acl" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $acl = $orkutService->acl;
- * </code>
- */
- class AclServiceResource extends apiServiceResource {
- /**
- * Excludes an element from the ACL of the activity. (acl.delete)
- *
- * @param string $activityId ID of the activity.
- * @param string $userId ID of the user to be removed from the activity.
- */
- public function delete($activityId, $userId, $optParams = array()) {
- $params = array('activityId' => $activityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "communityRelated" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityRelated = $orkutService->communityRelated;
- * </code>
- */
- class CommunityRelatedServiceResource extends apiServiceResource {
- /**
- * Retrieves the communities related to another one. (communityRelated.list)
- *
- * @param int $communityId The ID of the community whose related communities will be listed.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityList
- */
- public function listCommunityRelated($communityId, $optParams = array()) {
- $params = array('communityId' => $communityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityList($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "scraps" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $scraps = $orkutService->scraps;
- * </code>
- */
- class ScrapsServiceResource extends apiServiceResource {
- /**
- * Creates a new scrap. (scraps.insert)
- *
- * @param Activity $postBody
- * @return Activity
- */
- public function insert(Activity $postBody, $optParams = array()) {
- $params = array('postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Activity($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "communityPollVotes" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityPollVotes = $orkutService->communityPollVotes;
- * </code>
- */
- class CommunityPollVotesServiceResource extends apiServiceResource {
- /**
- * Votes on a community poll. (communityPollVotes.insert)
- *
- * @param int $communityId The ID of the community whose poll is being voted.
- * @param string $pollId The ID of the poll being voted.
- * @param CommunityPollVote $postBody
- * @return CommunityPollVote
- */
- public function insert($communityId, $pollId, CommunityPollVote $postBody, $optParams = array()) {
- $params = array('communityId' => $communityId, 'pollId' => $pollId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityPollVote($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "communities" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communities = $orkutService->communities;
- * </code>
- */
- class CommunitiesServiceResource extends apiServiceResource {
- /**
- * Retrieves the communities an user is member of. (communities.list)
- *
- * @param string $userId The ID of the user whose communities will be listed. Can be me to refer to caller.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string orderBy How to order the communities by.
- * @opt_param string maxResults The maximum number of communities to include in the response.
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return CommunityList
- */
- public function listCommunities($userId, $optParams = array()) {
- $params = array('userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new CommunityList($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves the profile of a community. (communities.get)
- *
- * @param int $communityId The ID of the community to get.
- * @param array $optParams Optional parameters. Valid optional parameters are listed below.
- *
- * @opt_param string hl Specifies the interface language (host language) of your user interface.
- * @return Community
- */
- public function get($communityId, $optParams = array()) {
- $params = array('communityId' => $communityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Community($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "communityFollow" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $communityFollow = $orkutService->communityFollow;
- * </code>
- */
- class CommunityFollowServiceResource extends apiServiceResource {
- /**
- * Adds an user as a follower of a community. (communityFollow.insert)
- *
- * @param int $communityId ID of the community.
- * @param string $userId ID of the user.
- * @return CommunityMembers
- */
- public function insert($communityId, $userId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new CommunityMembers($data);
- } else {
- return $data;
- }
- }
- /**
- * Removes an user from the followers of a community. (communityFollow.delete)
- *
- * @param int $communityId ID of the community.
- * @param string $userId ID of the user.
- */
- public function delete($communityId, $userId, $optParams = array()) {
- $params = array('communityId' => $communityId, 'userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- }
- /**
- * The "activityVisibility" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $activityVisibility = $orkutService->activityVisibility;
- * </code>
- */
- class ActivityVisibilityServiceResource extends apiServiceResource {
- /**
- * Updates the visibility of an existing activity. This method supports patch semantics.
- * (activityVisibility.patch)
- *
- * @param string $activityId ID of the activity.
- * @param Visibility $postBody
- * @return Visibility
- */
- public function patch($activityId, Visibility $postBody, $optParams = array()) {
- $params = array('activityId' => $activityId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('patch', array($params));
- if ($this->useObjects()) {
- return new Visibility($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates the visibility of an existing activity. (activityVisibility.update)
- *
- * @param string $activityId ID of the activity.
- * @param Visibility $postBody
- * @return Visibility
- */
- public function update($activityId, Visibility $postBody, $optParams = array()) {
- $params = array('activityId' => $activityId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Visibility($data);
- } else {
- return $data;
- }
- }
- /**
- * Gets the visibility of an existing activity. (activityVisibility.get)
- *
- * @param string $activityId ID of the activity to get the visibility.
- * @return Visibility
- */
- public function get($activityId, $optParams = array()) {
- $params = array('activityId' => $activityId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Visibility($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "badges" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $badges = $orkutService->badges;
- * </code>
- */
- class BadgesServiceResource extends apiServiceResource {
- /**
- * Retrieves the list of visible badges of a user. (badges.list)
- *
- * @param string $userId The id of the user whose badges will be listed. Can be me to refer to caller.
- * @return BadgeList
- */
- public function listBadges($userId, $optParams = array()) {
- $params = array('userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new BadgeList($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves a badge from a user. (badges.get)
- *
- * @param string $userId The ID of the user whose badges will be listed. Can be me to refer to caller.
- * @param string $badgeId The ID of the badge that will be retrieved.
- * @return Badge
- */
- public function get($userId, $badgeId, $optParams = array()) {
- $params = array('userId' => $userId, 'badgeId' => $badgeId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Badge($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * The "counters" collection of methods.
- * Typical usage is:
- * <code>
- * $orkutService = new apiOrkutService(...);
- * $counters = $orkutService->counters;
- * </code>
- */
- class CountersServiceResource extends apiServiceResource {
- /**
- * Retrieves the counters of an user. (counters.list)
- *
- * @param string $userId The ID of the user whose counters will be listed. Can be me to refer to caller.
- * @return Counters
- */
- public function listCounters($userId, $optParams = array()) {
- $params = array('userId' => $userId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Counters($data);
- } else {
- return $data;
- }
- }
- }
- /**
- * Service definition for Orkut (v2).
- *
- * <p>
- * Lets you manage activities, comments and badges in Orkut. More stuff coming in time.
- * </p>
- *
- * <p>
- * For more information about this service, see the
- * <a href="http://code.google.com/apis/orkut/v2/reference.html" target="_blank">API Documentation</a>
- * </p>
- *
- * @author Google, Inc.
- */
- class apiOrkutService extends apiService {
- public $communityMembers;
- public $activities;
- public $communityPollComments;
- public $communityPolls;
- public $communityMessages;
- public $communityTopics;
- public $comments;
- public $acl;
- public $communityRelated;
- public $scraps;
- public $communityPollVotes;
- public $communities;
- public $communityFollow;
- public $activityVisibility;
- public $badges;
- public $counters;
- /**
- * Constructs the internal representation of the Orkut service.
- *
- * @param apiClient apiClient
- */
- public function __construct(apiClient $apiClient) {
- $this->rpcPath = '/rpc';
- $this->restBasePath = '/orkut/v2/';
- $this->version = 'v2';
- $this->serviceName = 'orkut';
- $apiClient->addService($this->serviceName, $this->version);
- $this->communityMembers = new CommunityMembersServiceResource($this, $this->serviceName, 'communityMembers', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.communityMembers.insert", "httpMethod": "POST", "path": "communities/{communityId}/members/{userId}", "response": {"$ref": "CommunityMembers"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "communities/{communityId}/members/{userId}", "id": "orkut.communityMembers.delete"}, "list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"pageToken": {"type": "string", "location": "query"}, "friendsOnly": {"type": "boolean", "location": "query"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "minimum": "1", "type": "integer", "location": "query"}}, "id": "orkut.communityMembers.list", "httpMethod": "GET", "path": "communities/{communityId}/members", "response": {"$ref": "CommunityMembersList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}}, "id": "orkut.communityMembers.get", "httpMethod": "GET", "path": "communities/{communityId}/members/{userId}", "response": {"$ref": "CommunityMembers"}}}}', true));
- $this->activities = new ActivitiesServiceResource($this, $this->serviceName, 'activities', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"collection": {"required": true, "enum": ["all", "scraps", "stream"], "location": "path", "type": "string"}, "pageToken": {"type": "string", "location": "query"}, "userId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "maximum": "100", "minimum": "1", "location": "query", "type": "integer"}}, "id": "orkut.activities.list", "httpMethod": "GET", "path": "people/{userId}/activities/{collection}", "response": {"$ref": "ActivityList"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "activities/{activityId}", "id": "orkut.activities.delete"}}}', true));
- $this->communityPollComments = new CommunityPollCommentsServiceResource($this, $this->serviceName, 'communityPollComments', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "pollId": {"required": true, "type": "string", "location": "path"}}, "request": {"$ref": "CommunityPollComment"}, "id": "orkut.communityPollComments.insert", "httpMethod": "POST", "path": "communities/{communityId}/polls/{pollId}/comments", "response": {"$ref": "CommunityPollComment"}}, "list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"pageToken": {"type": "string", "location": "query"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "minimum": "1", "type": "integer", "location": "query"}, "pollId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.communityPollComments.list", "httpMethod": "GET", "path": "communities/{communityId}/polls/{pollId}/comments", "response": {"$ref": "CommunityPollCommentList"}}}}', true));
- $this->communityPolls = new CommunityPollsServiceResource($this, $this->serviceName, 'communityPolls', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"pageToken": {"type": "string", "location": "query"}, "communityId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "minimum": "1", "type": "integer", "location": "query"}}, "id": "orkut.communityPolls.list", "httpMethod": "GET", "path": "communities/{communityId}/polls", "response": {"$ref": "CommunityPollList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}, "pollId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.communityPolls.get", "httpMethod": "GET", "path": "communities/{communityId}/polls/{pollId}", "response": {"$ref": "CommunityPoll"}}}}', true));
- $this->communityMessages = new CommunityMessagesServiceResource($this, $this->serviceName, 'communityMessages', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"topicId": {"format": "uint64", "required": true, "type": "string", "location": "path"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}}, "request": {"$ref": "CommunityMessage"}, "id": "orkut.communityMessages.insert", "httpMethod": "POST", "path": "communities/{communityId}/topics/{topicId}/messages", "response": {"$ref": "CommunityMessage"}}, "list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"pageToken": {"type": "string", "location": "query"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "maximum": "100", "minimum": "1", "location": "query", "type": "integer"}, "topicId": {"format": "uint64", "required": true, "type": "string", "location": "path"}}, "id": "orkut.communityMessages.list", "httpMethod": "GET", "path": "communities/{communityId}/topics/{topicId}/messages", "response": {"$ref": "CommunityMessageList"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"topicId": {"format": "uint64", "required": true, "type": "string", "location": "path"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "messageId": {"format": "uint64", "required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "communities/{communityId}/topics/{topicId}/messages/{messageId}", "id": "orkut.communityMessages.delete"}}}', true));
- $this->communityTopics = new CommunityTopicsServiceResource($this, $this->serviceName, 'communityTopics', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"isShout": {"type": "boolean", "location": "query"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}}, "request": {"$ref": "CommunityTopic"}, "id": "orkut.communityTopics.insert", "httpMethod": "POST", "path": "communities/{communityId}/topics", "response": {"$ref": "CommunityTopic"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"topicId": {"format": "uint64", "required": true, "type": "string", "location": "path"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}}, "httpMethod": "DELETE", "path": "communities/{communityId}/topics/{topicId}", "id": "orkut.communityTopics.delete"}, "list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"pageToken": {"type": "string", "location": "query"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "maximum": "100", "minimum": "1", "location": "query", "type": "integer"}}, "id": "orkut.communityTopics.list", "httpMethod": "GET", "path": "communities/{communityId}/topics", "response": {"$ref": "CommunityTopicList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"topicId": {"format": "uint64", "required": true, "type": "string", "location": "path"}, "communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}}, "id": "orkut.communityTopics.get", "httpMethod": "GET", "path": "communities/{communityId}/topics/{topicId}", "response": {"$ref": "CommunityTopic"}}}}', true));
- $this->comments = new CommentsServiceResource($this, $this->serviceName, 'comments', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}}, "request": {"$ref": "Comment"}, "id": "orkut.comments.insert", "httpMethod": "POST", "path": "activities/{activityId}/comments", "response": {"$ref": "Comment"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"commentId": {"required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "comments/{commentId}", "id": "orkut.comments.delete"}, "list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"orderBy": {"default": "DESCENDING_SORT", "enum": ["ascending", "descending"], "location": "query", "type": "string"}, "pageToken": {"type": "string", "location": "query"}, "activityId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "minimum": "1", "type": "integer", "location": "query"}}, "id": "orkut.comments.list", "httpMethod": "GET", "path": "activities/{activityId}/comments", "response": {"$ref": "CommentList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"commentId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}}, "id": "orkut.comments.get", "httpMethod": "GET", "path": "comments/{commentId}", "response": {"$ref": "Comment"}}}}', true));
- $this->acl = new AclServiceResource($this, $this->serviceName, 'acl', json_decode('{"methods": {"delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "activities/{activityId}/acl/{userId}", "id": "orkut.acl.delete"}}}', true));
- $this->communityRelated = new CommunityRelatedServiceResource($this, $this->serviceName, 'communityRelated', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}}, "id": "orkut.communityRelated.list", "httpMethod": "GET", "path": "communities/{communityId}/related", "response": {"$ref": "CommunityList"}}}}', true));
- $this->scraps = new ScrapsServiceResource($this, $this->serviceName, 'scraps', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "request": {"$ref": "Activity"}, "response": {"$ref": "Activity"}, "httpMethod": "POST", "path": "activities/scraps", "id": "orkut.scraps.insert"}}}', true));
- $this->communityPollVotes = new CommunityPollVotesServiceResource($this, $this->serviceName, 'communityPollVotes', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "pollId": {"required": true, "type": "string", "location": "path"}}, "request": {"$ref": "CommunityPollVote"}, "id": "orkut.communityPollVotes.insert", "httpMethod": "POST", "path": "communities/{communityId}/polls/{pollId}/votes", "response": {"$ref": "CommunityPollVote"}}}}', true));
- $this->communities = new CommunitiesServiceResource($this, $this->serviceName, 'communities', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"orderBy": {"enum": ["id", "ranked"], "type": "string", "location": "query"}, "userId": {"required": true, "type": "string", "location": "path"}, "hl": {"type": "string", "location": "query"}, "maxResults": {"format": "uint32", "minimum": "1", "type": "integer", "location": "query"}}, "id": "orkut.communities.list", "httpMethod": "GET", "path": "people/{userId}/communities", "response": {"$ref": "CommunityList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "hl": {"type": "string", "location": "query"}}, "id": "orkut.communities.get", "httpMethod": "GET", "path": "communities/{communityId}", "response": {"$ref": "Community"}}}}', true));
- $this->communityFollow = new CommunityFollowServiceResource($this, $this->serviceName, 'communityFollow', json_decode('{"methods": {"insert": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.communityFollow.insert", "httpMethod": "POST", "path": "communities/{communityId}/followers/{userId}", "response": {"$ref": "CommunityMembers"}}, "delete": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"communityId": {"format": "int32", "required": true, "type": "integer", "location": "path"}, "userId": {"required": true, "type": "string", "location": "path"}}, "httpMethod": "DELETE", "path": "communities/{communityId}/followers/{userId}", "id": "orkut.communityFollow.delete"}}}', true));
- $this->activityVisibility = new ActivityVisibilityServiceResource($this, $this->serviceName, 'activityVisibility', json_decode('{"methods": {"get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.activityVisibility.get", "httpMethod": "GET", "path": "activities/{activityId}/visibility", "response": {"$ref": "Visibility"}}, "update": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}}, "request": {"$ref": "Visibility"}, "id": "orkut.activityVisibility.update", "httpMethod": "PUT", "path": "activities/{activityId}/visibility", "response": {"$ref": "Visibility"}}, "patch": {"scopes": ["https://www.googleapis.com/auth/orkut"], "parameters": {"activityId": {"required": true, "type": "string", "location": "path"}}, "request": {"$ref": "Visibility"}, "id": "orkut.activityVisibility.patch", "httpMethod": "PATCH", "path": "activities/{activityId}/visibility", "response": {"$ref": "Visibility"}}}}', true));
- $this->badges = new BadgesServiceResource($this, $this->serviceName, 'badges', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"userId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.badges.list", "httpMethod": "GET", "path": "people/{userId}/badges", "response": {"$ref": "BadgeList"}}, "get": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"userId": {"required": true, "type": "string", "location": "path"}, "badgeId": {"format": "int64", "required": true, "type": "string", "location": "path"}}, "id": "orkut.badges.get", "httpMethod": "GET", "path": "people/{userId}/badges/{badgeId}", "response": {"$ref": "Badge"}}}}', true));
- $this->counters = new CountersServiceResource($this, $this->serviceName, 'counters', json_decode('{"methods": {"list": {"scopes": ["https://www.googleapis.com/auth/orkut", "https://www.googleapis.com/auth/orkut.readonly"], "parameters": {"userId": {"required": true, "type": "string", "location": "path"}}, "id": "orkut.counters.list", "httpMethod": "GET", "path": "people/{userId}/counters", "response": {"$ref": "Counters"}}}}', true));
- }
- }
- class Acl extends apiModel {
- protected $__itemsType = 'AclItems';
- protected $__itemsDataType = 'array';
- public $items;
- public $kind;
- public $description;
- public $totalParticipants;
- public function setItems(/* array(AclItems) */ $items) {
- $this->assertIsArray($items, 'AclItems', __METHOD__);
- $this->items = $items;
- }
- public function getItems() {
- return $this->items;
- }
- public function setKind($kind) {
- $this->kind = $kind;
- }
- public function getKind() {
- return $this->kind;
- }
- public function setDescription($description) {
- $this->description = $description;
- }
- public function getDescription() {
- return $this->description;
- }
- public function setTotalParticipants($totalParticipants) {
- $this->totalParticipants = $totalParticipants;
- }
- public function getTotalParticipants() {
- …
Large files files are truncated, but you can click here to view the full file