GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PITHUB::EVENTS (3)

.ds Aq ’

NAME

Pithub::Events - Github v3 Events API

CONTENTS

VERSION

version 0.01033

METHODS

    issue

o List issue events for a repository



    GET /repos/:user/:repo/issues/events



Examples:



    my $e      = Pithub::Events->new;
    my $result = $e->issue(
        user => plu,
        repo => Pithub,
    );



    network

o List public events for a network of repositories



    GET /networks/:user/:repo/events



Examples:



    my $e      = Pithub::Events->new;
    my $result = $e->network(
        user => plu,
        repo => Pithub,
    );



    org

o List public events for an organization



    GET /orgs/:org/events



Examples:



    my $e = Pithub::Events->new;
    my $result = $e->org( org => CPAN-API );



    org_for_user

o List events for an organization



    GET /users/:user/events/orgs/:org



Examples:



    my $e = Pithub::Events->new;
    my $result = $e->org(
        org  => CPAN-API,
        user => plu,
    );



    public

o List public events



    GET /events



Examples:



    my $e      = Pithub::Events->new;
    my $result = $e->public;



    repos

o List repository events



    GET /repos/:user/:repo/events



Examples:



    my $e      = Pithub::Events->new;
    my $result = $e->repos(
        user => plu,
        repo => Pithub,
    );



    user_performed

o List events performed by a user



    GET /users/:user/events



If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.

Examples:



    my $e = Pithub::Events->new;
    my $result = $e->user_performed( user => plu );

    # List public events performed by a user
    my $e      = Pithub::Events->new;
    my $result = $e->user_performed(
        user   => plu,
        public => 1,
    );



    user_received

o List events that a user has received



    GET /users/:user/received_events



These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.

Examples:



    my $e = Pithub::Events->new;
    my $result = $e->user_received( user => plu );

    # List public events that a user has received
    my $e      = Pithub::Events->new;
    my $result = $e->user_received(
        user   => plu,
        public => 1,
    );



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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PITHUB::EVENTS (3) 2016-01-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.