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

The "timeline" collection of methods. More...

Inheritance diagram for Google_Service_Mirror_Timeline_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($id, $optParams=array())
 Deletes a timeline item.
 
 get ($id, $optParams=array())
 Gets a single timeline item by ID.
 
 insert (Google_Service_Mirror_TimelineItem $postBody, $optParams=array())
 Inserts a new item into the timeline.
 
 listTimeline ($optParams=array())
 Retrieves a list of timeline items for the authenticated user.
 
 patch ($id, Google_Service_Mirror_TimelineItem $postBody, $optParams=array())
 Updates a timeline item in place.
 
 update ($id, Google_Service_Mirror_TimelineItem $postBody, $optParams=array())
 Updates a timeline item in place.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "timeline" collection of methods.

Typical usage is: $mirrorService = new Google_Service_Mirror(...); $timeline = $mirrorService->timeline;

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_Mirror_Timeline_Resource::delete ( $id,
$optParams = array() )

Deletes a timeline item.

(timeline.delete)

Parameters
string$idThe ID of the timeline item.
array$optParamsOptional parameters.

◆ get()

Google_Service_Mirror_Timeline_Resource::get ( $id,
$optParams = array() )

Gets a single timeline item by ID.

(timeline.get)

Parameters
string$idThe ID of the timeline item.
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_TimelineItem

◆ insert()

Google_Service_Mirror_Timeline_Resource::insert ( Google_Service_Mirror_TimelineItem $postBody,
$optParams = array() )

Inserts a new item into the timeline.

(timeline.insert)

Parameters
Google_TimelineItem$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_TimelineItem

◆ listTimeline()

Google_Service_Mirror_Timeline_Resource::listTimeline ( $optParams = array())

Retrieves a list of timeline items for the authenticated user.

(timeline.listTimeline)

Parameters
array$optParamsOptional parameters.

@opt_param string orderBy Controls the order in which timeline items are returned. @opt_param bool includeDeleted If true, tombstone records for deleted items will be returned. @opt_param string maxResults The maximum number of items to include in the response, used for paging. @opt_param string pageToken Token for the page of results to return. @opt_param string sourceItemId If provided, only items with the given sourceItemId will be returned. @opt_param bool pinnedOnly If true, only pinned items will be returned. @opt_param string bundleId If provided, only items with the given bundleId will be returned.

Return values
Google_Service_Mirror_TimelineListResponse

◆ patch()

Google_Service_Mirror_Timeline_Resource::patch ( $id,
Google_Service_Mirror_TimelineItem $postBody,
$optParams = array() )

Updates a timeline item in place.

This method supports patch semantics. (timeline.patch)

Parameters
string$idThe ID of the timeline item.
Google_TimelineItem$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_TimelineItem

◆ update()

Google_Service_Mirror_Timeline_Resource::update ( $id,
Google_Service_Mirror_TimelineItem $postBody,
$optParams = array() )

Updates a timeline item in place.

(timeline.update)

Parameters
string$idThe ID of the timeline item.
Google_TimelineItem$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_TimelineItem

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