Google_Service_Blogger_Comments_Resource

The "comments" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Blogger.php  
  1. class Google_Service_Blogger_Comments_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Marks a comment as not spam. (comments.approve) 
  5. * @param string $blogId The ID of the Blog. 
  6. * @param string $postId The ID of the Post. 
  7. * @param string $commentId The ID of the comment to mark as not spam. 
  8. * @param array $optParams Optional parameters. 
  9. * @return Google_Service_Blogger_Comment 
  10. */ 
  11. public function approve($blogId, $postId, $commentId, $optParams = array()) 
  12. $params = array('blogId' => $blogId, 'postId' => $postId, 'commentId' => $commentId); 
  13. $params = array_merge($params, $optParams); 
  14. return $this->call('approve', array($params), "Google_Service_Blogger_Comment"); 
  15.  
  16. /** 
  17. * Delete a comment by ID. (comments.delete) 
  18. * @param string $blogId The ID of the Blog. 
  19. * @param string $postId The ID of the Post. 
  20. * @param string $commentId The ID of the comment to delete. 
  21. * @param array $optParams Optional parameters. 
  22. */ 
  23. public function delete($blogId, $postId, $commentId, $optParams = array()) 
  24. $params = array('blogId' => $blogId, 'postId' => $postId, 'commentId' => $commentId); 
  25. $params = array_merge($params, $optParams); 
  26. return $this->call('delete', array($params)); 
  27.  
  28. /** 
  29. * Gets one comment by ID. (comments.get) 
  30. * @param string $blogId ID of the blog to containing the comment. 
  31. * @param string $postId ID of the post to fetch posts from. 
  32. * @param string $commentId The ID of the comment to get. 
  33. * @param array $optParams Optional parameters. 
  34. * @opt_param string view Access level for the requested comment (default: 
  35. * READER). Note that some comments will require elevated permissions, for 
  36. * example comments where the parent posts which is in a draft state, or 
  37. * comments that are pending moderation. 
  38. * @return Google_Service_Blogger_Comment 
  39. */ 
  40. public function get($blogId, $postId, $commentId, $optParams = array()) 
  41. $params = array('blogId' => $blogId, 'postId' => $postId, 'commentId' => $commentId); 
  42. $params = array_merge($params, $optParams); 
  43. return $this->call('get', array($params), "Google_Service_Blogger_Comment"); 
  44.  
  45. /** 
  46. * Retrieves the comments for a post, possibly filtered. (comments.listComments) 
  47. * @param string $blogId ID of the blog to fetch comments from. 
  48. * @param string $postId ID of the post to fetch posts from. 
  49. * @param array $optParams Optional parameters. 
  50. * @opt_param string status 
  51. * @opt_param string startDate Earliest date of comment to fetch, a date-time 
  52. * with RFC 3339 formatting. 
  53. * @opt_param string endDate Latest date of comment to fetch, a date-time with 
  54. * RFC 3339 formatting. 
  55. * @opt_param string maxResults Maximum number of comments to include in the 
  56. * result. 
  57. * @opt_param string pageToken Continuation token if request is paged. 
  58. * @opt_param bool fetchBodies Whether the body content of the comments is 
  59. * included. 
  60. * @opt_param string view Access level with which to view the returned result. 
  61. * Note that some fields require elevated access. 
  62. * @return Google_Service_Blogger_CommentList 
  63. */ 
  64. public function listComments($blogId, $postId, $optParams = array()) 
  65. $params = array('blogId' => $blogId, 'postId' => $postId); 
  66. $params = array_merge($params, $optParams); 
  67. return $this->call('list', array($params), "Google_Service_Blogger_CommentList"); 
  68.  
  69. /** 
  70. * Retrieves the comments for a blog, across all posts, possibly filtered. 
  71. * (comments.listByBlog) 
  72. * @param string $blogId ID of the blog to fetch comments from. 
  73. * @param array $optParams Optional parameters. 
  74. * @opt_param string status 
  75. * @opt_param string startDate Earliest date of comment to fetch, a date-time 
  76. * with RFC 3339 formatting. 
  77. * @opt_param string endDate Latest date of comment to fetch, a date-time with 
  78. * RFC 3339 formatting. 
  79. * @opt_param string maxResults Maximum number of comments to include in the 
  80. * result. 
  81. * @opt_param string pageToken Continuation token if request is paged. 
  82. * @opt_param bool fetchBodies Whether the body content of the comments is 
  83. * included. 
  84. * @return Google_Service_Blogger_CommentList 
  85. */ 
  86. public function listByBlog($blogId, $optParams = array()) 
  87. $params = array('blogId' => $blogId); 
  88. $params = array_merge($params, $optParams); 
  89. return $this->call('listByBlog', array($params), "Google_Service_Blogger_CommentList"); 
  90.  
  91. /** 
  92. * Marks a comment as spam. (comments.markAsSpam) 
  93. * @param string $blogId The ID of the Blog. 
  94. * @param string $postId The ID of the Post. 
  95. * @param string $commentId The ID of the comment to mark as spam. 
  96. * @param array $optParams Optional parameters. 
  97. * @return Google_Service_Blogger_Comment 
  98. */ 
  99. public function markAsSpam($blogId, $postId, $commentId, $optParams = array()) 
  100. $params = array('blogId' => $blogId, 'postId' => $postId, 'commentId' => $commentId); 
  101. $params = array_merge($params, $optParams); 
  102. return $this->call('markAsSpam', array($params), "Google_Service_Blogger_Comment"); 
  103.  
  104. /** 
  105. * Removes the content of a comment. (comments.removeContent) 
  106. * @param string $blogId The ID of the Blog. 
  107. * @param string $postId The ID of the Post. 
  108. * @param string $commentId The ID of the comment to delete content from. 
  109. * @param array $optParams Optional parameters. 
  110. * @return Google_Service_Blogger_Comment 
  111. */ 
  112. public function removeContent($blogId, $postId, $commentId, $optParams = array()) 
  113. $params = array('blogId' => $blogId, 'postId' => $postId, 'commentId' => $commentId); 
  114. $params = array_merge($params, $optParams); 
  115. return $this->call('removeContent', array($params), "Google_Service_Blogger_Comment");