Scroll to navigation

Pithub::Repos::Starring(3pm) User Contributed Perl Documentation Pithub::Repos::Starring(3pm)
 

NAME

Pithub::Repos::Starring - Github v3 Repo Starring API

VERSION

version 0.01025

METHODS

has_starred

Check if you are starring a repository.
Requires for the user to be authenticated.
    GET /user/starred/:user/:repo
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->has_starred(
        repo => 'Pithub',
        user => 'plu',
    );
    

list

List all stargazers of a repository
    GET /repos/:user/:repo/stargazers
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->list(
        repo => 'Pithub',
        user => 'plu',
    );
    

list_repos

List repositories being starred by a user.
    GET /users/:user/starred
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->list_repos(
        user => 'plu',
    );
    
List repos being starred by the authenticated user
    GET /user/starred
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->list_repos;
    

star

Star a repository.
Requires for the user to be authenticated.
    PUT /user/starred/:user/:repo
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->star(
        repo => 'Pithub',
        user => 'plu',
    );
    

unstar

Unstar a repository.
Requires for the user to be authenticated.
    DELETE /user/starred/:user/:repo
    
Examples:
    my $s = Pithub::Repos::Starring->new;
    my $result = $s->unstar(
        repo => 'Pithub',
        user => 'plu',
    );
    

AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
2014-05-18 perl v5.18.2