גאבור סבו - Gábor Szabó > WebService-GData > WebService::GData::YouTube::Feed::Friend

Download:
WebService-GData-0.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.0101   Source  

NAME ^

WebService::GData::YouTube::Feed::Friend - a user contact list (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
       );
    };   
    
    #adding a contact
    
    #instantiate a $contact
    my $contact = new WebService::GData::YouTube($auth)->contact;
    
    #set a friend 
    $contact->username('google');
    
    #add it as a friend
    eval {
        $contact->save();
    };
    if(my $error = $@){
        say $error->code;
    }  
    
    #deleting/updating contacts
    
    #instantiate a $contact
    my $contacts = new WebService::GData::YouTube($auth)->get_user_contacts;
    
    foreach my $contact (@$contacts){
        if($contact->username() eq 'devil'){
                $contact->delete;
        }
        if($contact->username() eq 'spammy'){
            $contact->status('rejected');
            $contact->update;
        }       
    }

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 Friend or Contact.

You can access this kind of information without being logged in but you will need to be authorized to edit/delete or add new contacts.

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

CONSTRUCTOR

new

Create a WebService::GData::YouTube::Feed::Contact 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/delete/update new contacts.

INHERITED METHODS

All the following read only methods give access to the information contained in a contact feed entry.

etag

updated

published

category

id

link

title

author

GENERAL SET/GET METHODS

username

The username of the contact as in its profile.

status

Specifies if the contact is accepted,pending or requested.

See http://code.google.com/intl/en/apis/youtube/2.0/developers_guide_protocol_contacts.html#Retrieve_contacts

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 requires a username to be set.

update

The update method requires a username to be set. (either you set it with the username method or you get the edit link by querying the feed).

delete

The delete method requires a username to be set. (either you set it with the username method or you get the edit link by querying the feed).

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: