Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Blogger_Pages_Resource Class Reference

The "pages" collection of methods. More...

Inheritance diagram for Google_Service_Blogger_Pages_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($blogId, $pageId, $optParams=array())
 Delete a page by ID.
 
 get ($blogId, $pageId, $optParams=array())
 Gets one blog page by ID.
 
 insert ($blogId, Google_Service_Blogger_Page $postBody, $optParams=array())
 Add a page.
 
 listPages ($blogId, $optParams=array())
 Retrieves the pages for a blog, optionally including non-LIVE statuses.
 
 patch ($blogId, $pageId, Google_Service_Blogger_Page $postBody, $optParams=array())
 Update a page.
 
 publish ($blogId, $pageId, $optParams=array())
 Publishes a draft page.
 
 revert ($blogId, $pageId, $optParams=array())
 Revert a published or scheduled page to draft state.
 
 update ($blogId, $pageId, Google_Service_Blogger_Page $postBody, $optParams=array())
 Update a page.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "pages" collection of methods.

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

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_Pages_Resource::delete ( $blogId,
$pageId,
$optParams = array() )

Delete a page by ID.

(pages.delete)

Parameters
string$blogIdThe ID of the Blog.
string$pageIdThe ID of the Page.
array$optParamsOptional parameters.

◆ get()

Google_Service_Blogger_Pages_Resource::get ( $blogId,
$pageId,
$optParams = array() )

Gets one blog page by ID.

(pages.get)

Parameters
string$blogIdID of the blog containing the page.
string$pageIdThe ID of the page to get.
array$optParamsOptional parameters.

@opt_param string view

Return values
Google_Service_Blogger_Page

◆ insert()

Google_Service_Blogger_Pages_Resource::insert ( $blogId,
Google_Service_Blogger_Page $postBody,
$optParams = array() )

Add a page.

(pages.insert)

Parameters
string$blogIdID of the blog to add the page to.
Google_Page$postBody
array$optParamsOptional parameters.

@opt_param bool isDraft Whether to create the page as a draft (default: false).

Return values
Google_Service_Blogger_Page

◆ listPages()

Google_Service_Blogger_Pages_Resource::listPages ( $blogId,
$optParams = array() )

Retrieves the pages for a blog, optionally including non-LIVE statuses.

(pages.listPages)

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

@opt_param string status @opt_param string maxResults Maximum number of Pages to fetch. @opt_param string pageToken Continuation token if the request is paged. @opt_param bool fetchBodies Whether to retrieve the Page bodies. @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_PageList

◆ patch()

Google_Service_Blogger_Pages_Resource::patch ( $blogId,
$pageId,
Google_Service_Blogger_Page $postBody,
$optParams = array() )

Update a page.

This method supports patch semantics. (pages.patch)

Parameters
string$blogIdThe ID of the Blog.
string$pageIdThe ID of the Page.
Google_Page$postBody
array$optParamsOptional parameters.

@opt_param bool revert Whether a revert action should be performed when the page is updated (default: false). @opt_param bool publish Whether a publish action should be performed when the page is updated (default: false).

Return values
Google_Service_Blogger_Page

◆ publish()

Google_Service_Blogger_Pages_Resource::publish ( $blogId,
$pageId,
$optParams = array() )

Publishes a draft page.

(pages.publish)

Parameters
string$blogIdThe ID of the blog.
string$pageIdThe ID of the page.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Page

◆ revert()

Google_Service_Blogger_Pages_Resource::revert ( $blogId,
$pageId,
$optParams = array() )

Revert a published or scheduled page to draft state.

(pages.revert)

Parameters
string$blogIdThe ID of the blog.
string$pageIdThe ID of the page.
array$optParamsOptional parameters.
Return values
Google_Service_Blogger_Page

◆ update()

Google_Service_Blogger_Pages_Resource::update ( $blogId,
$pageId,
Google_Service_Blogger_Page $postBody,
$optParams = array() )

Update a page.

(pages.update)

Parameters
string$blogIdThe ID of the Blog.
string$pageIdThe ID of the Page.
Google_Page$postBody
array$optParamsOptional parameters.

@opt_param bool revert Whether a revert action should be performed when the page is updated (default: false). @opt_param bool publish Whether a publish action should be performed when the page is updated (default: false).

Return values
Google_Service_Blogger_Page

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