Google_Service_Mirror_Resource_TimelineAttachments
extends Google_Service_Resource
in package
The "attachments" collection of methods.
Typical usage is:
$mirrorService = new Google_Service_Mirror(...);
$attachments = $mirrorService->attachments;
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 an attachment from a timeline item. (attachments.delete)
- get() : Google_Service_Mirror_Attachment
- Retrieves an attachment on a timeline item by item ID and attachment ID.
- insert() : Google_Service_Mirror_Attachment
- Adds a new attachment to a timeline item. (attachments.insert)
- listTimelineAttachments() : Google_Service_Mirror_AttachmentsListResponse
- Returns a list of attachments for a timeline item.
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$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
Tags
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
Return values
string —$requestUrl
delete()
Deletes an attachment from a timeline item. (attachments.delete)
public
delete(string $itemId, string $attachmentId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
- $itemId : string
-
The ID of the timeline item the attachment belongs to.
- $attachmentId : string
-
The ID of the attachment.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —get()
Retrieves an attachment on a timeline item by item ID and attachment ID.
public
get(string $itemId, string $attachmentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Mirror_Attachment
(attachments.get)
Parameters
- $itemId : string
-
The ID of the timeline item the attachment belongs to.
- $attachmentId : string
-
The ID of the attachment.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Mirror_Attachment —insert()
Adds a new attachment to a timeline item. (attachments.insert)
public
insert(string $itemId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Mirror_Attachment
Parameters
- $itemId : string
-
The ID of the timeline item the attachment belongs to.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Mirror_Attachment —listTimelineAttachments()
Returns a list of attachments for a timeline item.
public
listTimelineAttachments(string $itemId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Mirror_AttachmentsListResponse
(attachments.listTimelineAttachments)
Parameters
- $itemId : string
-
The ID of the timeline item whose attachments should be listed.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Mirror_AttachmentsListResponse —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed