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

The "blogs" collection of methods. More...

Inheritance diagram for Google_Service_Blogger_Blogs_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($blogId, $optParams=array())
 Gets one blog by ID.
 
 getByUrl ($url, $optParams=array())
 Retrieve a Blog by URL.
 
 listByUser ($userId, $optParams=array())
 Retrieves a list of blogs, possibly filtered.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "blogs" collection of methods.

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

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

◆ get()

Google_Service_Blogger_Blogs_Resource::get ( $blogId,
$optParams = array() )

Gets one blog by ID.

(blogs.get)

Parameters
string$blogIdThe ID of the blog to get.
array$optParamsOptional parameters.

@opt_param string maxPosts Maximum number of posts to pull back with the blog. @opt_param string view Access level with which to view the blog. Note that some fields require elevated access.

Return values
Google_Service_Blogger_Blog

◆ getByUrl()

Google_Service_Blogger_Blogs_Resource::getByUrl ( $url,
$optParams = array() )

Retrieve a Blog by URL.

(blogs.getByUrl)

Parameters
string$urlThe URL of the blog to retrieve.
array$optParamsOptional parameters.

@opt_param string view Access level with which to view the blog. Note that some fields require elevated access.

Return values
Google_Service_Blogger_Blog

◆ listByUser()

Google_Service_Blogger_Blogs_Resource::listByUser ( $userId,
$optParams = array() )

Retrieves a list of blogs, possibly filtered.

(blogs.listByUser)

Parameters
string$userIdID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
array$optParamsOptional parameters.

@opt_param bool fetchUserInfo Whether the response is a list of blogs with per-user information instead of just blogs. @opt_param string status Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. @opt_param string role User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. @opt_param string view Access level with which to view the blogs. Note that some fields require elevated access.

Return values
Google_Service_Blogger_BlogList

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