shirirules > WebService-GData-0.0501 > WebService::GData::YouTube::Feed::Complaint

Download:
WebService-GData-0.0501.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0101   Source   Latest Release: WebService-GData-0.06

NAME ^

WebService::GData::YouTube::Feed::Complaint - add a complaint about a video (read/write) for data API v2.

SYNOPSIS ^

    use WebService::GData::YouTube;
    
    use constant KEY=>'...';
        
    my $auth; 
    eval {
        $auth = new WebService::GData::ClientLogin(
           email=>...@gmail.com',
           password=>'...',
           key=>KEY
       );
    };   
    
    #instantiate a complaint
    my $complaint = new WebService::GData::YouTube($auth)->complaint;
    
    #attach the complaint to a video
    $complaint->video_id('2lDekeCDD-J1');
       
    $complaint->reason('VIOLENCE');#default to SPAM
    $complaint->summary('This is too violent to be displayed on YouTube...');
    
    #save
    eval {
        $complaint->save();
    };
    if(my $error = $@){
        say $error->code;
    }  

DESCRIPTION ^

!WARNING! Documentation in progress.

!DEVELOPER RELEASE! API may change, program may break or be under optimized and I haven't done a full range of tests yet!

inherits from WebService::GData::Feed::Entry.

This package represents a Youtube Complaint.

This is only a create object so you need to be logged in to use this package.

You can not, however, edit or erase complaints as this feature is not available yet.

Most of the time you will not instantiate this class directly but use the complaint method in the WebService::GData::YouTube class.

CONSTRUCTOR

new

Create a WebService::GData::YouTube::Feed::Complaint instance.

Parameters:

jsonc_video_entry_feed:Object (Optional)
authorization:Object (Optional)

or

authorization:Object (Optional)

If an authorization object is set (WebService::GData::ClientLogin),

it will allow you to insert new complaint.

GENERAL SET/GET METHODS

reason

By default, it is set to SPAM but you can set it to one of the available reasons:

    PORN 
    VIOLENCE 
    HATE 
    DANGEROUS 
    RIGHTS
    SPAM

See http://code.google.com/intl/en/apis/youtube/2.0/developers_guide_protocol_complaints.html

video_id

The video id to which you want to add a complaint.

summary

It should contain some explanations on the complaints reason.

QUERY METHODS

This method actually query the service to save your data. You must be logged in programmaticly to be able to use them.

save

The save method will do an insert only if a video_id is set.

CONFIGURATION AND ENVIRONMENT ^

none

INCOMPATIBILITIES ^

none

BUGS AND LIMITATIONS ^

If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!

AUTHOR ^

shiriru <shirirulestheworld[arobas]gmail.com>

LICENSE AND COPYRIGHT ^

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: