Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Blogger_Posts_Resource Class Reference

The "posts" collection of methods. More...

Inheritance diagram for Google_Service_Blogger_Posts_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($blogId, $postId, $optParams=array())
 Delete a post by ID.
 
 get ($blogId, $postId, $optParams=array())
 Get a post by ID.
 
 getByPath ($blogId, $path, $optParams=array())
 Retrieve a Post by Path.
 
 insert ($blogId, Google_Service_Blogger_Post $postBody, $optParams=array())
 Add a post.
 
 listPosts ($blogId, $optParams=array())
 Retrieves a list of posts, possibly filtered.
 
 patch ($blogId, $postId, Google_Service_Blogger_Post $postBody, $optParams=array())
 Update a post.
 
 publish ($blogId, $postId, $optParams=array())
 Publishes a draft post, optionally at the specific time of the given publishDate parameter.
 
 revert ($blogId, $postId, $optParams=array())
 Revert a published or scheduled post to draft state.
 
 search ($blogId, $q, $optParams=array())
 Search for a post.
 
 update ($blogId, $postId, Google_Service_Blogger_Post $postBody, $optParams=array())
 Update a post.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "posts" collection of methods.

Typical usage is: $bloggerService = new Google_Service_Blogger(...); $posts = $bloggerService->posts;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Blogger_Posts_Resource::delete ( $blogId,
$postId,
$optParams = array() )

Delete a post by ID.

(posts.delete)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
array$optParamsOptional parameters.

◆ get()

Google_Service_Blogger_Posts_Resource::get ( $blogId,
$postId,
$optParams = array() )

Get a post by ID.

(posts.get)

Parameters
string$blogIdID of the blog to fetch the post from.
string$postIdThe ID of the post
array$optParamsOptional parameters.

@opt_param bool fetchBody Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. @opt_param string maxComments Maximum number of comments to pull back on a post. @opt_param bool fetchImages Whether image URL metadata for each post is included (default: false). @opt_param string view Access level with which to view the returned result. Note that some fields require elevated access.

Return values
Google_Service_Blogger_Post

◆ getByPath()

Google_Service_Blogger_Posts_Resource::getByPath ( $blogId,
$path,
$optParams = array() )

Retrieve a Post by Path.

(posts.getByPath)

Parameters
string$blogIdID of the blog to fetch the post from.
string$pathPath of the Post to retrieve.
array$optParamsOptional parameters.

@opt_param string maxComments Maximum number of comments to pull back on a post. @opt_param string view Access level with which to view the returned result. Note that some fields require elevated access.

Return values
Google_Service_Blogger_Post

◆ insert()

Google_Service_Blogger_Posts_Resource::insert ( $blogId,
Google_Service_Blogger_Post $postBody,
$optParams = array() )

Add a post.

(posts.insert)

Parameters
string$blogIdID of the blog to add the post to.
Google_Post$postBody
array$optParamsOptional parameters.

@opt_param bool fetchImages Whether image URL metadata for each post is included in the returned result (default: false). @opt_param bool isDraft Whether to create the post as a draft (default: false). @opt_param bool fetchBody Whether the body content of the post is included with the result (default: true).

Return values
Google_Service_Blogger_Post

◆ listPosts()

Google_Service_Blogger_Posts_Resource::listPosts ( $blogId,
$optParams = array() )

Retrieves a list of posts, possibly filtered.

(posts.listPosts)

Parameters
string$blogIdID of the blog to fetch posts from.
array$optParamsOptional parameters.

@opt_param string orderBy Sort search results @opt_param string startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. @opt_param string endDate Latest post date to fetch, a date-time with RFC 3339 formatting. @opt_param string labels Comma-separated list of labels to search for. @opt_param string maxResults Maximum number of posts to fetch. @opt_param bool fetchImages Whether image URL metadata for each post is included. @opt_param string pageToken Continuation token if the request is paged. @opt_param string status Statuses to include in the results. @opt_param bool fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. @opt_param string view Access level with which to view the returned result. Note that some fields require escalated access.

Return values
Google_Service_Blogger_PostList

◆ patch()

Google_Service_Blogger_Posts_Resource::patch ( $blogId,
$postId,
Google_Service_Blogger_Post $postBody,
$optParams = array() )

Update a post.

This method supports patch semantics. (posts.patch)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
Google_Post$postBody
array$optParamsOptional parameters.

@opt_param bool revert Whether a revert action should be performed when the post is updated (default: false). @opt_param bool publish Whether a publish action should be performed when the post is updated (default: false). @opt_param bool fetchBody Whether the body content of the post is included with the result (default: true). @opt_param string maxComments Maximum number of comments to retrieve with the returned post. @opt_param bool fetchImages Whether image URL metadata for each post is included in the returned result (default: false).

Return values
Google_Service_Blogger_Post

◆ publish()

Google_Service_Blogger_Posts_Resource::publish ( $blogId,
$postId,
$optParams = array() )

Publishes a draft post, optionally at the specific time of the given publishDate parameter.

(posts.publish)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
array$optParamsOptional parameters.

@opt_param string publishDate Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.

Return values
Google_Service_Blogger_Post

◆ revert()

Google_Service_Blogger_Posts_Resource::revert ( $blogId,
$postId,
$optParams = array() )

Revert a published or scheduled post to draft state.

(posts.revert)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Post

◆ search()

Google_Service_Blogger_Posts_Resource::search ( $blogId,
$q,
$optParams = array() )

Search for a post.

(posts.search)

Parameters
string$blogIdID of the blog to fetch the post from.
string$qQuery terms to search this blog for matching posts.
array$optParamsOptional parameters.

@opt_param string orderBy Sort search results @opt_param bool fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.

Return values
Google_Service_Blogger_PostList

◆ update()

Google_Service_Blogger_Posts_Resource::update ( $blogId,
$postId,
Google_Service_Blogger_Post $postBody,
$optParams = array() )

Update a post.

(posts.update)

Parameters
string$blogIdThe ID of the Blog.
string$postIdThe ID of the Post.
Google_Post$postBody
array$optParamsOptional parameters.

@opt_param bool revert Whether a revert action should be performed when the post is updated (default: false). @opt_param bool publish Whether a publish action should be performed when the post is updated (default: false). @opt_param bool fetchBody Whether the body content of the post is included with the result (default: true). @opt_param string maxComments Maximum number of comments to retrieve with the returned post. @opt_param bool fetchImages Whether image URL metadata for each post is included in the returned result (default: false).

Return values
Google_Service_Blogger_Post

The documentation for this class was generated from the following file: