Documentation

Google_Service_YouTube_Resource_Comments extends Google_Service_Resource
in package

Application

The "comments" collection of methods.

Typical usage is: $youtubeService = new Google_Service_YouTube(...); $comments = $youtubeService->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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a resource. (comments.delete)
insert() : Google_Service_YouTube_Comment: Inserts a new resource into this collection. (comments.insert)
listComments() : Google_Service_YouTube_CommentListResponse: Retrieves a list of resources, possibly filtered. (comments.listComments)
markAsSpam() : mixed: Expresses the caller's opinion that one or more comments should be flagged as spam. (comments.markAsSpam)
setModerationStatus() : mixed: Sets the moderation status of one or more comments.
update() : Google_Service_YouTube_Comment: Updates an existing resource. (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 —

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 resource. (comments.delete)


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

Parameters

$id : string
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

insert()

Inserts a new resource into this collection. (comments.insert)


    public
                insert(string|array<string|int, mixed> $part, Google_Service_YouTube_Comment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Comment

Parameters

$part : string|array<string|int, mixed>: The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.
$postBody : Google_Service_YouTube_Comment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Comment —

listComments()

Retrieves a list of resources, possibly filtered. (comments.listComments)


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

Parameters

$part : string|array<string|int, mixed>: The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_CommentListResponse —

markAsSpam()

Expresses the caller's opinion that one or more comments should be flagged as spam. (comments.markAsSpam)


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

Parameters

$id : string|array<string|int, mixed>: Flags the comments with the given IDs as spam in the caller's opinion.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

setModerationStatus()

Sets the moderation status of one or more comments.


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

(comments.setModerationStatus)

Parameters

$id : string|array<string|int, mixed>: Modifies the moderation status of the comments with the given IDs
$moderationStatus : string: Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

update()

Updates an existing resource. (comments.update)


    public
                update(string|array<string|int, mixed> $part, Google_Service_YouTube_Comment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Comment

Parameters

$part : string|array<string|int, mixed>: The part parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.
$postBody : Google_Service_YouTube_Comment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Comment —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —