table of contents
| Net::GitHub::V3::Query(3pm) | User Contributed Perl Documentation | Net::GitHub::V3::Query(3pm) |
NAME¶
Net::GitHub::V3::Query - Base Query role for Net::GitHub::V3SYNOPSIS¶
package Net::GitHub::V3::XXX;
use Moo;
with 'Net::GitHub::V3::Query';
DESCRIPTION¶
set Authentication and call APIATTRIBUTES¶
- login
- pass
- access_token
- Either set access_token from OAuth or login:pass for Basic Authentication
- raw_string
- raw_response
- api_throttle
- API throttling is enabled by default, set api_throttle to 0 to disable it.
- rate_limit
- The maximum number of queries allowed per hour. 60 for anonymous users and 5,000 for authenticated users.
- rate_limit_remaining
- The number of requests remaining in the current rate limit window.
- rate_limit_reset
- The time the current rate limit resets in UTC epoch seconds.
- last_page
- Denotes the index of the last page in the pagination
- RaiseError
METHODS¶
- query
- Refer Net::GitHub::V3
- next_page
- Calls "query" with "next_url". See Net::GitHub::V3
- prev_page
- Calls "query" with "prev_url". See Net::GitHub::V3
- first_page
- Calls "query" with "first_url". See Net::GitHub::V3
- last_page
- Calls "query" with "last_url". See Net::GitHub::V3
- set_next_page
- Adjusts next_url to be a new url in the pagination space I.E. you are jumping to a new index in the pagination
- result_sets
- For internal use by the item-per-item pagination: This is a store of the state(s) for the pagination. Each entry maps the initial URL of a GitHub query to a Net::GitHub::V3::ResultSet object.
- next($url)
- Returns the next item for the query which started at $url, or undef if there are no more items.
- close($url)
- Terminates the item-per-item pagination for the query which started at $url.
NG_DEBUG
export NG_DEBUG=1 to view the request URL
NG_DEBUG > 1 to view request/response string
AUTHOR & COPYRIGHT & LICENSE¶
Refer Net::GitHub| 2018-04-07 | perl v5.26.1 |