Documentation

Google_Service_Mirror_Resource_Timeline extends Google_Service_Resource
in package

The "timeline" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a timeline item. (timeline.delete)
get()  : Google_Service_Mirror_TimelineItem
Gets a single timeline item by ID. (timeline.get)
insert()  : Google_Service_Mirror_TimelineItem
Inserts a new item into the timeline. (timeline.insert)
listTimeline()  : Google_Service_Mirror_TimelineListResponse
Retrieves a list of timeline items for the authenticated user.
patch()  : Google_Service_Mirror_TimelineItem
Updates a timeline item in place. This method supports patch semantics.
update()  : Google_Service_Mirror_TimelineItem
Updates a timeline item in place. (timeline.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a timeline item. (timeline.delete)

public delete(string $id[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$id : string

The ID of the timeline item.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

listTimeline()

Retrieves a list of timeline items for the authenticated user.

public listTimeline([array<string|int, mixed> $optParams = array() ]) : Google_Service_Mirror_TimelineListResponse

(timeline.listTimeline)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string bundleId If provided, only items with the given bundleId will be 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 orderBy Controls the order in which timeline items are returned.

opt_param

string pageToken Token for the page of results to return.

opt_param

bool pinnedOnly If true, only pinned items will be returned.

opt_param

string sourceItemId If provided, only items with the given sourceItemId will be returned.

Return values
Google_Service_Mirror_TimelineListResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results