Google_Service_Blogger_Comments_Resource

The "comments" collection of methods.

Defined (1)

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

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