Scroll to navigation

Net::GitHub::V3::Users(3pm) User Contributed Perl Documentation Net::GitHub::V3::Users(3pm)

NAME

Net::GitHub::V3::Users - GitHub Users API

SYNOPSIS

    use Net::GitHub::V3;

    my $gh = Net::GitHub::V3->new; # read L<Net::GitHub::V3> to set right authentication info
    my $user = $gh->user;

DESCRIPTION

METHODS

Users

<http://developer.github.com/v3/users/>

show
    my $uinfo = $user->show(); # /user
    my $uinfo = $user->show( 'nothingmuch' ); # /users/:user
    
update
    $user->update(
        bio  => 'another Perl programmer and Father',
    );
    

Emails

<http://developer.github.com/v3/users/emails/>

emails
add_email
remove_email
    $user->add_email( 'another@email.com' );
    $user->add_email( 'batch1@email.com', 'batch2@email.com' );
    my $emails = $user->emails;
    while ($email = $user->next_email) { ...; }
    $user->remove_email( 'another@email.com' );
    $user->remove_email( 'batch1@email.com', 'batch2@email.com' );
    

Followers

<http://developer.github.com/v3/users/followers/>

followers
following
next_follower
next_following
    my $followers = $user->followers;
    my $followers = $user->followers($user);
    my $following = $user->following;
    my $following = $user->following($user);
    my $next_follower = $user->next_follower
    my $next_follower = $user->next_follower($user)
    my $next_following = $user->next_following
    my $next_following = $user->next_following($user)
    
is_following
    my $is_following = $user->is_following($user);
    
follow
unfollow
    $user->follow( 'nothingmuch' );
    $user->unfollow( 'nothingmuch' );
    

Keys

<http://developer.github.com/v3/users/keys/>

keys
key
create_key
update_key
delete_key
    my $keys = $user->keys;
    while (my $key = $user->next_key) { ...; }
    my $key  = $user->key($key_id); # get key
    $user->create_key({
        title => 'title',
        key   => $key
    });
    $user->update_key($key_id, {
        title => $title,
        key   => $key
    });
    $user->delete_key($key_id);
    
contributions
    my $contributions = $user->contributions($username);
    # $contributions = ( ..., ['2013/09/22', 3], [ '2013/09/23', 2 ] )
    

Unpublished GitHub API used to build the 'Public contributions' graph on a users' profile page. The data structure is a list of 365 arrayrefs, one per day. Each array has two elements, the date in YYYY/MM/DD format is the first element, the second is the number of contrubtions for that day.stree .

AUTHOR & COPYRIGHT & LICENSE

Refer Net::GitHub
2018-04-07 perl v5.26.1