Documentation

Google_Service_Drive_Resource_Comments extends Google_Service_Resource
in package

Application

The "comments" collection of methods.

Typical usage is: $driveService = new Google_Service_Drive(...); $comments = $driveService->comments;

$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.
create() : Google_Service_Drive_Comment: Creates a new comment on a file. (comments.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a comment. (comments.delete)
get() : Google_Service_Drive_Comment: Gets a comment by ID. (comments.get)
listComments() : Google_Service_Drive_CommentList: Lists a file's comments. (comments.listComments)
update() : Google_Service_Drive_Comment: Updates a comment with patch semantics. (comments.update)
convertToArrayAndStripNulls() : mixed

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a new comment on a file. (comments.create)


    public
                create(string $fileId, Google_Service_Drive_Comment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_Comment

Parameters

$fileId : string: The ID of the file.
$postBody : Google_Service_Drive_Comment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_Comment —

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>

Return values

string —

$requestUrl

delete()

Deletes a comment. (comments.delete)


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

Parameters

$fileId : string: The ID of the file.
$commentId : string: The ID of the comment.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets a comment by ID. (comments.get)


    public
                get(string $fileId, string $commentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_Comment

Parameters

$fileId : string: The ID of the file.
$commentId : string: The ID of the comment.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_Comment —

listComments()

Lists a file's comments. (comments.listComments)


    public
                listComments(string $fileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_CommentList

Parameters

$fileId : string: The ID of the file.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_CommentList —

update()

Updates a comment with patch semantics. (comments.update)


    public
                update(string $fileId, string $commentId, Google_Service_Drive_Comment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_Comment

Parameters

$fileId : string: The ID of the file.
$commentId : string: The ID of the comment.
$postBody : Google_Service_Drive_Comment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_Comment —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —