mirror of https://github.com/matrix-org/go-neb.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
14559 lines
654 KiB
14559 lines
654 KiB
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#375EAB">
|
|
|
|
<title>github - The Go Programming Language</title>
|
|
|
|
<link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
|
|
|
|
<link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css">
|
|
<script type="text/javascript">window.initFuncs = [];</script>
|
|
</head>
|
|
<body>
|
|
|
|
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
|
|
...
|
|
</div><!-- #lowframe -->
|
|
|
|
<div id="topbar" class="wide"><div class="container">
|
|
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
|
|
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
|
|
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">▽</span></a>
|
|
<form method="GET" action="http://localhost:6060/search">
|
|
<div id="menu">
|
|
<a href="http://localhost:6060/doc/">Documents</a>
|
|
<a href="http://localhost:6060/pkg/">Packages</a>
|
|
<a href="http://localhost:6060/project/">The Project</a>
|
|
<a href="http://localhost:6060/help/">Help</a>
|
|
<a href="http://localhost:6060/blog/">Blog</a>
|
|
|
|
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
|
|
</div>
|
|
</form>
|
|
|
|
</div></div>
|
|
|
|
|
|
|
|
<div id="page" class="wide">
|
|
<div class="container">
|
|
|
|
|
|
<h1>Package github</h1>
|
|
|
|
|
|
|
|
|
|
<div id="nav"></div>
|
|
|
|
|
|
<!--
|
|
Copyright 2009 The Go Authors. All rights reserved.
|
|
Use of this source code is governed by a BSD-style
|
|
license that can be found in the LICENSE file.
|
|
-->
|
|
<!--
|
|
Note: Static (i.e., not template-generated) href and id
|
|
attributes start with "pkg-" to make it impossible for
|
|
them to conflict with generated attributes (some of which
|
|
correspond to Go identifiers).
|
|
-->
|
|
|
|
<script type='text/javascript'>
|
|
document.ANALYSIS_DATA = null;
|
|
document.CALLGRAPH = null;
|
|
</script>
|
|
|
|
|
|
|
|
<div id="short-nav">
|
|
<dl>
|
|
<dd><code>import "github.com/google/go-github/github"</code></dd>
|
|
</dl>
|
|
<dl>
|
|
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
|
|
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
|
|
|
|
<dd><a href="index.html#pkg-examples" class="examplesLink">Examples</a></dd>
|
|
|
|
|
|
</dl>
|
|
</div>
|
|
<!-- The package's Name is printed as title by the top-level template -->
|
|
<div id="pkg-overview" class="toggleVisible">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
|
|
</div>
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
|
|
<p>
|
|
Package github provides a client for using the GitHub API.
|
|
</p>
|
|
<p>
|
|
Usage:
|
|
</p>
|
|
<pre>import "github.com/google/go-github/github"
|
|
</pre>
|
|
<p>
|
|
Construct a new GitHub client, then use the various services on the client to
|
|
access different parts of the GitHub API. For example:
|
|
</p>
|
|
<pre>client := github.NewClient(nil)
|
|
|
|
// list all organizations for user "willnorris"
|
|
orgs, _, err := client.Organizations.List("willnorris", nil)
|
|
</pre>
|
|
<p>
|
|
Some API methods have optional parameters that can be passed. For example:
|
|
</p>
|
|
<pre>client := github.NewClient(nil)
|
|
|
|
// list recently updated repositories for org "github"
|
|
opt := &github.RepositoryListByOrgOptions{Sort: "updated"}
|
|
repos, _, err := client.Repositories.ListByOrg("github", opt)
|
|
</pre>
|
|
<p>
|
|
The services of a client divide the API into logical chunks and correspond to
|
|
the structure of the GitHub API documentation at
|
|
<a href="http://developer.github.com/v3/">http://developer.github.com/v3/</a>.
|
|
</p>
|
|
<h3 id="hdr-Authentication">Authentication</h3>
|
|
<p>
|
|
The go-github library does not directly handle authentication. Instead, when
|
|
creating a new client, pass an http.Client that can handle authentication for
|
|
you. The easiest and recommended way to do this is using the golang.org/x/oauth2
|
|
library, but you can always use any other library that provides an http.Client.
|
|
If you have an OAuth2 access token (for example, a personal API token), you can
|
|
use it with the oauth2 library using:
|
|
</p>
|
|
<pre>import "golang.org/x/oauth2"
|
|
|
|
func main() {
|
|
ts := oauth2.StaticTokenSource(
|
|
&oauth2.Token{AccessToken: "... your access token ..."},
|
|
)
|
|
tc := oauth2.NewClient(oauth2.NoContext, ts)
|
|
|
|
client := github.NewClient(tc)
|
|
|
|
// list all repositories for the authenticated user
|
|
repos, _, err := client.Repositories.List("", nil)
|
|
}
|
|
</pre>
|
|
<p>
|
|
Note that when using an authenticated Client, all calls made by the client will
|
|
include the specified OAuth token. Therefore, authenticated clients should
|
|
almost never be shared between different users.
|
|
</p>
|
|
<p>
|
|
See the oauth2 docs for complete instructions on using that library.
|
|
</p>
|
|
<p>
|
|
For API methods that require HTTP Basic Authentication, use the
|
|
BasicAuthTransport.
|
|
</p>
|
|
<h3 id="hdr-Rate_Limiting">Rate Limiting</h3>
|
|
<p>
|
|
GitHub imposes a rate limit on all API clients. Unauthenticated clients are
|
|
limited to 60 requests per hour, while authenticated clients can make up to
|
|
5,000 requests per hour. To receive the higher rate limit when making calls
|
|
that are not issued on behalf of a user, use the
|
|
UnauthenticatedRateLimitedTransport.
|
|
</p>
|
|
<p>
|
|
The Rate method on a client returns the rate limit information based on the most
|
|
recent API call. This is updated on every call, but may be out of date if it's
|
|
been some time since the last API call and other clients have made subsequent
|
|
requests since then. You can always call RateLimits() directly to get the most
|
|
up-to-date rate limit data for the client.
|
|
</p>
|
|
<p>
|
|
To detect an API rate limit error, you can check if its type is *github.RateLimitError:
|
|
</p>
|
|
<pre>repos, _, err := client.Repositories.List("", nil)
|
|
if _, ok := err.(*github.RateLimitError); ok {
|
|
log.Println("hit rate limit")
|
|
}
|
|
</pre>
|
|
<p>
|
|
Learn more about GitHub rate limiting at
|
|
<a href="http://developer.github.com/v3/#rate-limiting">http://developer.github.com/v3/#rate-limiting</a>.
|
|
</p>
|
|
<h3 id="hdr-Conditional_Requests">Conditional Requests</h3>
|
|
<p>
|
|
The GitHub API has good support for conditional requests which will help
|
|
prevent you from burning through your rate limit, as well as help speed up your
|
|
application. go-github does not handle conditional requests directly, but is
|
|
instead designed to work with a caching http.Transport. We recommend using
|
|
<a href="https://github.com/gregjones/httpcache">https://github.com/gregjones/httpcache</a> for that.
|
|
</p>
|
|
<p>
|
|
Learn more about GitHub conditional requests at
|
|
<a href="https://developer.github.com/v3/#conditional-requests">https://developer.github.com/v3/#conditional-requests</a>.
|
|
</p>
|
|
<h3 id="hdr-Creating_and_Updating_Resources">Creating and Updating Resources</h3>
|
|
<p>
|
|
All structs for GitHub resources use pointer values for all non-repeated fields.
|
|
This allows distinguishing between unset fields and those set to a zero-value.
|
|
Helper functions have been provided to easily create these pointers for string,
|
|
bool, and int values. For example:
|
|
</p>
|
|
<pre>// create a new private repository named "foo"
|
|
repo := &github.Repository{
|
|
Name: github.String("foo"),
|
|
Private: github.Bool(true),
|
|
}
|
|
client.Repositories.Create("", repo)
|
|
</pre>
|
|
<p>
|
|
Users who have worked with protocol buffers should find this pattern familiar.
|
|
</p>
|
|
<h3 id="hdr-Pagination">Pagination</h3>
|
|
<p>
|
|
All requests for resource collections (repos, pull requests, issues, etc.)
|
|
support pagination. Pagination options are described in the
|
|
github.ListOptions struct and passed to the list methods directly or as an
|
|
embedded type of a more specific list options struct (for example
|
|
github.PullRequestListOptions). Pages information is available via the
|
|
github.Response struct.
|
|
</p>
|
|
<pre>client := github.NewClient(nil)
|
|
|
|
opt := &github.RepositoryListByOrgOptions{
|
|
ListOptions: github.ListOptions{PerPage: 10},
|
|
}
|
|
// get all pages of results
|
|
var allRepos []*github.Repository
|
|
for {
|
|
repos, resp, err := client.Repositories.ListByOrg("github", opt)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
allRepos = append(allRepos, repos...)
|
|
if resp.NextPage == 0 {
|
|
break
|
|
}
|
|
opt.ListOptions.Page = resp.NextPage
|
|
}
|
|
</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="pkg-index" class="toggleVisible">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
|
|
</div>
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
|
|
|
|
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
|
|
<div id="manual-nav">
|
|
<dl>
|
|
|
|
<dd><a href="index.html#pkg-constants">Constants</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Bool">func Bool(v bool) *bool</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#CheckResponse">func CheckResponse(r *http.Response) error</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Int">func Int(v int) *int</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#String">func String(v string) *string</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Stringify">func Stringify(message interface{}) string</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#ValidatePayload">func ValidatePayload(r *http.Request, secretKey []byte) (payload []byte, err error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#APIMeta">type APIMeta</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ActivityListStarredOptions">type ActivityListStarredOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ActivityService">type ActivityService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.DeleteRepositorySubscription">func (s *ActivityService) DeleteRepositorySubscription(owner, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.DeleteThreadSubscription">func (s *ActivityService) DeleteThreadSubscription(id string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.GetRepositorySubscription">func (s *ActivityService) GetRepositorySubscription(owner, repo string) (*Subscription, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.GetThread">func (s *ActivityService) GetThread(id string) (*Notification, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.GetThreadSubscription">func (s *ActivityService) GetThreadSubscription(id string) (*Subscription, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.IsStarred">func (s *ActivityService) IsStarred(owner, repo string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListEvents">func (s *ActivityService) ListEvents(opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListEventsForOrganization">func (s *ActivityService) ListEventsForOrganization(org string, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListEventsForRepoNetwork">func (s *ActivityService) ListEventsForRepoNetwork(owner, repo string, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListEventsPerformedByUser">func (s *ActivityService) ListEventsPerformedByUser(user string, publicOnly bool, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListEventsReceivedByUser">func (s *ActivityService) ListEventsReceivedByUser(user string, publicOnly bool, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListFeeds">func (s *ActivityService) ListFeeds() (*Feeds, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListIssueEventsForRepository">func (s *ActivityService) ListIssueEventsForRepository(owner, repo string, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListNotifications">func (s *ActivityService) ListNotifications(opt *NotificationListOptions) ([]*Notification, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListRepositoryEvents">func (s *ActivityService) ListRepositoryEvents(owner, repo string, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListRepositoryNotifications">func (s *ActivityService) ListRepositoryNotifications(owner, repo string, opt *NotificationListOptions) ([]*Notification, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListStargazers">func (s *ActivityService) ListStargazers(owner, repo string, opt *ListOptions) ([]*Stargazer, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListStarred">func (s *ActivityService) ListStarred(user string, opt *ActivityListStarredOptions) ([]*StarredRepository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListUserEventsForOrganization">func (s *ActivityService) ListUserEventsForOrganization(org, user string, opt *ListOptions) ([]*Event, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListWatched">func (s *ActivityService) ListWatched(user string, opt *ListOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.ListWatchers">func (s *ActivityService) ListWatchers(owner, repo string, opt *ListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.MarkNotificationsRead">func (s *ActivityService) MarkNotificationsRead(lastRead time.Time) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.MarkRepositoryNotificationsRead">func (s *ActivityService) MarkRepositoryNotificationsRead(owner, repo string, lastRead time.Time) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.MarkThreadRead">func (s *ActivityService) MarkThreadRead(id string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.SetRepositorySubscription">func (s *ActivityService) SetRepositorySubscription(owner, repo string, subscription *Subscription) (*Subscription, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.SetThreadSubscription">func (s *ActivityService) SetThreadSubscription(id string, subscription *Subscription) (*Subscription, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.Star">func (s *ActivityService) Star(owner, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ActivityService.Unstar">func (s *ActivityService) Unstar(owner, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Authorization">type Authorization</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Authorization.String">func (a Authorization) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#AuthorizationApp">type AuthorizationApp</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationApp.String">func (a AuthorizationApp) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#AuthorizationRequest">type AuthorizationRequest</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationRequest.String">func (a AuthorizationRequest) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#AuthorizationUpdateRequest">type AuthorizationUpdateRequest</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationUpdateRequest.String">func (a AuthorizationUpdateRequest) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#AuthorizationsService">type AuthorizationsService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Check">func (s *AuthorizationsService) Check(clientID string, token string) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Create">func (s *AuthorizationsService) Create(auth *AuthorizationRequest) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.CreateImpersonation">func (s *AuthorizationsService) CreateImpersonation(username string, authReq *AuthorizationRequest) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Delete">func (s *AuthorizationsService) Delete(id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.DeleteGrant">func (s *AuthorizationsService) DeleteGrant(id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.DeleteImpersonation">func (s *AuthorizationsService) DeleteImpersonation(username string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Edit">func (s *AuthorizationsService) Edit(id int, auth *AuthorizationUpdateRequest) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Get">func (s *AuthorizationsService) Get(id int) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.GetGrant">func (s *AuthorizationsService) GetGrant(id int) (*Grant, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.GetOrCreateForApp">func (s *AuthorizationsService) GetOrCreateForApp(clientID string, auth *AuthorizationRequest) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.List">func (s *AuthorizationsService) List(opt *ListOptions) ([]*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.ListGrants">func (s *AuthorizationsService) ListGrants() ([]*Grant, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Reset">func (s *AuthorizationsService) Reset(clientID string, token string) (*Authorization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#AuthorizationsService.Revoke">func (s *AuthorizationsService) Revoke(clientID string, token string) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#BasicAuthTransport">type BasicAuthTransport</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#BasicAuthTransport.Client">func (t *BasicAuthTransport) Client() *http.Client</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#BasicAuthTransport.RoundTrip">func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Blob">type Blob</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Branch">type Branch</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Client">type Client</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#NewClient">func NewClient(httpClient *http.Client) *Client</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Client.APIMeta">func (c *Client) APIMeta() (*APIMeta, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.Do">func (c *Client) Do(req *http.Request, v interface{}) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.ListEmojis">func (c *Client) ListEmojis() (map[string]string, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.ListServiceHooks">func (c *Client) ListServiceHooks() ([]*ServiceHook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.Markdown">func (c *Client) Markdown(text string, opt *MarkdownOptions) (string, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.NewRequest">func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.NewUploadRequest">func (c *Client) NewUploadRequest(urlStr string, reader io.Reader, size int64, mediaType string) (*http.Request, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.Octocat">func (c *Client) Octocat(message string) (string, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.Rate">func (c *Client) Rate() Rate</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.RateLimit">func (c *Client) RateLimit() (*Rate, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.RateLimits">func (c *Client) RateLimits() (*RateLimits, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Client.Zen">func (c *Client) Zen() (string, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CodeResult">type CodeResult</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CodeResult.String">func (c CodeResult) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CodeSearchResult">type CodeSearchResult</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#CombinedStatus">type CombinedStatus</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CombinedStatus.String">func (s CombinedStatus) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Commit">type Commit</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Commit.String">func (c Commit) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitAuthor">type CommitAuthor</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CommitAuthor.String">func (c CommitAuthor) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitCommentEvent">type CommitCommentEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitFile">type CommitFile</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CommitFile.String">func (c CommitFile) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitStats">type CommitStats</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CommitStats.String">func (c CommitStats) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitsComparison">type CommitsComparison</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#CommitsComparison.String">func (c CommitsComparison) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CommitsListOptions">type CommitsListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Contributor">type Contributor</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ContributorStats">type ContributorStats</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ContributorStats.String">func (c ContributorStats) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#CreateEvent">type CreateEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeleteEvent">type DeleteEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Deployment">type Deployment</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentEvent">type DeploymentEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentRequest">type DeploymentRequest</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentStatus">type DeploymentStatus</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentStatusEvent">type DeploymentStatusEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentStatusRequest">type DeploymentStatusRequest</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#DeploymentsListOptions">type DeploymentsListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#EditChange">type EditChange</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Error">type Error</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Error.Error">func (e *Error) Error() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#ErrorResponse">type ErrorResponse</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ErrorResponse.Error">func (r *ErrorResponse) Error() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Event">type Event</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Event.Payload">func (e *Event) Payload() (payload interface{})</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Event.String">func (e Event) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#FeedLink">type FeedLink</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Feeds">type Feeds</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ForkEvent">type ForkEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#GPGEmail">type GPGEmail</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#GPGKey">type GPGKey</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GPGKey.String">func (k GPGKey) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Gist">type Gist</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Gist.String">func (g Gist) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistComment">type GistComment</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GistComment.String">func (g GistComment) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistCommit">type GistCommit</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GistCommit.String">func (gc GistCommit) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistFile">type GistFile</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GistFile.String">func (g GistFile) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistFilename">type GistFilename</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistFork">type GistFork</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GistFork.String">func (gf GistFork) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistListOptions">type GistListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#GistsService">type GistsService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Create">func (s *GistsService) Create(gist *Gist) (*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.CreateComment">func (s *GistsService) CreateComment(gistID string, comment *GistComment) (*GistComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Delete">func (s *GistsService) Delete(id string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.DeleteComment">func (s *GistsService) DeleteComment(gistID string, commentID int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Edit">func (s *GistsService) Edit(id string, gist *Gist) (*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.EditComment">func (s *GistsService) EditComment(gistID string, commentID int, comment *GistComment) (*GistComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Fork">func (s *GistsService) Fork(id string) (*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Get">func (s *GistsService) Get(id string) (*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.GetComment">func (s *GistsService) GetComment(gistID string, commentID int) (*GistComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.GetRevision">func (s *GistsService) GetRevision(id, sha string) (*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.IsStarred">func (s *GistsService) IsStarred(id string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.List">func (s *GistsService) List(user string, opt *GistListOptions) ([]*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.ListAll">func (s *GistsService) ListAll(opt *GistListOptions) ([]*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.ListComments">func (s *GistsService) ListComments(gistID string, opt *ListOptions) ([]*GistComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.ListCommits">func (s *GistsService) ListCommits(id string) ([]*GistCommit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.ListForks">func (s *GistsService) ListForks(id string) ([]*GistFork, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.ListStarred">func (s *GistsService) ListStarred(opt *GistListOptions) ([]*Gist, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Star">func (s *GistsService) Star(id string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GistsService.Unstar">func (s *GistsService) Unstar(id string) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GitObject">type GitObject</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GitObject.String">func (o GitObject) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GitService">type GitService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GitService.CreateBlob">func (s *GitService) CreateBlob(owner string, repo string, blob *Blob) (*Blob, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.CreateCommit">func (s *GitService) CreateCommit(owner string, repo string, commit *Commit) (*Commit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.CreateRef">func (s *GitService) CreateRef(owner string, repo string, ref *Reference) (*Reference, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.CreateTag">func (s *GitService) CreateTag(owner string, repo string, tag *Tag) (*Tag, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.CreateTree">func (s *GitService) CreateTree(owner string, repo string, baseTree string, entries []TreeEntry) (*Tree, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.DeleteRef">func (s *GitService) DeleteRef(owner string, repo string, ref string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.GetBlob">func (s *GitService) GetBlob(owner string, repo string, sha string) (*Blob, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.GetCommit">func (s *GitService) GetCommit(owner string, repo string, sha string) (*Commit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.GetRef">func (s *GitService) GetRef(owner string, repo string, ref string) (*Reference, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.GetTag">func (s *GitService) GetTag(owner string, repo string, sha string) (*Tag, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.GetTree">func (s *GitService) GetTree(owner string, repo string, sha string, recursive bool) (*Tree, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.ListRefs">func (s *GitService) ListRefs(owner, repo string, opt *ReferenceListOptions) ([]*Reference, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitService.UpdateRef">func (s *GitService) UpdateRef(owner string, repo string, ref *Reference, force bool) (*Reference, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Gitignore">type Gitignore</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Gitignore.String">func (g Gitignore) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GitignoresService">type GitignoresService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#GitignoresService.Get">func (s GitignoresService) Get(name string) (*Gitignore, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#GitignoresService.List">func (s GitignoresService) List() ([]string, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#GollumEvent">type GollumEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Grant">type Grant</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Grant.String">func (g Grant) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Hook">type Hook</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Hook.String">func (h Hook) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Import">type Import</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Import.String">func (i Import) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Issue">type Issue</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Issue.String">func (i Issue) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueActivityEvent">type IssueActivityEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueComment">type IssueComment</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#IssueComment.String">func (i IssueComment) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueCommentEvent">type IssueCommentEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueEvent">type IssueEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueListByRepoOptions">type IssueListByRepoOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueListCommentsOptions">type IssueListCommentsOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueListOptions">type IssueListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssueRequest">type IssueRequest</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssuesEvent">type IssuesEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssuesSearchResult">type IssuesSearchResult</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#IssuesService">type IssuesService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.AddAssignees">func (s *IssuesService) AddAssignees(owner, repo string, number int, assignees []string) (*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.AddLabelsToIssue">func (s *IssuesService) AddLabelsToIssue(owner string, repo string, number int, labels []string) ([]*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.Create">func (s *IssuesService) Create(owner string, repo string, issue *IssueRequest) (*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.CreateComment">func (s *IssuesService) CreateComment(owner string, repo string, number int, comment *IssueComment) (*IssueComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.CreateLabel">func (s *IssuesService) CreateLabel(owner string, repo string, label *Label) (*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.CreateMilestone">func (s *IssuesService) CreateMilestone(owner string, repo string, milestone *Milestone) (*Milestone, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.DeleteComment">func (s *IssuesService) DeleteComment(owner string, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.DeleteLabel">func (s *IssuesService) DeleteLabel(owner string, repo string, name string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.DeleteMilestone">func (s *IssuesService) DeleteMilestone(owner string, repo string, number int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.Edit">func (s *IssuesService) Edit(owner string, repo string, number int, issue *IssueRequest) (*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.EditComment">func (s *IssuesService) EditComment(owner string, repo string, id int, comment *IssueComment) (*IssueComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.EditLabel">func (s *IssuesService) EditLabel(owner string, repo string, name string, label *Label) (*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.EditMilestone">func (s *IssuesService) EditMilestone(owner string, repo string, number int, milestone *Milestone) (*Milestone, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.Get">func (s *IssuesService) Get(owner string, repo string, number int) (*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.GetComment">func (s *IssuesService) GetComment(owner string, repo string, id int) (*IssueComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.GetEvent">func (s *IssuesService) GetEvent(owner, repo string, id int) (*IssueEvent, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.GetLabel">func (s *IssuesService) GetLabel(owner string, repo string, name string) (*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.GetMilestone">func (s *IssuesService) GetMilestone(owner string, repo string, number int) (*Milestone, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.IsAssignee">func (s *IssuesService) IsAssignee(owner, repo, user string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.List">func (s *IssuesService) List(all bool, opt *IssueListOptions) ([]*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListAssignees">func (s *IssuesService) ListAssignees(owner, repo string, opt *ListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListByOrg">func (s *IssuesService) ListByOrg(org string, opt *IssueListOptions) ([]*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListByRepo">func (s *IssuesService) ListByRepo(owner string, repo string, opt *IssueListByRepoOptions) ([]*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListComments">func (s *IssuesService) ListComments(owner string, repo string, number int, opt *IssueListCommentsOptions) ([]*IssueComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListIssueEvents">func (s *IssuesService) ListIssueEvents(owner, repo string, number int, opt *ListOptions) ([]*IssueEvent, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListIssueTimeline">func (s *IssuesService) ListIssueTimeline(owner, repo string, number int, opt *ListOptions) ([]*Timeline, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListLabels">func (s *IssuesService) ListLabels(owner string, repo string, opt *ListOptions) ([]*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListLabelsByIssue">func (s *IssuesService) ListLabelsByIssue(owner string, repo string, number int, opt *ListOptions) ([]*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListLabelsForMilestone">func (s *IssuesService) ListLabelsForMilestone(owner string, repo string, number int, opt *ListOptions) ([]*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListMilestones">func (s *IssuesService) ListMilestones(owner string, repo string, opt *MilestoneListOptions) ([]*Milestone, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ListRepositoryEvents">func (s *IssuesService) ListRepositoryEvents(owner, repo string, opt *ListOptions) ([]*IssueEvent, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.Lock">func (s *IssuesService) Lock(owner string, repo string, number int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.RemoveAssignees">func (s *IssuesService) RemoveAssignees(owner, repo string, number int, assignees []string) (*Issue, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.RemoveLabelForIssue">func (s *IssuesService) RemoveLabelForIssue(owner string, repo string, number int, label string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.RemoveLabelsForIssue">func (s *IssuesService) RemoveLabelsForIssue(owner string, repo string, number int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.ReplaceLabelsForIssue">func (s *IssuesService) ReplaceLabelsForIssue(owner string, repo string, number int, labels []string) ([]*Label, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#IssuesService.Unlock">func (s *IssuesService) Unlock(owner string, repo string, number int) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Key">type Key</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Key.String">func (k Key) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Label">type Label</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Label.String">func (l Label) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#LargeFile">type LargeFile</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#LargeFile.String">func (f LargeFile) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#License">type License</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#License.String">func (l License) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#LicensesService">type LicensesService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#LicensesService.Get">func (s *LicensesService) Get(licenseName string) (*License, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#LicensesService.List">func (s *LicensesService) List() ([]*License, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#ListContributorsOptions">type ListContributorsOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ListMembersOptions">type ListMembersOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ListOptions">type ListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ListOrgMembershipsOptions">type ListOrgMembershipsOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#MarkdownOptions">type MarkdownOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Match">type Match</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#MemberEvent">type MemberEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Membership">type Membership</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Membership.String">func (m Membership) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#MembershipEvent">type MembershipEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Migration">type Migration</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Migration.String">func (m Migration) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#MigrationOptions">type MigrationOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#MigrationService">type MigrationService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.CancelImport">func (s *MigrationService) CancelImport(owner, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.CommitAuthors">func (s *MigrationService) CommitAuthors(owner, repo string) ([]*SourceImportAuthor, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.DeleteMigration">func (s *MigrationService) DeleteMigration(org string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.ImportProgress">func (s *MigrationService) ImportProgress(owner, repo string) (*Import, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.LargeFiles">func (s *MigrationService) LargeFiles(owner, repo string) ([]*LargeFile, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.ListMigrations">func (s *MigrationService) ListMigrations(org string) ([]*Migration, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.MapCommitAuthor">func (s *MigrationService) MapCommitAuthor(owner, repo string, id int, author *SourceImportAuthor) (*SourceImportAuthor, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.MigrationArchiveURL">func (s *MigrationService) MigrationArchiveURL(org string, id int) (url string, err error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.MigrationStatus">func (s *MigrationService) MigrationStatus(org string, id int) (*Migration, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.SetLFSPreference">func (s *MigrationService) SetLFSPreference(owner, repo string, in *Import) (*Import, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.StartImport">func (s *MigrationService) StartImport(owner, repo string, in *Import) (*Import, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.StartMigration">func (s *MigrationService) StartMigration(org string, repos []string, opt *MigrationOptions) (*Migration, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.UnlockRepo">func (s *MigrationService) UnlockRepo(org string, id int, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#MigrationService.UpdateImport">func (s *MigrationService) UpdateImport(owner, repo string, in *Import) (*Import, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Milestone">type Milestone</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Milestone.String">func (m Milestone) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#MilestoneListOptions">type MilestoneListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#NewPullRequest">type NewPullRequest</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Notification">type Notification</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#NotificationListOptions">type NotificationListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#NotificationSubject">type NotificationSubject</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Organization">type Organization</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Organization.String">func (o Organization) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#OrganizationAddTeamMembershipOptions">type OrganizationAddTeamMembershipOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#OrganizationAddTeamRepoOptions">type OrganizationAddTeamRepoOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#OrganizationListTeamMembersOptions">type OrganizationListTeamMembersOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#OrganizationsListOptions">type OrganizationsListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#OrganizationsService">type OrganizationsService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.AddTeamMembership">func (s *OrganizationsService) AddTeamMembership(team int, user string, opt *OrganizationAddTeamMembershipOptions) (*Membership, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.AddTeamRepo">func (s *OrganizationsService) AddTeamRepo(team int, owner string, repo string, opt *OrganizationAddTeamRepoOptions) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ConcealMembership">func (s *OrganizationsService) ConcealMembership(org, user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.CreateHook">func (s *OrganizationsService) CreateHook(org string, hook *Hook) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.CreateTeam">func (s *OrganizationsService) CreateTeam(org string, team *Team) (*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.DeleteHook">func (s *OrganizationsService) DeleteHook(org string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.DeleteTeam">func (s *OrganizationsService) DeleteTeam(team int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.Edit">func (s *OrganizationsService) Edit(name string, org *Organization) (*Organization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.EditHook">func (s *OrganizationsService) EditHook(org string, id int, hook *Hook) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.EditOrgMembership">func (s *OrganizationsService) EditOrgMembership(user, org string, membership *Membership) (*Membership, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.EditTeam">func (s *OrganizationsService) EditTeam(id int, team *Team) (*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.Get">func (s *OrganizationsService) Get(org string) (*Organization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.GetHook">func (s *OrganizationsService) GetHook(org string, id int) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.GetOrgMembership">func (s *OrganizationsService) GetOrgMembership(user, org string) (*Membership, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.GetTeam">func (s *OrganizationsService) GetTeam(team int) (*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.GetTeamMembership">func (s *OrganizationsService) GetTeamMembership(team int, user string) (*Membership, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.IsMember">func (s *OrganizationsService) IsMember(org, user string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.IsPublicMember">func (s *OrganizationsService) IsPublicMember(org, user string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.IsTeamMember">func (s *OrganizationsService) IsTeamMember(team int, user string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.IsTeamRepo">func (s *OrganizationsService) IsTeamRepo(team int, owner string, repo string) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.List">func (s *OrganizationsService) List(user string, opt *ListOptions) ([]*Organization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListAll">func (s *OrganizationsService) ListAll(opt *OrganizationsListOptions) ([]*Organization, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListHooks">func (s *OrganizationsService) ListHooks(org string, opt *ListOptions) ([]*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListMembers">func (s *OrganizationsService) ListMembers(org string, opt *ListMembersOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListOrgMemberships">func (s *OrganizationsService) ListOrgMemberships(opt *ListOrgMembershipsOptions) ([]*Membership, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListTeamMembers">func (s *OrganizationsService) ListTeamMembers(team int, opt *OrganizationListTeamMembersOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListTeamRepos">func (s *OrganizationsService) ListTeamRepos(team int, opt *ListOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListTeams">func (s *OrganizationsService) ListTeams(org string, opt *ListOptions) ([]*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.ListUserTeams">func (s *OrganizationsService) ListUserTeams(opt *ListOptions) ([]*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.PingHook">func (s *OrganizationsService) PingHook(org string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.PublicizeMembership">func (s *OrganizationsService) PublicizeMembership(org, user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.RemoveMember">func (s *OrganizationsService) RemoveMember(org, user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.RemoveOrgMembership">func (s *OrganizationsService) RemoveOrgMembership(user, org string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.RemoveTeamMembership">func (s *OrganizationsService) RemoveTeamMembership(team int, user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#OrganizationsService.RemoveTeamRepo">func (s *OrganizationsService) RemoveTeamRepo(team int, owner string, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Page">type Page</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PageBuildEvent">type PageBuildEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Pages">type Pages</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PagesBuild">type PagesBuild</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PagesError">type PagesError</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Plan">type Plan</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Plan.String">func (p Plan) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Protection">type Protection</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PublicEvent">type PublicEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequest">type PullRequest</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#PullRequest.String">func (p PullRequest) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestBranch">type PullRequestBranch</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestComment">type PullRequestComment</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestComment.String">func (p PullRequestComment) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestEvent">type PullRequestEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestLinks">type PullRequestLinks</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestListCommentsOptions">type PullRequestListCommentsOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestListOptions">type PullRequestListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestMergeResult">type PullRequestMergeResult</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestOptions">type PullRequestOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestReviewCommentEvent">type PullRequestReviewCommentEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PullRequestsService">type PullRequestsService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.Create">func (s *PullRequestsService) Create(owner string, repo string, pull *NewPullRequest) (*PullRequest, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.CreateComment">func (s *PullRequestsService) CreateComment(owner string, repo string, number int, comment *PullRequestComment) (*PullRequestComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.DeleteComment">func (s *PullRequestsService) DeleteComment(owner string, repo string, number int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.Edit">func (s *PullRequestsService) Edit(owner string, repo string, number int, pull *PullRequest) (*PullRequest, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.EditComment">func (s *PullRequestsService) EditComment(owner string, repo string, number int, comment *PullRequestComment) (*PullRequestComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.Get">func (s *PullRequestsService) Get(owner string, repo string, number int) (*PullRequest, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.GetComment">func (s *PullRequestsService) GetComment(owner string, repo string, number int) (*PullRequestComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.IsMerged">func (s *PullRequestsService) IsMerged(owner string, repo string, number int) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.List">func (s *PullRequestsService) List(owner string, repo string, opt *PullRequestListOptions) ([]*PullRequest, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.ListComments">func (s *PullRequestsService) ListComments(owner string, repo string, number int, opt *PullRequestListCommentsOptions) ([]*PullRequestComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.ListCommits">func (s *PullRequestsService) ListCommits(owner string, repo string, number int, opt *ListOptions) ([]*RepositoryCommit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.ListFiles">func (s *PullRequestsService) ListFiles(owner string, repo string, number int, opt *ListOptions) ([]*CommitFile, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#PullRequestsService.Merge">func (s *PullRequestsService) Merge(owner string, repo string, number int, commitMessage string, options *PullRequestOptions) (*PullRequestMergeResult, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#PunchCard">type PunchCard</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PushEvent">type PushEvent</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#PushEvent.String">func (p PushEvent) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#PushEventCommit">type PushEventCommit</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#PushEventCommit.String">func (p PushEventCommit) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#PushEventRepoOwner">type PushEventRepoOwner</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#PushEventRepository">type PushEventRepository</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Rate">type Rate</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Rate.String">func (r Rate) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RateLimitError">type RateLimitError</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RateLimitError.Error">func (r *RateLimitError) Error() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RateLimits">type RateLimits</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RateLimits.String">func (r RateLimits) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Reaction">type Reaction</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Reaction.String">func (r Reaction) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Reactions">type Reactions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ReactionsService">type ReactionsService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.CreateCommentReaction">func (s ReactionsService) CreateCommentReaction(owner, repo string, id int, content string) (*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.CreateIssueCommentReaction">func (s ReactionsService) CreateIssueCommentReaction(owner, repo string, id int, content string) (*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.CreateIssueReaction">func (s ReactionsService) CreateIssueReaction(owner, repo string, number int, content string) (*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.CreatePullRequestCommentReaction">func (s ReactionsService) CreatePullRequestCommentReaction(owner, repo string, id int, content string) (*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.DeleteReaction">func (s *ReactionsService) DeleteReaction(id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.ListCommentReactions">func (s *ReactionsService) ListCommentReactions(owner, repo string, id int, opt *ListOptions) ([]*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.ListIssueCommentReactions">func (s *ReactionsService) ListIssueCommentReactions(owner, repo string, id int, opt *ListOptions) ([]*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.ListIssueReactions">func (s *ReactionsService) ListIssueReactions(owner, repo string, number int, opt *ListOptions) ([]*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#ReactionsService.ListPullRequestCommentReactions">func (s *ReactionsService) ListPullRequestCommentReactions(owner, repo string, id int, opt *ListOptions) ([]*Reaction, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Reference">type Reference</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Reference.String">func (r Reference) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#ReferenceListOptions">type ReferenceListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#ReleaseAsset">type ReleaseAsset</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ReleaseAsset.String">func (r ReleaseAsset) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#ReleaseEvent">type ReleaseEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Rename">type Rename</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Rename.String">func (r Rename) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepoStatus">type RepoStatus</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepoStatus.String">func (r RepoStatus) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoriesSearchResult">type RepositoriesSearchResult</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoriesService">type RepositoriesService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.AddCollaborator">func (s *RepositoriesService) AddCollaborator(owner, repo, user string, opt *RepositoryAddCollaboratorOptions) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CompareCommits">func (s *RepositoriesService) CompareCommits(owner, repo string, base, head string) (*CommitsComparison, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.Create">func (s *RepositoriesService) Create(org string, repo *Repository) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateComment">func (s *RepositoriesService) CreateComment(owner, repo, sha string, comment *RepositoryComment) (*RepositoryComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateDeployment">func (s *RepositoriesService) CreateDeployment(owner, repo string, request *DeploymentRequest) (*Deployment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateDeploymentStatus">func (s *RepositoriesService) CreateDeploymentStatus(owner, repo string, deployment int, request *DeploymentStatusRequest) (*DeploymentStatus, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateFile">func (s *RepositoriesService) CreateFile(owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateFork">func (s *RepositoriesService) CreateFork(owner, repo string, opt *RepositoryCreateForkOptions) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateHook">func (s *RepositoriesService) CreateHook(owner, repo string, hook *Hook) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateKey">func (s *RepositoriesService) CreateKey(owner string, repo string, key *Key) (*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateRelease">func (s *RepositoriesService) CreateRelease(owner, repo string, release *RepositoryRelease) (*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.CreateStatus">func (s *RepositoriesService) CreateStatus(owner, repo, ref string, status *RepoStatus) (*RepoStatus, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.Delete">func (s *RepositoriesService) Delete(owner, repo string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteComment">func (s *RepositoriesService) DeleteComment(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteFile">func (s *RepositoriesService) DeleteFile(owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteHook">func (s *RepositoriesService) DeleteHook(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteInvitation">func (s *RepositoriesService) DeleteInvitation(repoID, invitationID int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteKey">func (s *RepositoriesService) DeleteKey(owner string, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteRelease">func (s *RepositoriesService) DeleteRelease(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DeleteReleaseAsset">func (s *RepositoriesService) DeleteReleaseAsset(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DownloadContents">func (s *RepositoriesService) DownloadContents(owner, repo, filepath string, opt *RepositoryContentGetOptions) (io.ReadCloser, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.DownloadReleaseAsset">func (s *RepositoriesService) DownloadReleaseAsset(owner, repo string, id int) (rc io.ReadCloser, redirectURL string, err error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.Edit">func (s *RepositoriesService) Edit(owner, repo string, repository *Repository) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.EditBranch">func (s *RepositoriesService) EditBranch(owner, repo, branchName string, branch *Branch) (*Branch, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.EditHook">func (s *RepositoriesService) EditHook(owner, repo string, id int, hook *Hook) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.EditKey">func (s *RepositoriesService) EditKey(owner string, repo string, id int, key *Key) (*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.EditRelease">func (s *RepositoriesService) EditRelease(owner, repo string, id int, release *RepositoryRelease) (*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.EditReleaseAsset">func (s *RepositoriesService) EditReleaseAsset(owner, repo string, id int, release *ReleaseAsset) (*ReleaseAsset, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.Get">func (s *RepositoriesService) Get(owner, repo string) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetArchiveLink">func (s *RepositoriesService) GetArchiveLink(owner, repo string, archiveformat archiveFormat, opt *RepositoryContentGetOptions) (*url.URL, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetBranch">func (s *RepositoriesService) GetBranch(owner, repo, branch string) (*Branch, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetByID">func (s *RepositoriesService) GetByID(id int) (*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetCombinedStatus">func (s *RepositoriesService) GetCombinedStatus(owner, repo, ref string, opt *ListOptions) (*CombinedStatus, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetComment">func (s *RepositoriesService) GetComment(owner, repo string, id int) (*RepositoryComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetCommit">func (s *RepositoriesService) GetCommit(owner, repo, sha string) (*RepositoryCommit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetCommitSHA1">func (s *RepositoriesService) GetCommitSHA1(owner, repo, ref, lastSHA string) (string, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetContents">func (s *RepositoriesService) GetContents(owner, repo, path string, opt *RepositoryContentGetOptions) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, resp *Response, err error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetHook">func (s *RepositoriesService) GetHook(owner, repo string, id int) (*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetKey">func (s *RepositoriesService) GetKey(owner string, repo string, id int) (*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetLatestPagesBuild">func (s *RepositoriesService) GetLatestPagesBuild(owner string, repo string) (*PagesBuild, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetLatestRelease">func (s *RepositoriesService) GetLatestRelease(owner, repo string) (*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetPagesInfo">func (s *RepositoriesService) GetPagesInfo(owner string, repo string) (*Pages, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetReadme">func (s *RepositoriesService) GetReadme(owner, repo string, opt *RepositoryContentGetOptions) (*RepositoryContent, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetRelease">func (s *RepositoriesService) GetRelease(owner, repo string, id int) (*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetReleaseAsset">func (s *RepositoriesService) GetReleaseAsset(owner, repo string, id int) (*ReleaseAsset, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.GetReleaseByTag">func (s *RepositoriesService) GetReleaseByTag(owner, repo, tag string) (*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.IsCollaborator">func (s *RepositoriesService) IsCollaborator(owner, repo, user string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.License">func (s *RepositoriesService) License(owner, repo string) (*License, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.List">func (s *RepositoriesService) List(user string, opt *RepositoryListOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListAll">func (s *RepositoriesService) ListAll(opt *RepositoryListAllOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListBranches">func (s *RepositoriesService) ListBranches(owner string, repo string, opt *ListOptions) ([]*Branch, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListByOrg">func (s *RepositoriesService) ListByOrg(org string, opt *RepositoryListByOrgOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListCodeFrequency">func (s *RepositoriesService) ListCodeFrequency(owner, repo string) ([]*WeeklyStats, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListCollaborators">func (s *RepositoriesService) ListCollaborators(owner, repo string, opt *ListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListComments">func (s *RepositoriesService) ListComments(owner, repo string, opt *ListOptions) ([]*RepositoryComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListCommitActivity">func (s *RepositoriesService) ListCommitActivity(owner, repo string) ([]*WeeklyCommitActivity, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListCommitComments">func (s *RepositoriesService) ListCommitComments(owner, repo, sha string, opt *ListOptions) ([]*RepositoryComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListCommits">func (s *RepositoriesService) ListCommits(owner, repo string, opt *CommitsListOptions) ([]*RepositoryCommit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListContributors">func (s *RepositoriesService) ListContributors(owner string, repository string, opt *ListContributorsOptions) ([]*Contributor, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListContributorsStats">func (s *RepositoriesService) ListContributorsStats(owner, repo string) ([]*ContributorStats, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListDeploymentStatuses">func (s *RepositoriesService) ListDeploymentStatuses(owner, repo string, deployment int, opt *ListOptions) ([]*DeploymentStatus, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListDeployments">func (s *RepositoriesService) ListDeployments(owner, repo string, opt *DeploymentsListOptions) ([]*Deployment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListForks">func (s *RepositoriesService) ListForks(owner, repo string, opt *RepositoryListForksOptions) ([]*Repository, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListHooks">func (s *RepositoriesService) ListHooks(owner, repo string, opt *ListOptions) ([]*Hook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListInvitations">func (s *RepositoriesService) ListInvitations(repoID int, opt *ListOptions) ([]*RepositoryInvitation, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListKeys">func (s *RepositoriesService) ListKeys(owner string, repo string, opt *ListOptions) ([]*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListLanguages">func (s *RepositoriesService) ListLanguages(owner string, repo string) (map[string]int, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListPagesBuilds">func (s *RepositoriesService) ListPagesBuilds(owner string, repo string) ([]*PagesBuild, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListParticipation">func (s *RepositoriesService) ListParticipation(owner, repo string) (*RepositoryParticipation, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListPunchCard">func (s *RepositoriesService) ListPunchCard(owner, repo string) ([]*PunchCard, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListReleaseAssets">func (s *RepositoriesService) ListReleaseAssets(owner, repo string, id int, opt *ListOptions) ([]*ReleaseAsset, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListReleases">func (s *RepositoriesService) ListReleases(owner, repo string, opt *ListOptions) ([]*RepositoryRelease, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListServiceHooks">func (s *RepositoriesService) ListServiceHooks() ([]*ServiceHook, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListStatuses">func (s *RepositoriesService) ListStatuses(owner, repo, ref string, opt *ListOptions) ([]*RepoStatus, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListTags">func (s *RepositoriesService) ListTags(owner string, repo string, opt *ListOptions) ([]*RepositoryTag, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.ListTeams">func (s *RepositoriesService) ListTeams(owner string, repo string, opt *ListOptions) ([]*Team, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.Merge">func (s *RepositoriesService) Merge(owner, repo string, request *RepositoryMergeRequest) (*RepositoryCommit, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.PingHook">func (s *RepositoriesService) PingHook(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.RemoveCollaborator">func (s *RepositoriesService) RemoveCollaborator(owner, repo, user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.RequestPageBuild">func (s *RepositoriesService) RequestPageBuild(owner string, repo string) (*PagesBuild, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.TestHook">func (s *RepositoriesService) TestHook(owner, repo string, id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.UpdateComment">func (s *RepositoriesService) UpdateComment(owner, repo string, id int, comment *RepositoryComment) (*RepositoryComment, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.UpdateFile">func (s *RepositoriesService) UpdateFile(owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.UpdateInvitation">func (s *RepositoriesService) UpdateInvitation(repoID, invitationID int, permissions string) (*RepositoryInvitation, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoriesService.UploadReleaseAsset">func (s *RepositoriesService) UploadReleaseAsset(owner, repo string, id int, opt *UploadOptions, file *os.File) (*ReleaseAsset, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Repository">type Repository</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Repository.String">func (r Repository) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryAddCollaboratorOptions">type RepositoryAddCollaboratorOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryComment">type RepositoryComment</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryComment.String">func (r RepositoryComment) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryCommit">type RepositoryCommit</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryCommit.String">func (r RepositoryCommit) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryContent">type RepositoryContent</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryContent.Decode">func (r *RepositoryContent) Decode() ([]byte, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryContent.GetContent">func (r *RepositoryContent) GetContent() (string, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryContent.String">func (r RepositoryContent) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryContentFileOptions">type RepositoryContentFileOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryContentGetOptions">type RepositoryContentGetOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryContentResponse">type RepositoryContentResponse</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryCreateForkOptions">type RepositoryCreateForkOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryEvent">type RepositoryEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryInvitation">type RepositoryInvitation</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryListAllOptions">type RepositoryListAllOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryListByOrgOptions">type RepositoryListByOrgOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryListForksOptions">type RepositoryListForksOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryListOptions">type RepositoryListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryMergeRequest">type RepositoryMergeRequest</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryParticipation">type RepositoryParticipation</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryParticipation.String">func (r RepositoryParticipation) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryRelease">type RepositoryRelease</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#RepositoryRelease.String">func (r RepositoryRelease) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#RepositoryTag">type RepositoryTag</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#RequiredStatusChecks">type RequiredStatusChecks</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Response">type Response</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Scope">type Scope</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#SearchOptions">type SearchOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#SearchService">type SearchService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#SearchService.Code">func (s *SearchService) Code(query string, opt *SearchOptions) (*CodeSearchResult, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#SearchService.Issues">func (s *SearchService) Issues(query string, opt *SearchOptions) (*IssuesSearchResult, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#SearchService.Repositories">func (s *SearchService) Repositories(query string, opt *SearchOptions) (*RepositoriesSearchResult, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#SearchService.Users">func (s *SearchService) Users(query string, opt *SearchOptions) (*UsersSearchResult, *Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#ServiceHook">type ServiceHook</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#ServiceHook.String">func (s *ServiceHook) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#SignatureVerification">type SignatureVerification</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Source">type Source</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#SourceImportAuthor">type SourceImportAuthor</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#SourceImportAuthor.String">func (a SourceImportAuthor) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Stargazer">type Stargazer</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#StarredRepository">type StarredRepository</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#StatusEvent">type StatusEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Subscription">type Subscription</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Tag">type Tag</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Team">type Team</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Team.String">func (t Team) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#TeamAddEvent">type TeamAddEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#TextMatch">type TextMatch</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#TextMatch.String">func (tm TextMatch) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Timeline">type Timeline</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Timestamp">type Timestamp</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Timestamp.Equal">func (t Timestamp) Equal(u Timestamp) bool</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Timestamp.String">func (t Timestamp) String() string</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#Timestamp.UnmarshalJSON">func (t *Timestamp) UnmarshalJSON(data []byte) (err error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#Tree">type Tree</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#Tree.String">func (t Tree) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#TreeEntry">type TreeEntry</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#TreeEntry.String">func (t TreeEntry) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#TwoFactorAuthError">type TwoFactorAuthError</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#TwoFactorAuthError.Error">func (r *TwoFactorAuthError) Error() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#UnauthenticatedRateLimitedTransport">type UnauthenticatedRateLimitedTransport</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#UnauthenticatedRateLimitedTransport.Client">func (t *UnauthenticatedRateLimitedTransport) Client() *http.Client</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UnauthenticatedRateLimitedTransport.RoundTrip">func (t *UnauthenticatedRateLimitedTransport) RoundTrip(req *http.Request) (*http.Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#UploadOptions">type UploadOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#User">type User</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#User.String">func (u User) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#UserEmail">type UserEmail</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#UserListOptions">type UserListOptions</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#UsersSearchResult">type UsersSearchResult</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#UsersService">type UsersService</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.AcceptInvitation">func (s *UsersService) AcceptInvitation(invitationID int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.AddEmails">func (s *UsersService) AddEmails(emails []string) ([]*UserEmail, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.CreateGPGKey">func (s *UsersService) CreateGPGKey(armoredPublicKey string) (*GPGKey, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.CreateKey">func (s *UsersService) CreateKey(key *Key) (*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.DeclineInvitation">func (s *UsersService) DeclineInvitation(invitationID int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.DeleteEmails">func (s *UsersService) DeleteEmails(emails []string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.DeleteGPGKey">func (s *UsersService) DeleteGPGKey(id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.DeleteKey">func (s *UsersService) DeleteKey(id int) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.DemoteSiteAdmin">func (s *UsersService) DemoteSiteAdmin(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Edit">func (s *UsersService) Edit(user *User) (*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Follow">func (s *UsersService) Follow(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Get">func (s *UsersService) Get(user string) (*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.GetByID">func (s *UsersService) GetByID(id int) (*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.GetGPGKey">func (s *UsersService) GetGPGKey(id int) (*GPGKey, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.GetKey">func (s *UsersService) GetKey(id int) (*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.IsFollowing">func (s *UsersService) IsFollowing(user, target string) (bool, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListAll">func (s *UsersService) ListAll(opt *UserListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListEmails">func (s *UsersService) ListEmails(opt *ListOptions) ([]*UserEmail, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListFollowers">func (s *UsersService) ListFollowers(user string, opt *ListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListFollowing">func (s *UsersService) ListFollowing(user string, opt *ListOptions) ([]*User, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListGPGKeys">func (s *UsersService) ListGPGKeys() ([]*GPGKey, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListInvitations">func (s *UsersService) ListInvitations() ([]*RepositoryInvitation, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.ListKeys">func (s *UsersService) ListKeys(user string, opt *ListOptions) ([]*Key, *Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.PromoteSiteAdmin">func (s *UsersService) PromoteSiteAdmin(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Suspend">func (s *UsersService) Suspend(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Unfollow">func (s *UsersService) Unfollow(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
<dd> <a href="index.html#UsersService.Unsuspend">func (s *UsersService) Unsuspend(user string) (*Response, error)</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#WatchEvent">type WatchEvent</a></dd>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#WebHookAuthor">type WebHookAuthor</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#WebHookAuthor.String">func (w WebHookAuthor) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#WebHookCommit">type WebHookCommit</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#WebHookCommit.String">func (w WebHookCommit) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#WebHookPayload">type WebHookPayload</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#WebHookPayload.String">func (w WebHookPayload) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#WeeklyCommitActivity">type WeeklyCommitActivity</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#WeeklyCommitActivity.String">func (w WeeklyCommitActivity) String() string</a></dd>
|
|
|
|
|
|
|
|
<dd><a href="index.html#WeeklyStats">type WeeklyStats</a></dd>
|
|
|
|
|
|
|
|
<dd> <a href="index.html#WeeklyStats.String">func (w WeeklyStats) String() string</a></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
</div><!-- #manual-nav -->
|
|
|
|
|
|
<div id="pkg-examples">
|
|
<h4>Examples</h4>
|
|
<dl>
|
|
|
|
<dd><a class="exampleLink" href="index.html#example_Client_Markdown">Client.Markdown</a></dd>
|
|
|
|
<dd><a class="exampleLink" href="index.html#example_RepositoriesService_GetReadme">RepositoriesService.GetReadme</a></dd>
|
|
|
|
<dd><a class="exampleLink" href="index.html#example_RepositoriesService_List">RepositoriesService.List</a></dd>
|
|
|
|
<dd><a class="exampleLink" href="index.html#example_UsersService_ListAll">UsersService.ListAll</a></dd>
|
|
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
|
|
<h4>Package files</h4>
|
|
<p>
|
|
<span style="font-size:90%">
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/activity.go">activity.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go">activity_events.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go">activity_notifications.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go">activity_star.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go">activity_watching.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go">authorizations.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/doc.go">doc.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go">event_types.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go">gists.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go">gists_comments.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git.go">git.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git_blobs.go">git_blobs.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go">git_commits.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go">git_refs.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git_tags.go">git_tags.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go">git_trees.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/github.go">github.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go">gitignore.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go">issues.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_assignees.go">issues_assignees.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go">issues_comments.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go">issues_events.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go">issues_labels.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go">issues_milestones.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/issues_timeline.go">issues_timeline.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go">licenses.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/messages.go">messages.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go">migrations.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go">migrations_source_import.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go">misc.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go">orgs.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go">orgs_hooks.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go">orgs_members.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go">orgs_teams.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go">pulls.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go">pulls_comments.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go">reactions.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go">repos.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go">repos_collaborators.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go">repos_comments.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go">repos_commits.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go">repos_contents.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go">repos_deployments.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_forks.go">repos_forks.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go">repos_hooks.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_invitations.go">repos_invitations.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go">repos_keys.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_merging.go">repos_merging.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go">repos_pages.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go">repos_releases.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go">repos_stats.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go">repos_statuses.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/search.go">search.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/strings.go">strings.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/timestamp.go">timestamp.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users.go">users.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users_administration.go">users_administration.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users_emails.go">users_emails.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go">users_followers.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go">users_gpg_keys.go</a>
|
|
|
|
<a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go">users_keys.go</a>
|
|
|
|
</span>
|
|
</p>
|
|
|
|
</div><!-- .expanded -->
|
|
</div><!-- #pkg-index -->
|
|
|
|
<div id="pkg-callgraph" class="toggle" style="display: none">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
|
|
</div> <!-- .expanded -->
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
|
|
<p>
|
|
In the call graph viewer below, each node
|
|
is a function belonging to this package
|
|
and its children are the functions it
|
|
calls—perhaps dynamically.
|
|
</p>
|
|
<p>
|
|
The root nodes are the entry points of the
|
|
package: functions that may be called from
|
|
outside the package.
|
|
There may be non-exported or anonymous
|
|
functions among them if they are called
|
|
dynamically from another package.
|
|
</p>
|
|
<p>
|
|
Click a node to visit that function's source code.
|
|
From there you can visit its callers by
|
|
clicking its declaring <code>func</code>
|
|
token.
|
|
</p>
|
|
<p>
|
|
Functions may be omitted if they were
|
|
determined to be unreachable in the
|
|
particular programs or tests that were
|
|
analyzed.
|
|
</p>
|
|
<!-- Zero means show all package entry points. -->
|
|
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
|
|
</div>
|
|
</div> <!-- #pkg-callgraph -->
|
|
|
|
|
|
<h2 id="pkg-constants">Constants</h2>
|
|
|
|
<pre>const (
|
|
<span class="comment">// Tarball specifies an archive in gzipped tar format.</span>
|
|
<span id="Tarball">Tarball</span> archiveFormat = "tarball"
|
|
|
|
<span class="comment">// Zipball specifies an archive in zip format.</span>
|
|
<span id="Zipball">Zipball</span> archiveFormat = "zipball"
|
|
)</pre>
|
|
|
|
|
|
<pre>const (
|
|
<span class="comment">// StatusUnprocessableEntity is the status code returned when sending a request with invalid fields.</span>
|
|
<span id="StatusUnprocessableEntity">StatusUnprocessableEntity</span> = 422
|
|
)</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Bool">func <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=26229:26252#L789">Bool</a></h2>
|
|
<pre>func Bool(v <a href="../../../../builtin/index.html#bool">bool</a>) *<a href="../../../../builtin/index.html#bool">bool</a></pre>
|
|
<p>
|
|
Bool is a helper routine that allocates a new bool value
|
|
to store v and returns a pointer to it.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CheckResponse">func <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=18327:18369#L533">CheckResponse</a></h2>
|
|
<pre>func CheckResponse(r *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>) <a href="../../../../builtin/index.html#error">error</a></pre>
|
|
<p>
|
|
CheckResponse checks the API response for errors, and returns them if
|
|
present. A response is considered an error if it has a status code outside
|
|
the 200 range. API error responses are expected to have either no response
|
|
body, or a JSON response body that maps to ErrorResponse. Any other
|
|
response body will be silently ignored.
|
|
</p>
|
|
<p>
|
|
The error type will be *RateLimitError for rate limit exceeded errors,
|
|
and *TwoFactorAuthError for two-factor authentication errors.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Int">func <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=26369:26389#L793">Int</a></h2>
|
|
<pre>func Int(v <a href="../../../../builtin/index.html#int">int</a>) *<a href="../../../../builtin/index.html#int">int</a></pre>
|
|
<p>
|
|
Int is a helper routine that allocates a new int value
|
|
to store v and returns a pointer to it.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="String">func <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=26512:26541#L797">String</a></h2>
|
|
<pre>func String(v <a href="../../../../builtin/index.html#string">string</a>) *<a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
String is a helper routine that allocates a new string value
|
|
to store v and returns a pointer to it.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Stringify">func <a href="http://localhost:6060/src/github.com/google/go-github/github/strings.go?s=481:523#L11">Stringify</a></h2>
|
|
<pre>func Stringify(message interface{}) <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
Stringify attempts to create a reasonable string representation of types in
|
|
the GitHub library. It does things like resolve pointers to their values
|
|
and omits struct fields with nil values.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ValidatePayload">func <a href="http://localhost:6060/src/github.com/google/go-github/github/messages.go?s=2597:2680#L81">ValidatePayload</a></h2>
|
|
<pre>func ValidatePayload(r *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>, secretKey []<a href="../../../../builtin/index.html#byte">byte</a>) (payload []<a href="../../../../builtin/index.html#byte">byte</a>, err <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ValidatePayload validates an incoming GitHub Webhook event request
|
|
and returns the (JSON) payload.
|
|
secretKey is the GitHub Webhook secret message.
|
|
</p>
|
|
<p>
|
|
Example usage:
|
|
</p>
|
|
<pre>func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
payload, err := github.ValidatePayload(r, s.webhookSecretKey)
|
|
if err != nil { ... }
|
|
// Process payload...
|
|
}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="APIMeta">type <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=2157:3044#L76">APIMeta</a></h2>
|
|
<pre>type APIMeta struct {
|
|
<span class="comment">// An Array of IP addresses in CIDR format specifying the addresses</span>
|
|
<span class="comment">// that incoming service hooks will originate from on GitHub.com.</span>
|
|
Hooks []<a href="../../../../builtin/index.html#string">string</a> `json:"hooks,omitempty"`
|
|
|
|
<span class="comment">// An Array of IP addresses in CIDR format specifying the Git servers</span>
|
|
<span class="comment">// for GitHub.com.</span>
|
|
Git []<a href="../../../../builtin/index.html#string">string</a> `json:"git,omitempty"`
|
|
|
|
<span class="comment">// Whether authentication with username and password is supported.</span>
|
|
<span class="comment">// (GitHub Enterprise instances using CAS or OAuth for authentication</span>
|
|
<span class="comment">// will return false. Features like Basic Authentication with a</span>
|
|
<span class="comment">// username and password, sudo mode, and two-factor authentication are</span>
|
|
<span class="comment">// not supported on these servers.)</span>
|
|
VerifiablePasswordAuthentication *<a href="../../../../builtin/index.html#bool">bool</a> `json:"verifiable_password_authentication,omitempty"`
|
|
|
|
<span class="comment">// An array of IP addresses in CIDR format specifying the addresses</span>
|
|
<span class="comment">// which serve GitHub Pages websites.</span>
|
|
Pages []<a href="../../../../builtin/index.html#string">string</a> `json:"pages,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
APIMeta represents metadata about the GitHub API.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ActivityListStarredOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=1453:1871#L41">ActivityListStarredOptions</a></h2>
|
|
<pre>type ActivityListStarredOptions struct {
|
|
<span class="comment">// How to sort the repository list. Possible values are: created, updated,</span>
|
|
<span class="comment">// pushed, full_name. Default is "full_name".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort repositories. Possible values are: asc, desc.</span>
|
|
<span class="comment">// Default is "asc" when sort is "full_name", otherwise default is "desc".</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
ActivityListStarredOptions specifies the optional parameters to the
|
|
ActivityService.ListStarred method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ActivityService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity.go?s=347:375#L2">ActivityService</a></h2>
|
|
<pre>type ActivityService service</pre>
|
|
<p>
|
|
ActivityService handles communication with the activity related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/">http://developer.github.com/v3/activity/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.DeleteRepositorySubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=3820:3913#L118">DeleteRepositorySubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) DeleteRepositorySubscription(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteRepositorySubscription deletes the subscription for the specified
|
|
repository for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription">https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.DeleteThreadSubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=6483:6563#L204">DeleteThreadSubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) DeleteThreadSubscription(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteThreadSubscription deletes the subscription for the specified thread
|
|
for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription">https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.GetRepositorySubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=2469:2574#L74">GetRepositorySubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) GetRepositorySubscription(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Subscription">Subscription</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetRepositorySubscription returns the subscription for the specified
|
|
repository for the authenticated user. If the authenticated user is not
|
|
watching the repository, a nil Subscription is returned.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/watching/#get-a-repository-subscription">https://developer.github.com/v3/activity/watching/#get-a-repository-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.GetThread">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=4266:4346#L127">GetThread</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) GetThread(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Notification">Notification</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetThread gets the specified notification thread.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#view-a-single-thread">https://developer.github.com/v3/activity/notifications/#view-a-single-thread</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.GetThreadSubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=5253:5345#L162">GetThreadSubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) GetThreadSubscription(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Subscription">Subscription</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetThreadSubscription checks to see if the authenticated user is subscribed
|
|
to a thread.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription">https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.IsStarred">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=2977:3057#L89">IsStarred</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) IsStarred(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsStarred checks if a repository is starred by authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository">https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListEvents">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=2434:2517#L78">ListEvents</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListEvents(opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEvents drinks from the firehose of all public events across GitHub.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-public-events">http://developer.github.com/v3/activity/events/#list-public-events</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListEventsForOrganization">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=4979:5089#L173">ListEventsForOrganization</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListEventsForOrganization(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEventsForOrganization lists public events for an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization">http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListEventsForRepoNetwork">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=4318:4435#L149">ListEventsForRepoNetwork</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListEventsForRepoNetwork(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEventsForRepoNetwork lists public events for a network of repositories.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories">http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListEventsPerformedByUser">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=5671:5799#L198">ListEventsPerformedByUser</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListEventsPerformedByUser(user <a href="../../../../builtin/index.html#string">string</a>, publicOnly <a href="../../../../builtin/index.html#bool">bool</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEventsPerformedByUser lists the events performed by a user. If publicOnly is
|
|
true, only public events will be returned.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user">http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListEventsReceivedByUser">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=6480:6607#L228">ListEventsReceivedByUser</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListEventsReceivedByUser(user <a href="../../../../builtin/index.html#string">string</a>, publicOnly <a href="../../../../builtin/index.html#bool">bool</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEventsReceivedByUser lists the events received by a user. If publicOnly is
|
|
true, only public events will be returned.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received">http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListFeeds">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity.go?s=2520:2584#L44">ListFeeds</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListFeeds() (*<a href="index.html#Feeds">Feeds</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListFeeds lists all the feeds available to the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub provides several timeline resources in Atom format:
|
|
</p>
|
|
<pre>Timeline: The GitHub global public timeline
|
|
User: The public timeline for any user, using URI template
|
|
Current user public: The public timeline for the authenticated user
|
|
Current user: The private timeline for the authenticated user
|
|
Current user actor: The private timeline for activity created by the
|
|
authenticated user
|
|
Current user organizations: The private timeline for the organizations
|
|
the authenticated user is a member of.
|
|
</pre>
|
|
<p>
|
|
Note: Private feeds are only returned when authenticating via Basic Auth
|
|
since current feed URIs use the older, non revocable auth tokens.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListIssueEventsForRepository">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=3630:3751#L125">ListIssueEventsForRepository</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListIssueEventsForRepository(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListIssueEventsForRepository lists issue events for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository">http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListNotifications">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=1759:1868#L42">ListNotifications</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListNotifications(opt *<a href="index.html#NotificationListOptions">NotificationListOptions</a>) ([]*<a href="index.html#Notification">Notification</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListNotifications lists all notifications for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#list-your-notifications">https://developer.github.com/v3/activity/notifications/#list-your-notifications</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListRepositoryEvents">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=2981:3094#L101">ListRepositoryEvents</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListRepositoryEvents(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListRepositoryEvents lists events for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-repository-events">http://developer.github.com/v3/activity/events/#list-repository-events</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListRepositoryNotifications">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=2462:2601#L67">ListRepositoryNotifications</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListRepositoryNotifications(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#NotificationListOptions">NotificationListOptions</a>) ([]*<a href="index.html#Notification">Notification</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListRepositoryNotifications lists all notifications in a given repository
|
|
for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository">https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListStargazers">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=731:842#L15">ListStargazers</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListStargazers(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Stargazer">Stargazer</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListStargazers lists people who have starred the specified repo.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/starring/#list-stargazers">https://developer.github.com/v3/activity/starring/#list-stargazers</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListStarred">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=2124:2248#L57">ListStarred</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListStarred(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ActivityListStarredOptions">ActivityListStarredOptions</a>) ([]*<a href="index.html#StarredRepository">StarredRepository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListStarred lists all the repos starred by a user. Passing the empty string
|
|
will list the starred repositories for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/starring/#list-repositories-being-starred">http://developer.github.com/v3/activity/starring/#list-repositories-being-starred</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListUserEventsForOrganization">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=7307:7427#L258">ListUserEventsForOrganization</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListUserEventsForOrganization(org, user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Event">Event</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListUserEventsForOrganization provides the user’s organization dashboard. You
|
|
must be authenticated as the user to view this.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/#list-events-for-an-organization">http://developer.github.com/v3/activity/events/#list-events-for-an-organization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListWatched">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=1618:1720#L43">ListWatched</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListWatched(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListWatched lists the repositories the specified user is watching. Passing
|
|
the empty string will fetch watched repos for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/watching/#list-repositories-being-watched">https://developer.github.com/v3/activity/watching/#list-repositories-being-watched</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.ListWatchers">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=885:989#L18">ListWatchers</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) ListWatchers(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListWatchers lists watchers of a particular repo.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="http://developer.github.com/v3/activity/watching/#list-watchers">http://developer.github.com/v3/activity/watching/#list-watchers</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.MarkNotificationsRead">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=3245:3331#L95">MarkNotificationsRead</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) MarkNotificationsRead(lastRead <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MarkNotificationsRead marks all notifications up to lastRead as read.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#mark-as-read">https://developer.github.com/v3/activity/notifications/#mark-as-read</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.MarkRepositoryNotificationsRead">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=3759:3875#L111">MarkRepositoryNotificationsRead</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) MarkRepositoryNotificationsRead(owner, repo <a href="../../../../builtin/index.html#string">string</a>, lastRead <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MarkRepositoryNotificationsRead marks all notifications up to lastRead in
|
|
the specified repository as read.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository">https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.MarkThreadRead">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=4807:4877#L147">MarkThreadRead</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) MarkThreadRead(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MarkThreadRead marks the specified thread as read.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read">https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.SetRepositorySubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=3166:3299#L97">SetRepositorySubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) SetRepositorySubscription(owner, repo <a href="../../../../builtin/index.html#string">string</a>, subscription *<a href="index.html#Subscription">Subscription</a>) (*<a href="index.html#Subscription">Subscription</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
SetRepositorySubscription sets the subscription for the specified repository
|
|
for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/watching/#set-a-repository-subscription">https://developer.github.com/v3/activity/watching/#set-a-repository-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.SetThreadSubscription">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=5845:5965#L183">SetThreadSubscription</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) SetThreadSubscription(id <a href="../../../../builtin/index.html#string">string</a>, subscription *<a href="index.html#Subscription">Subscription</a>) (*<a href="index.html#Subscription">Subscription</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
SetThreadSubscription sets the subscription for the specified thread for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription">https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.Star">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=3452:3521#L103">Star</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) Star(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Star a repository as the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/activity/starring/#star-a-repository">https://developer.github.com/v3/activity/starring/#star-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ActivityService.Unstar">func (*ActivityService) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=3840:3911#L115">Unstar</a></h3>
|
|
<pre>func (s *<a href="index.html#ActivityService">ActivityService</a>) Unstar(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Unstar a repository as the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/activity/starring/#unstar-a-repository">https://developer.github.com/v3/activity/starring/#unstar-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Authorization">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=1892:2755#L43">Authorization</a></h2>
|
|
<pre>type Authorization struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Scopes []<a href="index.html#Scope">Scope</a> `json:"scopes,omitempty"`
|
|
Token *<a href="../../../../builtin/index.html#string">string</a> `json:"token,omitempty"`
|
|
TokenLastEight *<a href="../../../../builtin/index.html#string">string</a> `json:"token_last_eight,omitempty"`
|
|
HashedToken *<a href="../../../../builtin/index.html#string">string</a> `json:"hashed_token,omitempty"`
|
|
App *<a href="index.html#AuthorizationApp">AuthorizationApp</a> `json:"app,omitempty"`
|
|
Note *<a href="../../../../builtin/index.html#string">string</a> `json:"note,omitempty"`
|
|
NoteURL *<a href="../../../../builtin/index.html#string">string</a> `json:"note_url,omitempty"`
|
|
UpdateAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
Fingerprint *<a href="../../../../builtin/index.html#string">string</a> `json:"fingerprint,omitempty"`
|
|
|
|
<span class="comment">// User is only populated by the Check and Reset methods.</span>
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Authorization represents an individual GitHub authorization.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Authorization.String">func (Authorization) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=2757:2795#L61">String</a></h3>
|
|
<pre>func (a <a href="index.html#Authorization">Authorization</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="AuthorizationApp">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=2913:3075#L66">AuthorizationApp</a></h2>
|
|
<pre>type AuthorizationApp struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
ClientID *<a href="../../../../builtin/index.html#string">string</a> `json:"client_id,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
AuthorizationApp represents an individual GitHub app (in the context of authorization).
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationApp.String">func (AuthorizationApp) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=3077:3118#L72">String</a></h3>
|
|
<pre>func (a <a href="index.html#AuthorizationApp">AuthorizationApp</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="AuthorizationRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=3711:4050#L91">AuthorizationRequest</a></h2>
|
|
<pre>type AuthorizationRequest struct {
|
|
Scopes []<a href="index.html#Scope">Scope</a> `json:"scopes,omitempty"`
|
|
Note *<a href="../../../../builtin/index.html#string">string</a> `json:"note,omitempty"`
|
|
NoteURL *<a href="../../../../builtin/index.html#string">string</a> `json:"note_url,omitempty"`
|
|
ClientID *<a href="../../../../builtin/index.html#string">string</a> `json:"client_id,omitempty"`
|
|
ClientSecret *<a href="../../../../builtin/index.html#string">string</a> `json:"client_secret,omitempty"`
|
|
Fingerprint *<a href="../../../../builtin/index.html#string">string</a> `json:"fingerprint,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
AuthorizationRequest represents a request to create an authorization.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationRequest.String">func (AuthorizationRequest) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=4052:4097#L100">String</a></h3>
|
|
<pre>func (a <a href="index.html#AuthorizationRequest">AuthorizationRequest</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="AuthorizationUpdateRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=4488:4840#L111">AuthorizationUpdateRequest</a></h2>
|
|
<pre>type AuthorizationUpdateRequest struct {
|
|
Scopes []<a href="../../../../builtin/index.html#string">string</a> `json:"scopes,omitempty"`
|
|
AddScopes []<a href="../../../../builtin/index.html#string">string</a> `json:"add_scopes,omitempty"`
|
|
RemoveScopes []<a href="../../../../builtin/index.html#string">string</a> `json:"remove_scopes,omitempty"`
|
|
Note *<a href="../../../../builtin/index.html#string">string</a> `json:"note,omitempty"`
|
|
NoteURL *<a href="../../../../builtin/index.html#string">string</a> `json:"note_url,omitempty"`
|
|
Fingerprint *<a href="../../../../builtin/index.html#string">string</a> `json:"fingerprint,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
AuthorizationUpdateRequest represents a request to update an authorization.
|
|
</p>
|
|
<p>
|
|
Note that for any one update, you must only provide one of the "scopes"
|
|
fields. That is, you may provide only one of "Scopes", or "AddScopes", or
|
|
"RemoveScopes".
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization">https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationUpdateRequest.String">func (AuthorizationUpdateRequest) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=4842:4893#L120">String</a></h3>
|
|
<pre>func (a <a href="index.html#AuthorizationUpdateRequest">AuthorizationUpdateRequest</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="AuthorizationsService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=1792:1826#L40">AuthorizationsService</a></h2>
|
|
<pre>type AuthorizationsService service</pre>
|
|
<p>
|
|
AuthorizationsService handles communication with the authorization related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
This service requires HTTP Basic Authentication; it cannot be accessed using
|
|
an OAuth token.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/">https://developer.github.com/v3/oauth_authorizations/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Check">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=9165:9268#L264">Check</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Check(clientID <a href="../../../../builtin/index.html#string">string</a>, token <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Check if an OAuth token is valid for a specific app.
|
|
</p>
|
|
<p>
|
|
Note that this operation requires the use of BasicAuth, but where the
|
|
username is the OAuth application clientID, and the password is its
|
|
clientSecret. Invalid tokens will return a 404 Not Found.
|
|
</p>
|
|
<p>
|
|
The returned Authorization.User field will be populated.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#check-an-authorization">https://developer.github.com/v3/oauth_authorizations/#check-an-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Create">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=6153:6254#L169">Create</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Create(auth *<a href="index.html#AuthorizationRequest">AuthorizationRequest</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create a new authorization for the specified OAuth application.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.CreateImpersonation">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=13641:13775#L398">CreateImpersonation</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) CreateImpersonation(username <a href="../../../../builtin/index.html#string">string</a>, authReq *<a href="index.html#AuthorizationRequest">AuthorizationRequest</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create an impersonation OAuth token.
|
|
</p>
|
|
<p>
|
|
This requires admin permissions. With the returned Authorization.Token
|
|
you can e.g. create or delete a user's public SSH key. NOTE: creating a
|
|
new token automatically revokes an existing one.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#create-an-impersonation-oauth-token">https://developer.github.com/enterprise/2.5/v3/users/administration/#create-an-impersonation-oauth-token</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Delete">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=8503:8568#L244">Delete</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Delete(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Delete a single authorization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization">https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.DeleteGrant">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=12888:12958#L378">DeleteGrant</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) DeleteGrant(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteGrant deletes an OAuth application grant. Deleting an application's
|
|
grant will also delete all OAuth tokens associated with the application for
|
|
the user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#delete-a-grant">https://developer.github.com/v3/oauth_authorizations/#delete-a-grant</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.DeleteImpersonation">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=14276:14363#L418">DeleteImpersonation</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) DeleteImpersonation(username <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Delete an impersonation OAuth token.
|
|
</p>
|
|
<p>
|
|
NOTE: there can be only one at a time.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-an-impersonation-oauth-token">https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-an-impersonation-oauth-token</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Edit">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=7985:8098#L224">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Edit(id <a href="../../../../builtin/index.html#int">int</a>, auth *<a href="index.html#AuthorizationUpdateRequest">AuthorizationUpdateRequest</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit a single authorization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization">https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Get">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=5638:5716#L150">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Get(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get a single authorization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization">https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.GetGrant">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=12140:12215#L354">GetGrant</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) GetGrant(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Grant">Grant</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetGrant gets a single OAuth application grant.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant">https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.GetOrCreateForApp">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=7269:7398#L199">GetOrCreateForApp</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) GetOrCreateForApp(clientID <a href="../../../../builtin/index.html#string">string</a>, auth *<a href="index.html#AuthorizationRequest">AuthorizationRequest</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetOrCreateForApp creates a new authorization for the specified OAuth
|
|
application, only if an authorization for that application doesn’t already
|
|
exist for the user.
|
|
</p>
|
|
<p>
|
|
If a new token is created, the HTTP status code will be "201 Created", and
|
|
the returned Authorization.Token field will be populated. If an existing
|
|
token is returned, the status code will be "200 OK" and the
|
|
Authorization.Token field will be empty.
|
|
</p>
|
|
<p>
|
|
clientID is the OAuth Client ID with which to create the token.
|
|
</p>
|
|
<p>
|
|
GitHub API docs:
|
|
- <a href="https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app">https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app</a>
|
|
- <a href="https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint">https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.List">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=5077:5168#L127">List</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) List(opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List the authorizations for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations">https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.ListGrants">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=11532:11605#L333">ListGrants</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) ListGrants() ([]*<a href="index.html#Grant">Grant</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListGrants lists the set of OAuth applications that have been granted
|
|
access to a user's account. This will return one entry for each application
|
|
that has been granted access to the account, regardless of the number of
|
|
tokens an application has generated for the user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#list-your-grants">https://developer.github.com/v3/oauth_authorizations/#list-your-grants</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Reset">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=10111:10214#L292">Reset</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Reset(clientID <a href="../../../../builtin/index.html#string">string</a>, token <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Authorization">Authorization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Reset is used to reset a valid OAuth token without end user involvement.
|
|
Applications must save the "token" property in the response, because changes
|
|
take effect immediately.
|
|
</p>
|
|
<p>
|
|
Note that this operation requires the use of BasicAuth, but where the
|
|
username is the OAuth application clientID, and the password is its
|
|
clientSecret. Invalid tokens will return a 404 Not Found.
|
|
</p>
|
|
<p>
|
|
The returned Authorization.User field will be populated.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization">https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="AuthorizationsService.Revoke">func (*AuthorizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=10878:10966#L316">Revoke</a></h3>
|
|
<pre>func (s *<a href="index.html#AuthorizationsService">AuthorizationsService</a>) Revoke(clientID <a href="../../../../builtin/index.html#string">string</a>, token <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Revoke an authorization for an application.
|
|
</p>
|
|
<p>
|
|
Note that this operation requires the use of BasicAuth, but where the
|
|
username is the OAuth application clientID, and the password is its
|
|
clientSecret. Invalid tokens will return a 404 Not Found.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application">https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="BasicAuthTransport">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=24699:25041#L740">BasicAuthTransport</a></h2>
|
|
<pre>type BasicAuthTransport struct {
|
|
Username <a href="../../../../builtin/index.html#string">string</a> <span class="comment">// GitHub username</span>
|
|
Password <a href="../../../../builtin/index.html#string">string</a> <span class="comment">// GitHub password</span>
|
|
OTP <a href="../../../../builtin/index.html#string">string</a> <span class="comment">// one-time password for users with two-factor auth enabled</span>
|
|
|
|
<span class="comment">// Transport is the underlying HTTP transport to use when making requests.</span>
|
|
<span class="comment">// It will default to http.DefaultTransport if nil.</span>
|
|
Transport <a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#RoundTripper">RoundTripper</a>
|
|
}</pre>
|
|
<p>
|
|
BasicAuthTransport is an http.RoundTripper that authenticates all requests
|
|
using HTTP Basic Authentication with the provided username and password. It
|
|
additionally supports users who have two-factor authentication enabled on
|
|
their GitHub account.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="BasicAuthTransport.Client">func (*BasicAuthTransport) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=25481:25531#L762">Client</a></h3>
|
|
<pre>func (t *<a href="index.html#BasicAuthTransport">BasicAuthTransport</a>) Client() *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a></pre>
|
|
<p>
|
|
Client returns an *http.Client that makes requests that are authenticated
|
|
using HTTP Basic Authentication.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="BasicAuthTransport.RoundTrip">func (*BasicAuthTransport) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=25095:25176#L751">RoundTrip</a></h3>
|
|
<pre>func (t *<a href="index.html#BasicAuthTransport">BasicAuthTransport</a>) RoundTrip(req *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>) (*<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RoundTrip implements the RoundTripper interface.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Blob">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_blobs.go?s=234:469#L1">Blob</a></h2>
|
|
<pre>type Blob struct {
|
|
Content *<a href="../../../../builtin/index.html#string">string</a> `json:"content,omitempty"`
|
|
Encoding *<a href="../../../../builtin/index.html#string">string</a> `json:"encoding,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Blob represents a blob object.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Branch">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=16585:16759#L478">Branch</a></h2>
|
|
<pre>type Branch struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Commit *<a href="index.html#Commit">Commit</a> `json:"commit,omitempty"`
|
|
Protection *<a href="index.html#Protection">Protection</a> `json:"protection,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Branch represents a repository branch
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Client">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=3320:4666#L80">Client</a></h2>
|
|
<pre>type Client struct {
|
|
|
|
<span class="comment">// Base URL for API requests. Defaults to the public GitHub API, but can be</span>
|
|
<span class="comment">// set to a domain endpoint to use with GitHub Enterprise. BaseURL should</span>
|
|
<span class="comment">// always be specified with a trailing slash.</span>
|
|
BaseURL *<a href="../../../../net/url/index.html">url</a>.<a href="../../../../net/url/index.html#URL">URL</a>
|
|
|
|
<span class="comment">// Base URL for uploading files.</span>
|
|
UploadURL *<a href="../../../../net/url/index.html">url</a>.<a href="../../../../net/url/index.html#URL">URL</a>
|
|
|
|
<span class="comment">// User agent used when communicating with the GitHub API.</span>
|
|
UserAgent <a href="../../../../builtin/index.html#string">string</a>
|
|
|
|
<span class="comment">// Services used for talking to different parts of the GitHub API.</span>
|
|
Activity *<a href="index.html#ActivityService">ActivityService</a>
|
|
Authorizations *<a href="index.html#AuthorizationsService">AuthorizationsService</a>
|
|
Gists *<a href="index.html#GistsService">GistsService</a>
|
|
Git *<a href="index.html#GitService">GitService</a>
|
|
Gitignores *<a href="index.html#GitignoresService">GitignoresService</a>
|
|
Issues *<a href="index.html#IssuesService">IssuesService</a>
|
|
Organizations *<a href="index.html#OrganizationsService">OrganizationsService</a>
|
|
PullRequests *<a href="index.html#PullRequestsService">PullRequestsService</a>
|
|
Repositories *<a href="index.html#RepositoriesService">RepositoriesService</a>
|
|
Search *<a href="index.html#SearchService">SearchService</a>
|
|
Users *<a href="index.html#UsersService">UsersService</a>
|
|
Licenses *<a href="index.html#LicensesService">LicensesService</a>
|
|
Migrations *<a href="index.html#MigrationService">MigrationService</a>
|
|
Reactions *<a href="index.html#ReactionsService">ReactionsService</a>
|
|
<span class="comment">// contains filtered or unexported fields</span>
|
|
}</pre>
|
|
<p>
|
|
A Client manages communication with the GitHub API.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="NewClient">func <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=5954:6001#L163">NewClient</a></h3>
|
|
<pre>func NewClient(httpClient *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a>) *<a href="index.html#Client">Client</a></pre>
|
|
<p>
|
|
NewClient returns a new GitHub API client. If a nil httpClient is
|
|
provided, http.DefaultClient will be used. To use API methods which require
|
|
authentication, provide an http.Client that will perform the authentication
|
|
for you (such as that provided by the golang.org/x/oauth2 library).
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.APIMeta">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=3324:3379#L102">APIMeta</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) APIMeta() (*<a href="index.html#APIMeta">APIMeta</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
APIMeta returns information about GitHub.com, the service. Or, if you access
|
|
this endpoint on your organization’s GitHub Enterprise installation, this
|
|
endpoint provides information about that installation.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/meta/">https://developer.github.com/v3/meta/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.Do">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=11987:12059#L358">Do</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) Do(req *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>, v interface{}) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Do sends an API request and returns the API response. The API response is
|
|
JSON decoded and stored in the value pointed to by v, or returned as an
|
|
error if an API error has occurred. If v implements the io.Writer
|
|
interface, the raw response body will be written to v, without attempting to
|
|
first decode it. If rate limit is exceeded and reset time is in the future,
|
|
Do returns *RateLimitError immediately without making a network API call.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.ListEmojis">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=1808:1875#L60">ListEmojis</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) ListEmojis() (map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEmojis returns the emojis available to use on GitHub.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/emojis/">https://developer.github.com/v3/emojis/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.ListServiceHooks">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=5067:5137#L173">ListServiceHooks</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) ListServiceHooks() ([]*<a href="index.html#ServiceHook">ServiceHook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListServiceHooks lists all of the available service hooks.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/webhooks/#services">https://developer.github.com/webhooks/#services</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.Markdown">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=1161:1248#L32">Markdown</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) Markdown(text <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#MarkdownOptions">MarkdownOptions</a>) (<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Markdown renders an arbitrary Markdown document.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/markdown/">https://developer.github.com/v3/markdown/</a>
|
|
</p>
|
|
|
|
|
|
<div id="example_Client_Markdown" class="toggle">
|
|
<div class="collapsed">
|
|
<p class="exampleHeading toggleButton">▹ <span class="text">Example</span></p>
|
|
</div>
|
|
<div class="expanded">
|
|
<p class="exampleHeading toggleButton">▾ <span class="text">Example</span></p>
|
|
|
|
|
|
|
|
<p>Code:</p>
|
|
<pre class="code">
|
|
client := github.NewClient(nil)
|
|
|
|
input := "# heading #\n\nLink to issue #1"
|
|
opt := &github.MarkdownOptions{Mode: "gfm", Context: "google/go-github"}
|
|
|
|
output, _, err := client.Markdown(input, opt)
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
fmt.Println(output)
|
|
</pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.NewRequest">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=7234:7325#L194">NewRequest</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) NewRequest(method, urlStr <a href="../../../../builtin/index.html#string">string</a>, body interface{}) (*<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
NewRequest creates an API request. A relative URL can be provided in urlStr,
|
|
in which case it is resolved relative to the BaseURL of the Client.
|
|
Relative URLs should always be specified without a preceding slash. If
|
|
specified, the value pointed to by body is JSON encoded and included as the
|
|
request body.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.NewUploadRequest">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=8122:8241#L229">NewUploadRequest</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) NewUploadRequest(urlStr <a href="../../../../builtin/index.html#string">string</a>, reader <a href="../../../../io/index.html">io</a>.<a href="../../../../io/index.html#Reader">Reader</a>, size <a href="../../../../builtin/index.html#int64">int64</a>, mediaType <a href="../../../../builtin/index.html#string">string</a>) (*<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
NewUploadRequest creates an upload request. A relative URL can be provided in
|
|
urlStr, in which case it is resolved relative to the UploadURL of the Client.
|
|
Relative URLs should always be specified without a preceding slash.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.Octocat">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=3737:3804#L119">Octocat</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) Octocat(message <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Octocat returns an ASCII art octocat with the specified message in a speech
|
|
bubble. If message is empty, a random zen phrase is used.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.Rate">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=11408:11436#L345">Rate</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) Rate() <a href="index.html#Rate">Rate</a></pre>
|
|
<p>
|
|
Rate specifies the current rate limit for the client as determined by the
|
|
most recent API call. If the client is used in a multi-user application,
|
|
this rate may not always be up-to-date.
|
|
</p>
|
|
<p>
|
|
Deprecated: Use the Response.Rate returned from most recent API call instead.
|
|
Call RateLimits() to check the current rate.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.RateLimit">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=21427:21481#L632">RateLimit</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) RateLimit() (*<a href="index.html#Rate">Rate</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Deprecated: RateLimit is deprecated, use RateLimits instead.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.RateLimits">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=21664:21725#L642">RateLimits</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) RateLimits() (*<a href="index.html#RateLimits">RateLimits</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RateLimits returns the rate limits for the current client.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Client.Zen">func (*Client) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=4226:4275#L142">Zen</a></h3>
|
|
<pre>func (c *<a href="index.html#Client">Client</a>) Zen() (<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Zen returns a random line from The Zen of GitHub.
|
|
</p>
|
|
<p>
|
|
see also: <a href="http://warpspire.com/posts/taste/">http://warpspire.com/posts/taste/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CodeResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=3549:3886#L102">CodeResult</a></h2>
|
|
<pre>type CodeResult struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
Repository *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
TextMatches []<a href="index.html#TextMatch">TextMatch</a> `json:"text_matches,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CodeResult represents a single search result.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CodeResult.String">func (CodeResult) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=3888:3923#L111">String</a></h3>
|
|
<pre>func (c <a href="index.html#CodeResult">CodeResult</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CodeSearchResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=3358:3498#L96">CodeSearchResult</a></h2>
|
|
<pre>type CodeSearchResult struct {
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
CodeResults []<a href="index.html#CodeResult">CodeResult</a> `json:"items,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CodeSearchResult represents the result of an code search.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CombinedStatus">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=2695:3190#L77">CombinedStatus</a></h2>
|
|
<pre>type CombinedStatus struct {
|
|
<span class="comment">// State is the combined state of the repository. Possible values are:</span>
|
|
<span class="comment">// failure, pending, or success.</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
TotalCount *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
Statuses []<a href="index.html#RepoStatus">RepoStatus</a> `json:"statuses,omitempty"`
|
|
|
|
CommitURL *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_url,omitempty"`
|
|
RepositoryURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repository_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CombinedStatus represents the combined status of a repository at a particular reference.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CombinedStatus.String">func (CombinedStatus) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=3192:3231#L91">String</a></h3>
|
|
<pre>func (s <a href="index.html#CombinedStatus">CombinedStatus</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Commit">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=540:1372#L12">Commit</a></h2>
|
|
<pre>type Commit struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Author *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"author,omitempty"`
|
|
Committer *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"committer,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
Tree *<a href="index.html#Tree">Tree</a> `json:"tree,omitempty"`
|
|
Parents []<a href="index.html#Commit">Commit</a> `json:"parents,omitempty"`
|
|
Stats *<a href="index.html#CommitStats">CommitStats</a> `json:"stats,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Verification *<a href="index.html#SignatureVerification">SignatureVerification</a> `json:"verification,omitempty"`
|
|
|
|
<span class="comment">// CommentCount is the number of GitHub comments on the commit. This</span>
|
|
<span class="comment">// is only populated for requests that fetch GitHub data like</span>
|
|
<span class="comment">// Pulls.ListCommits, Repositories.ListCommits, etc.</span>
|
|
CommentCount *<a href="../../../../builtin/index.html#int">int</a> `json:"comment_count,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Commit represents a GitHub commit.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Commit.String">func (Commit) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=1374:1405#L29">String</a></h3>
|
|
<pre>func (c <a href="index.html#Commit">Commit</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitAuthor">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=1555:1855#L35">CommitAuthor</a></h2>
|
|
<pre>type CommitAuthor struct {
|
|
Date *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"date,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Login *<a href="../../../../builtin/index.html#string">string</a> `json:"username,omitempty"` <span class="comment">// Renamed for go-github consistency.</span>
|
|
}</pre>
|
|
<p>
|
|
CommitAuthor represents the author or committer of a commit. The commit
|
|
author may not correspond to a GitHub User.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CommitAuthor.String">func (CommitAuthor) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=1857:1894#L44">String</a></h3>
|
|
<pre>func (c <a href="index.html#CommitAuthor">CommitAuthor</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitCommentEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=481:776#L4">CommitCommentEvent</a></h2>
|
|
<pre>type CommitCommentEvent struct {
|
|
Comment *<a href="index.html#RepositoryComment">RepositoryComment</a> `json:"comment,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CommitCommentEvent is triggered when a commit comment is created.
|
|
The Webhook event name is "commit_comment".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#commitcommentevent">https://developer.github.com/v3/activity/events/types/#commitcommentevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitFile">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=1570:1916#L38">CommitFile</a></h2>
|
|
<pre>type CommitFile struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Filename *<a href="../../../../builtin/index.html#string">string</a> `json:"filename,omitempty"`
|
|
Additions *<a href="../../../../builtin/index.html#int">int</a> `json:"additions,omitempty"`
|
|
Deletions *<a href="../../../../builtin/index.html#int">int</a> `json:"deletions,omitempty"`
|
|
Changes *<a href="../../../../builtin/index.html#int">int</a> `json:"changes,omitempty"`
|
|
Status *<a href="../../../../builtin/index.html#string">string</a> `json:"status,omitempty"`
|
|
Patch *<a href="../../../../builtin/index.html#string">string</a> `json:"patch,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CommitFile represents a file modified in a commit.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CommitFile.String">func (CommitFile) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=1918:1953#L48">String</a></h3>
|
|
<pre>func (c <a href="index.html#CommitFile">CommitFile</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitStats">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=1293:1451#L27">CommitStats</a></h2>
|
|
<pre>type CommitStats struct {
|
|
Additions *<a href="../../../../builtin/index.html#int">int</a> `json:"additions,omitempty"`
|
|
Deletions *<a href="../../../../builtin/index.html#int">int</a> `json:"deletions,omitempty"`
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CommitStats.String">func (CommitStats) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=1453:1489#L33">String</a></h3>
|
|
<pre>func (c <a href="index.html#CommitStats">CommitStats</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitsComparison">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=2078:2592#L54">CommitsComparison</a></h2>
|
|
<pre>type CommitsComparison struct {
|
|
BaseCommit *<a href="index.html#RepositoryCommit">RepositoryCommit</a> `json:"base_commit,omitempty"`
|
|
MergeBaseCommit *<a href="index.html#RepositoryCommit">RepositoryCommit</a> `json:"merge_base_commit,omitempty"`
|
|
|
|
<span class="comment">// Head can be 'behind' or 'ahead'</span>
|
|
Status *<a href="../../../../builtin/index.html#string">string</a> `json:"status,omitempty"`
|
|
AheadBy *<a href="../../../../builtin/index.html#int">int</a> `json:"ahead_by,omitempty"`
|
|
BehindBy *<a href="../../../../builtin/index.html#int">int</a> `json:"behind_by,omitempty"`
|
|
TotalCommits *<a href="../../../../builtin/index.html#int">int</a> `json:"total_commits,omitempty"`
|
|
|
|
Commits []<a href="index.html#RepositoryCommit">RepositoryCommit</a> `json:"commits,omitempty"`
|
|
|
|
Files []<a href="index.html#CommitFile">CommitFile</a> `json:"files,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CommitsComparison is the result of comparing two commits.
|
|
See CompareCommits() for details.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="CommitsComparison.String">func (CommitsComparison) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=2594:2636#L69">String</a></h3>
|
|
<pre>func (c <a href="index.html#CommitsComparison">CommitsComparison</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CommitsListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=2769:3279#L75">CommitsListOptions</a></h2>
|
|
<pre>type CommitsListOptions struct {
|
|
<span class="comment">// SHA or branch to start listing Commits from.</span>
|
|
SHA <a href="../../../../builtin/index.html#string">string</a> `url:"sha,omitempty"`
|
|
|
|
<span class="comment">// Path that should be touched by the returned Commits.</span>
|
|
Path <a href="../../../../builtin/index.html#string">string</a> `url:"path,omitempty"`
|
|
|
|
<span class="comment">// Author of by which to filter Commits.</span>
|
|
Author <a href="../../../../builtin/index.html#string">string</a> `url:"author,omitempty"`
|
|
|
|
<span class="comment">// Since when should Commits be included in the response.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<span class="comment">// Until when should Commits be included in the response.</span>
|
|
Until <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"until,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
CommitsListOptions specifies the optional parameters to the
|
|
RepositoriesService.ListCommits method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Contributor">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=12353:13400#L341">Contributor</a></h2>
|
|
<pre>type Contributor struct {
|
|
Login *<a href="../../../../builtin/index.html#string">string</a> `json:"login,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
AvatarURL *<a href="../../../../builtin/index.html#string">string</a> `json:"avatar_url,omitempty"`
|
|
GravatarID *<a href="../../../../builtin/index.html#string">string</a> `json:"gravatar_id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
FollowersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"followers_url,omitempty"`
|
|
FollowingURL *<a href="../../../../builtin/index.html#string">string</a> `json:"following_url,omitempty"`
|
|
GistsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"gists_url,omitempty"`
|
|
StarredURL *<a href="../../../../builtin/index.html#string">string</a> `json:"starred_url,omitempty"`
|
|
SubscriptionsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"subscriptions_url,omitempty"`
|
|
OrganizationsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"organizations_url,omitempty"`
|
|
ReposURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repos_url,omitempty"`
|
|
EventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"events_url,omitempty"`
|
|
ReceivedEventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"received_events_url,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
SiteAdmin *<a href="../../../../builtin/index.html#bool">bool</a> `json:"site_admin"`
|
|
Contributions *<a href="../../../../builtin/index.html#int">int</a> `json:"contributions,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Contributor represents a repository contributor
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ContributorStats">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=325:499#L5">ContributorStats</a></h2>
|
|
<pre>type ContributorStats struct {
|
|
Author *<a href="index.html#Contributor">Contributor</a> `json:"author,omitempty"`
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total,omitempty"`
|
|
Weeks []<a href="index.html#WeeklyStats">WeeklyStats</a> `json:"weeks,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ContributorStats represents a contributor to a repository and their
|
|
weekly contributions to a given repo.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ContributorStats.String">func (ContributorStats) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=501:542#L11">String</a></h3>
|
|
<pre>func (c <a href="index.html#ContributorStats">ContributorStats</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="CreateEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=1152:1692#L21">CreateEvent</a></h2>
|
|
<pre>type CreateEvent struct {
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
<span class="comment">// RefType is the object that was created. Possible values are: "repository", "branch", "tag".</span>
|
|
RefType *<a href="../../../../builtin/index.html#string">string</a> `json:"ref_type,omitempty"`
|
|
MasterBranch *<a href="../../../../builtin/index.html#string">string</a> `json:"master_branch,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
PusherType *<a href="../../../../builtin/index.html#string">string</a> `json:"pusher_type,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
CreateEvent represents a created repository, branch, or tag.
|
|
The Webhook event name is "create".
|
|
</p>
|
|
<p>
|
|
Note: webhooks will not receive this event for created repositories.
|
|
Additionally, webhooks will not receive this event for tags if more
|
|
than three tags are pushed at once.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#createevent">https://developer.github.com/v3/activity/events/types/#createevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeleteEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=1976:2389#L41">DeleteEvent</a></h2>
|
|
<pre>type DeleteEvent struct {
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
<span class="comment">// RefType is the object that was deleted. Possible values are: "branch", "tag".</span>
|
|
RefType *<a href="../../../../builtin/index.html#string">string</a> `json:"ref_type,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
PusherType *<a href="../../../../builtin/index.html#string">string</a> `json:"pusher_type,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeleteEvent represents a deleted branch or tag.
|
|
The Webhook event name is "delete".
|
|
</p>
|
|
<p>
|
|
Note: webhooks will not receive this event for tags if more than three tags
|
|
are deleted at once.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#deleteevent">https://developer.github.com/v3/activity/events/types/#deleteevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Deployment">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=270:1055#L4">Deployment</a></h2>
|
|
<pre>type Deployment struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
Task *<a href="../../../../builtin/index.html#string">string</a> `json:"task,omitempty"`
|
|
Payload <a href="../../../../encoding/json/index.html">json</a>.<a href="../../../../encoding/json/index.html#RawMessage">RawMessage</a> `json:"payload,omitempty"`
|
|
Environment *<a href="../../../../builtin/index.html#string">string</a> `json:"environment,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Creator *<a href="index.html#User">User</a> `json:"creator,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"pushed_at,omitempty"`
|
|
StatusesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"statuses_url,omitempty"`
|
|
RepositoryURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repository_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Deployment represents a deployment in a repo
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=2661:2904#L58">DeploymentEvent</a></h2>
|
|
<pre>type DeploymentEvent struct {
|
|
Deployment *<a href="index.html#Deployment">Deployment</a> `json:"deployment,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeploymentEvent represents a deployment.
|
|
The Webhook event name is "deployment".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to trigger hooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#deploymentevent">https://developer.github.com/v3/activity/events/types/#deploymentevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=1110:1726#L21">DeploymentRequest</a></h2>
|
|
<pre>type DeploymentRequest struct {
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
Task *<a href="../../../../builtin/index.html#string">string</a> `json:"task,omitempty"`
|
|
AutoMerge *<a href="../../../../builtin/index.html#bool">bool</a> `json:"auto_merge,omitempty"`
|
|
RequiredContexts *[]<a href="../../../../builtin/index.html#string">string</a> `json:"required_contexts,omitempty"`
|
|
Payload *<a href="../../../../builtin/index.html#string">string</a> `json:"payload,omitempty"`
|
|
Environment *<a href="../../../../builtin/index.html#string">string</a> `json:"environment,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
TransientEnvironment *<a href="../../../../builtin/index.html#bool">bool</a> `json:"transient_environment,omitempty"`
|
|
ProductionEnvironment *<a href="../../../../builtin/index.html#bool">bool</a> `json:"production_environment,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeploymentRequest represents a deployment request
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentStatus">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=3644:4269#L100">DeploymentStatus</a></h2>
|
|
<pre>type DeploymentStatus struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
<span class="comment">// State is the deployment state.</span>
|
|
<span class="comment">// Possible values are: "pending", "success", "failure", "error", "inactive".</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Creator *<a href="index.html#User">User</a> `json:"creator,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
TargetURL *<a href="../../../../builtin/index.html#string">string</a> `json:"target_url,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"pushed_at,omitempty"`
|
|
DeploymentURL *<a href="../../../../builtin/index.html#string">string</a> `json:"deployment_url,omitempty"`
|
|
RepositoryURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repository_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeploymentStatus represents the status of a
|
|
particular deployment.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentStatusEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=3202:3548#L72">DeploymentStatusEvent</a></h2>
|
|
<pre>type DeploymentStatusEvent struct {
|
|
Deployment *<a href="index.html#Deployment">Deployment</a> `json:"deployment,omitempty"`
|
|
DeploymentStatus *<a href="index.html#DeploymentStatus">DeploymentStatus</a> `json:"deployment_status,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeploymentStatusEvent represents a deployment status.
|
|
The Webhook event name is "deployment_status".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to trigger hooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#deploymentstatusevent">https://developer.github.com/v3/activity/events/types/#deploymentstatusevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentStatusRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=4330:4729#L115">DeploymentStatusRequest</a></h2>
|
|
<pre>type DeploymentStatusRequest struct {
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
TargetURL *<a href="../../../../builtin/index.html#string">string</a> `json:"target_url,omitempty"` <span class="comment">// Deprecated. Use LogURL instead.</span>
|
|
LogURL *<a href="../../../../builtin/index.html#string">string</a> `json:"log_url,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
EnvironmentURL *<a href="../../../../builtin/index.html#string">string</a> `json:"environment_url,omitempty"`
|
|
AutoInactive *<a href="../../../../builtin/index.html#bool">bool</a> `json:"auto_inactive,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DeploymentStatusRequest represents a deployment request
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="DeploymentsListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=1842:2201#L35">DeploymentsListOptions</a></h2>
|
|
<pre>type DeploymentsListOptions struct {
|
|
<span class="comment">// SHA of the Deployment.</span>
|
|
SHA <a href="../../../../builtin/index.html#string">string</a> `url:"sha,omitempty"`
|
|
|
|
<span class="comment">// List deployments for a given ref.</span>
|
|
Ref <a href="../../../../builtin/index.html#string">string</a> `url:"ref,omitempty"`
|
|
|
|
<span class="comment">// List deployments for a given task.</span>
|
|
Task <a href="../../../../builtin/index.html#string">string</a> `url:"task,omitempty"`
|
|
|
|
<span class="comment">// List deployments for a given environment.</span>
|
|
Environment <a href="../../../../builtin/index.html#string">string</a> `url:"environment,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
DeploymentsListOptions specifies the optional parameters to the
|
|
RepositoriesService.ListDeployments method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="EditChange">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=5237:5429#L129">EditChange</a></h2>
|
|
<pre>type EditChange struct {
|
|
Title *struct {
|
|
From *<a href="../../../../builtin/index.html#string">string</a> `json:"from,omitempty"`
|
|
} `json:"title,omitempty"`
|
|
Body *struct {
|
|
From *<a href="../../../../builtin/index.html#string">string</a> `json:"from,omitempty"`
|
|
} `json:"body,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
EditChange represents the changes when an issue, pull request, or comment has
|
|
been edited.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Error">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=17352:17704#L513">Error</a></h2>
|
|
<pre>type Error struct {
|
|
Resource <a href="../../../../builtin/index.html#string">string</a> `json:"resource"` <span class="comment">// resource on which the error occurred</span>
|
|
Field <a href="../../../../builtin/index.html#string">string</a> `json:"field"` <span class="comment">// field on which the error occurred</span>
|
|
Code <a href="../../../../builtin/index.html#string">string</a> `json:"code"` <span class="comment">// validation error code</span>
|
|
Message <a href="../../../../builtin/index.html#string">string</a> `json:"message"` <span class="comment">// Message describing the error. Errors with Code == "custom" will always have this set.</span>
|
|
}</pre>
|
|
<p>
|
|
An Error reports more details on an individual error in an ErrorResponse.
|
|
These are the possible validation error codes:
|
|
</p>
|
|
<pre>missing:
|
|
resource does not exist
|
|
missing_field:
|
|
a required field on a resource has not been set
|
|
invalid:
|
|
the formatting of a field is invalid
|
|
already_exists:
|
|
another resource has the same valid as this field
|
|
custom:
|
|
some resources return this (e.g. github.User.CreateKey()), additional
|
|
information is set in the Message field of the Error
|
|
</pre>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/#client-errors">http://developer.github.com/v3/#client-errors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Error.Error">func (*Error) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=17706:17736#L520">Error</a></h3>
|
|
<pre>func (e *<a href="index.html#Error">Error</a>) Error() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ErrorResponse">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=14379:15195#L437">ErrorResponse</a></h2>
|
|
<pre>type ErrorResponse struct {
|
|
Response *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a> <span class="comment">// HTTP response that caused this error</span>
|
|
Message <a href="../../../../builtin/index.html#string">string</a> `json:"message"` <span class="comment">// error message</span>
|
|
Errors []<a href="index.html#Error">Error</a> `json:"errors"` <span class="comment">// more detail on individual errors</span>
|
|
<span class="comment">// Block is only populated on certain types of errors such as code 451.</span>
|
|
<span class="comment">// See https://developer.github.com/changes/2016-03-17-the-451-status-code-is-now-supported/</span>
|
|
<span class="comment">// for more information.</span>
|
|
Block *struct {
|
|
Reason <a href="../../../../builtin/index.html#string">string</a> `json:"reason,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
} `json:"block,omitempty"`
|
|
<span class="comment">// Most errors will also include a documentation_url field pointing</span>
|
|
<span class="comment">// to some content that might help you resolve the error, see</span>
|
|
<span class="comment">// https://developer.github.com/v3/#client-errors</span>
|
|
DocumentationURL <a href="../../../../builtin/index.html#string">string</a> `json:"documentation_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
An ErrorResponse reports one or more errors caused by an API request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/#client-errors">http://developer.github.com/v3/#client-errors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ErrorResponse.Error">func (*ErrorResponse) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=15197:15235#L454">Error</a></h3>
|
|
<pre>func (r *<a href="index.html#ErrorResponse">ErrorResponse</a>) Error() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Event">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=266:710#L5">Event</a></h2>
|
|
<pre>type Event struct {
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
Public *<a href="../../../../builtin/index.html#bool">bool</a> `json:"public"`
|
|
RawPayload *<a href="../../../../encoding/json/index.html">json</a>.<a href="../../../../encoding/json/index.html#RawMessage">RawMessage</a> `json:"payload,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repo,omitempty"`
|
|
Actor *<a href="index.html#User">User</a> `json:"actor,omitempty"`
|
|
Org *<a href="index.html#Organization">Organization</a> `json:"org,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Event represents a GitHub event.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Event.Payload">func (*Event) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=904:951#L22">Payload</a></h3>
|
|
<pre>func (e *<a href="index.html#Event">Event</a>) Payload() (payload interface{})</pre>
|
|
<p>
|
|
Payload returns the parsed event payload. For recognized event types,
|
|
a value of the corresponding struct type will be returned.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Event.String">func (Event) <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_events.go?s=712:742#L16">String</a></h3>
|
|
<pre>func (e <a href="index.html#Event">Event</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="FeedLink">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity.go?s=430:530#L5">FeedLink</a></h2>
|
|
<pre>type FeedLink struct {
|
|
HRef *<a href="../../../../builtin/index.html#string">string</a> `json:"href,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
FeedLink represents a link to a related resource.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Feeds">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity.go?s=587:1740#L11">Feeds</a></h2>
|
|
<pre>type Feeds struct {
|
|
TimelineURL *<a href="../../../../builtin/index.html#string">string</a> `json:"timeline_url,omitempty"`
|
|
UserURL *<a href="../../../../builtin/index.html#string">string</a> `json:"user_url,omitempty"`
|
|
CurrentUserPublicURL *<a href="../../../../builtin/index.html#string">string</a> `json:"current_user_public_url,omitempty"`
|
|
CurrentUserURL *<a href="../../../../builtin/index.html#string">string</a> `json:"current_user_url,omitempty"`
|
|
CurrentUserActorURL *<a href="../../../../builtin/index.html#string">string</a> `json:"current_user_actor_url,omitempty"`
|
|
CurrentUserOrganizationURL *<a href="../../../../builtin/index.html#string">string</a> `json:"current_user_organization_url,omitempty"`
|
|
CurrentUserOrganizationURLs []<a href="../../../../builtin/index.html#string">string</a> `json:"current_user_organization_urls,omitempty"`
|
|
Links *struct {
|
|
Timeline *<a href="index.html#FeedLink">FeedLink</a> `json:"timeline,omitempty"`
|
|
User *<a href="index.html#FeedLink">FeedLink</a> `json:"user,omitempty"`
|
|
CurrentUserPublic *<a href="index.html#FeedLink">FeedLink</a> `json:"current_user_public,omitempty"`
|
|
CurrentUser *<a href="index.html#FeedLink">FeedLink</a> `json:"current_user,omitempty"`
|
|
CurrentUserActor *<a href="index.html#FeedLink">FeedLink</a> `json:"current_user_actor,omitempty"`
|
|
CurrentUserOrganization *<a href="index.html#FeedLink">FeedLink</a> `json:"current_user_organization,omitempty"`
|
|
CurrentUserOrganizations []<a href="index.html#FeedLink">FeedLink</a> `json:"current_user_organizations,omitempty"`
|
|
} `json:"_links,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Feeds represents timeline resources in Atom format.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ForkEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=3729:3998#L85">ForkEvent</a></h2>
|
|
<pre>type ForkEvent struct {
|
|
<span class="comment">// Forkee is the created repository.</span>
|
|
Forkee *<a href="index.html#Repository">Repository</a> `json:"forkee,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ForkEvent is triggered when a user forks a repository.
|
|
The Webhook event name is "fork".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#forkevent">https://developer.github.com/v3/activity/events/types/#forkevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GPGEmail">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=1287:1400#L27">GPGEmail</a></h2>
|
|
<pre>type GPGEmail struct {
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
Verified *<a href="../../../../builtin/index.html#bool">bool</a> `json:"verified,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GPGEmail represents an email address associated to a GPG key.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GPGKey">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=388:1130#L6">GPGKey</a></h2>
|
|
<pre>type GPGKey struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
PrimaryKeyID *<a href="../../../../builtin/index.html#int">int</a> `json:"primary_key_id,omitempty"`
|
|
KeyID *<a href="../../../../builtin/index.html#string">string</a> `json:"key_id,omitempty"`
|
|
PublicKey *<a href="../../../../builtin/index.html#string">string</a> `json:"public_key,omitempty"`
|
|
Emails []<a href="index.html#GPGEmail">GPGEmail</a> `json:"emails,omitempty"`
|
|
Subkeys []<a href="index.html#GPGKey">GPGKey</a> `json:"subkeys,omitempty"`
|
|
CanSign *<a href="../../../../builtin/index.html#bool">bool</a> `json:"can_sign,omitempty"`
|
|
CanEncryptComms *<a href="../../../../builtin/index.html#bool">bool</a> `json:"can_encrypt_comms,omitempty"`
|
|
CanEncryptStorage *<a href="../../../../builtin/index.html#bool">bool</a> `json:"can_encrypt_storage,omitempty"`
|
|
CanCertify *<a href="../../../../builtin/index.html#bool">bool</a> `json:"can_certify,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
ExpiresAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"expires_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GPGKey represents a GitHub user's public GPG key used to verify GPG signed commits and tags.
|
|
</p>
|
|
<p>
|
|
<a href="https://developer.github.com/changes/2016-04-04-git-signing-api-preview/">https://developer.github.com/changes/2016-04-04-git-signing-api-preview/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GPGKey.String">func (GPGKey) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=1164:1195#L22">String</a></h3>
|
|
<pre>func (k <a href="index.html#GPGKey">GPGKey</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
String stringifies a GPGKey.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Gist">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=425:1183#L10">Gist</a></h2>
|
|
<pre>type Gist struct {
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Public *<a href="../../../../builtin/index.html#bool">bool</a> `json:"public,omitempty"`
|
|
Owner *<a href="index.html#User">User</a> `json:"owner,omitempty"`
|
|
Files map[<a href="index.html#GistFilename">GistFilename</a>]<a href="index.html#GistFile">GistFile</a> `json:"files,omitempty"`
|
|
Comments *<a href="../../../../builtin/index.html#int">int</a> `json:"comments,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
GitPullURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_pull_url,omitempty"`
|
|
GitPushURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_push_url,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Gist represents a GitHub's gist.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Gist.String">func (Gist) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1185:1214#L24">String</a></h3>
|
|
<pre>func (g <a href="index.html#Gist">Gist</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistComment">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=255:515#L4">GistComment</a></h2>
|
|
<pre>type GistComment struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GistComment represents a Gist comment.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistComment.String">func (GistComment) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=517:553#L12">String</a></h3>
|
|
<pre>func (g <a href="index.html#GistComment">GistComment</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistCommit">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1664:1963#L44">GistCommit</a></h2>
|
|
<pre>type GistCommit struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Version *<a href="../../../../builtin/index.html#string">string</a> `json:"version,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
ChangeStatus *<a href="index.html#CommitStats">CommitStats</a> `json:"change_status,omitempty"`
|
|
CommitedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"commited_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GistCommit represents a commit on a gist.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistCommit.String">func (GistCommit) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1965:2001#L52">String</a></h3>
|
|
<pre>func (gc <a href="index.html#GistCommit">GistCommit</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistFile">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1355:1557#L32">GistFile</a></h2>
|
|
<pre>type GistFile struct {
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
Filename *<a href="../../../../builtin/index.html#string">string</a> `json:"filename,omitempty"`
|
|
RawURL *<a href="../../../../builtin/index.html#string">string</a> `json:"raw_url,omitempty"`
|
|
Content *<a href="../../../../builtin/index.html#string">string</a> `json:"content,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GistFile represents a file on a gist.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistFile.String">func (GistFile) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1559:1592#L39">String</a></h3>
|
|
<pre>func (g <a href="index.html#GistFile">GistFile</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistFilename">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=1288:1312#L29">GistFilename</a></h2>
|
|
<pre>type GistFilename <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
GistFilename represents filename on a gist.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistFork">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=2070:2333#L57">GistFork</a></h2>
|
|
<pre>type GistFork struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GistFork represents a fork of a gist.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistFork.String">func (GistFork) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=2335:2369#L65">String</a></h3>
|
|
<pre>func (gf <a href="index.html#GistFork">GistFork</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=2539:2658#L71">GistListOptions</a></h2>
|
|
<pre>type GistListOptions struct {
|
|
<span class="comment">// Since filters Gists by time.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
GistListOptions specifies the optional parameters to the
|
|
GistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GistsService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=362:387#L7">GistsService</a></h2>
|
|
<pre>type GistsService service</pre>
|
|
<p>
|
|
GistsService handles communication with the Gist related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/">http://developer.github.com/v3/gists/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Create">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=5488:5555#L195">Create</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Create(gist *<a href="index.html#Gist">Gist</a>) (*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create a gist for authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#create-a-gist">http://developer.github.com/v3/gists/#create-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.CreateComment">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=1848:1954#L62">CreateComment</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) CreateComment(gistID <a href="../../../../builtin/index.html#string">string</a>, comment *<a href="index.html#GistComment">GistComment</a>) (*<a href="index.html#GistComment">GistComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateComment creates a comment for a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/comments/#create-a-comment">http://developer.github.com/v3/gists/comments/#create-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Delete">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=6787:6846#L250">Delete</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Delete(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Delete a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#delete-a-gist">http://developer.github.com/v3/gists/#delete-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.DeleteComment">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=2894:2979#L100">DeleteComment</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) DeleteComment(gistID <a href="../../../../builtin/index.html#string">string</a>, commentID <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteComment deletes a gist comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/comments/#delete-a-comment">http://developer.github.com/v3/gists/comments/#delete-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Edit">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=5873:5949#L213">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Edit(id <a href="../../../../builtin/index.html#string">string</a>, gist *<a href="index.html#Gist">Gist</a>) (*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#edit-a-gist">http://developer.github.com/v3/gists/#edit-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.EditComment">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=2359:2478#L81">EditComment</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) EditComment(gistID <a href="../../../../builtin/index.html#string">string</a>, commentID <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#GistComment">GistComment</a>) (*<a href="index.html#GistComment">GistComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditComment edits an existing gist comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/comments/#edit-a-comment">http://developer.github.com/v3/gists/comments/#edit-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Fork">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=8244:8308#L300">Fork</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Fork(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Fork a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#fork-a-gist">http://developer.github.com/v3/gists/#fork-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Get">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=4566:4629#L159">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Get(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get a single gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#get-a-single-gist">http://developer.github.com/v3/gists/#get-a-single-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.GetComment">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=1336:1432#L43">GetComment</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) GetComment(gistID <a href="../../../../builtin/index.html#string">string</a>, commentID <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#GistComment">GistComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetComment retrieves a single comment from a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/comments/#get-a-single-comment">http://developer.github.com/v3/gists/comments/#get-a-single-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.GetRevision">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=5032:5108#L177">GetRevision</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) GetRevision(id, sha <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetRevision gets a specific revision of a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist">https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.IsStarred">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=7846:7914#L286">IsStarred</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) IsStarred(id <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsStarred checks if a gist is starred by authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#check-if-a-gist-is-starred">http://developer.github.com/v3/gists/#check-if-a-gist-is-starred</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.List">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=2935:3025#L84">List</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) List(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#GistListOptions">GistListOptions</a>) ([]*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List gists for a user. Passing the empty string will list
|
|
all public gists if called anonymously. However, if the call
|
|
is authenticated, it will returns all gists for the authenticated
|
|
user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#list-gists">http://developer.github.com/v3/gists/#list-gists</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.ListAll">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=3536:3616#L113">ListAll</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) ListAll(opt *<a href="index.html#GistListOptions">GistListOptions</a>) ([]*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListAll lists all public gists.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#list-gists">http://developer.github.com/v3/gists/#list-gists</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.ListComments">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists_comments.go?s=721:824#L19">ListComments</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) ListComments(gistID <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#GistComment">GistComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListComments lists all comments for a gist.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist">http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.ListCommits">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=6319:6398#L231">ListCommits</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) ListCommits(id <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#GistCommit">GistCommit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommits lists commits of a gist.
|
|
</p>
|
|
<p>
|
|
Github API docs: <a href="https://developer.github.com/v3/gists/#list-gist-commits">https://developer.github.com/v3/gists/#list-gist-commits</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.ListForks">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=8677:8752#L319">ListForks</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) ListForks(id <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#GistFork">GistFork</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListForks lists forks of a gist.
|
|
</p>
|
|
<p>
|
|
Github API docs: <a href="https://developer.github.com/v3/gists/#list-gist-forks">https://developer.github.com/v3/gists/#list-gist-forks</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.ListStarred">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=4063:4147#L136">ListStarred</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) ListStarred(opt *<a href="index.html#GistListOptions">GistListOptions</a>) ([]*<a href="index.html#Gist">Gist</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListStarred lists starred gists of authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#list-gists">http://developer.github.com/v3/gists/#list-gists</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Star">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=7126:7183#L262">Star</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Star(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Star a gist on behalf of authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gists/#star-a-gist">http://developer.github.com/v3/gists/#star-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GistsService.Unstar">func (*GistsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gists.go?s=7471:7530#L274">Unstar</a></h3>
|
|
<pre>func (s *<a href="index.html#GistsService">GistsService</a>) Unstar(id <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Unstar a gist on a behalf of authenticated user.
|
|
</p>
|
|
<p>
|
|
Github API docs: <a href="http://developer.github.com/v3/gists/#unstar-a-gist">http://developer.github.com/v3/gists/#unstar-a-gist</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GitObject">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=485:592#L15">GitObject</a></h2>
|
|
<pre>type GitObject struct {
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url"`
|
|
}</pre>
|
|
<p>
|
|
GitObject represents a Git object.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitObject.String">func (GitObject) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=594:628#L21">String</a></h3>
|
|
<pre>func (o <a href="index.html#GitObject">GitObject</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GitService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git.go?s=337:360#L2">GitService</a></h2>
|
|
<pre>type GitService service</pre>
|
|
<p>
|
|
GitService handles communication with the git data related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/">http://developer.github.com/v3/git/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.CreateBlob">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_blobs.go?s=1049:1145#L27">CreateBlob</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) CreateBlob(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, blob *<a href="index.html#Blob">Blob</a>) (*<a href="index.html#Blob">Blob</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateBlob creates a blob object.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/git/blobs/#create-a-blob">https://developer.github.com/v3/git/blobs/#create-a-blob</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.CreateCommit">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=3270:3374#L86">CreateCommit</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) CreateCommit(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, commit *<a href="index.html#Commit">Commit</a>) (*<a href="index.html#Commit">Commit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateCommit creates a new commit in a repository.
|
|
</p>
|
|
<p>
|
|
The commit.Committer is optional and will be filled with the commit.Author
|
|
data if omitted. If the commit.Author is omitted, it will be filled in with
|
|
the authenticated user’s information and the current date.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/commits/#create-a-commit">http://developer.github.com/v3/git/commits/#create-a-commit</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.CreateRef">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=2545:2649#L97">CreateRef</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) CreateRef(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, ref *<a href="index.html#Reference">Reference</a>) (*<a href="index.html#Reference">Reference</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateRef creates a new ref in a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/refs/#create-a-reference">http://developer.github.com/v3/git/refs/#create-a-reference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.CreateTag">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_tags.go?s=1884:1976#L45">CreateTag</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) CreateTag(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, tag *<a href="index.html#Tag">Tag</a>) (*<a href="index.html#Tag">Tag</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateTag creates a tag object.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/tags/#create-a-tag-object">http://developer.github.com/v3/git/tags/#create-a-tag-object</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.CreateTree">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=1952:2074#L60">CreateTree</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) CreateTree(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, baseTree <a href="../../../../builtin/index.html#string">string</a>, entries []<a href="index.html#TreeEntry">TreeEntry</a>) (*<a href="index.html#Tree">Tree</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateTree creates a new tree in a repository. If both a tree and a nested
|
|
path modifying that tree are specified, it will overwrite the contents of
|
|
that tree with the new path contents and write a new tree out.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/trees/#create-a-tree">http://developer.github.com/v3/git/trees/#create-a-tree</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.DeleteRef">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=3884:3972#L143">DeleteRef</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) DeleteRef(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, ref <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteRef deletes a ref from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/refs/#delete-a-reference">http://developer.github.com/v3/git/refs/#delete-a-reference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.GetBlob">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_blobs.go?s=597:690#L12">GetBlob</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) GetBlob(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, sha <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Blob">Blob</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetBlob fetchs a blob from a repo given a SHA.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/blobs/#get-a-blob">http://developer.github.com/v3/git/blobs/#get-a-blob</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.GetCommit">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=2056:2153#L51">GetCommit</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) GetCommit(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, sha <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Commit">Commit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetCommit fetchs the Commit object for a given SHA.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/commits/#get-a-commit">http://developer.github.com/v3/git/commits/#get-a-commit</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.GetRef">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=1111:1208#L40">GetRef</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) GetRef(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, ref <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Reference">Reference</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetRef fetches the Reference object for a given Git ref.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/refs/#get-a-reference">http://developer.github.com/v3/git/refs/#get-a-reference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.GetTag">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_tags.go?s=1314:1405#L27">GetTag</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) GetTag(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, sha <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Tag">Tag</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetTag fetchs a tag from a repo given a SHA.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/tags/#get-a-tag">http://developer.github.com/v3/git/tags/#get-a-tag</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.GetTree">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=1048:1157#L29">GetTree</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) GetTree(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, sha <a href="../../../../builtin/index.html#string">string</a>, recursive <a href="../../../../builtin/index.html#bool">bool</a>) (*<a href="index.html#Tree">Tree</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetTree fetches the Tree object for a given sha hash from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/trees/#get-a-tree">http://developer.github.com/v3/git/trees/#get-a-tree</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.ListRefs">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=1824:1933#L68">ListRefs</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) ListRefs(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ReferenceListOptions">ReferenceListOptions</a>) ([]*<a href="index.html#Reference">Reference</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListRefs lists all refs in a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/refs/#get-all-references">http://developer.github.com/v3/git/refs/#get-all-references</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitService.UpdateRef">func (*GitService) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=3241:3357#L120">UpdateRef</a></h3>
|
|
<pre>func (s *<a href="index.html#GitService">GitService</a>) UpdateRef(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, ref *<a href="index.html#Reference">Reference</a>, force <a href="../../../../builtin/index.html#bool">bool</a>) (*<a href="index.html#Reference">Reference</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UpdateRef updates an existing ref in a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/git/refs/#update-a-reference">http://developer.github.com/v3/git/refs/#update-a-reference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Gitignore">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go?s=464:571#L7">Gitignore</a></h2>
|
|
<pre>type Gitignore struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Source *<a href="../../../../builtin/index.html#string">string</a> `json:"source,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Gitignore represents a .gitignore file as returned by the GitHub API.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Gitignore.String">func (Gitignore) <a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go?s=573:607#L12">String</a></h3>
|
|
<pre>func (g <a href="index.html#Gitignore">Gitignore</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GitignoresService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go?s=359:389#L4">GitignoresService</a></h2>
|
|
<pre>type GitignoresService service</pre>
|
|
<p>
|
|
GitignoresService provides access to the gitignore related functions in the
|
|
GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/gitignore/">http://developer.github.com/v3/gitignore/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitignoresService.Get">func (GitignoresService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go?s=1203:1277#L37">Get</a></h3>
|
|
<pre>func (s <a href="index.html#GitignoresService">GitignoresService</a>) Get(name <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Gitignore">Gitignore</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get a Gitignore by name.
|
|
</p>
|
|
<p>
|
|
<a href="http://developer.github.com/v3/gitignore/#get-a-single-template">http://developer.github.com/v3/gitignore/#get-a-single-template</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="GitignoresService.List">func (GitignoresService) <a href="http://localhost:6060/src/github.com/google/go-github/github/gitignore.go?s=753:815#L19">List</a></h3>
|
|
<pre>func (s <a href="index.html#GitignoresService">GitignoresService</a>) List() ([]<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List all available Gitignore templates.
|
|
</p>
|
|
<p>
|
|
<a href="http://developer.github.com/v3/gitignore/#listing-available-templates">http://developer.github.com/v3/gitignore/#listing-available-templates</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="GollumEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=4520:4747#L108">GollumEvent</a></h2>
|
|
<pre>type GollumEvent struct {
|
|
Pages []*<a href="index.html#Page">Page</a> `json:"pages,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
GollumEvent is triggered when a Wiki page is created or updated.
|
|
The Webhook event name is "gollum".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#gollumevent">https://developer.github.com/v3/activity/events/types/#gollumevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Grant">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=3230:3579#L77">Grant</a></h2>
|
|
<pre>type Grant struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
App *<a href="index.html#AuthorizationApp">AuthorizationApp</a> `json:"app,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
Scopes []<a href="../../../../builtin/index.html#string">string</a> `json:"scopes,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Grant represents an OAuth application that has been granted access to an account.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Grant.String">func (Grant) <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=3581:3611#L86">String</a></h3>
|
|
<pre>func (g <a href="index.html#Grant">Grant</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Hook">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=2515:3014#L60">Hook</a></h2>
|
|
<pre>type Hook struct {
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Events []<a href="../../../../builtin/index.html#string">string</a> `json:"events,omitempty"`
|
|
Active *<a href="../../../../builtin/index.html#bool">bool</a> `json:"active,omitempty"`
|
|
Config map[<a href="../../../../builtin/index.html#string">string</a>]interface{} `json:"config,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Hook represents a GitHub (web and service) hook for a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Hook.String">func (Hook) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=3016:3045#L71">String</a></h3>
|
|
<pre>func (h <a href="index.html#Hook">Hook</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Import">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=250:5406#L1">Import</a></h2>
|
|
<pre>type Import struct {
|
|
<span class="comment">// The URL of the originating repository.</span>
|
|
VCSURL *<a href="../../../../builtin/index.html#string">string</a> `json:"vcs_url,omitempty"`
|
|
<span class="comment">// The originating VCS type. Can be one of 'subversion', 'git',</span>
|
|
<span class="comment">// 'mercurial', or 'tfvc'. Without this parameter, the import job will</span>
|
|
<span class="comment">// take additional time to detect the VCS type before beginning the</span>
|
|
<span class="comment">// import. This detection step will be reflected in the response.</span>
|
|
VCS *<a href="../../../../builtin/index.html#string">string</a> `json:"vcs,omitempty"`
|
|
<span class="comment">// VCSUsername and VCSPassword are only used for StartImport calls that</span>
|
|
<span class="comment">// are importing a password-protected repository.</span>
|
|
VCSUsername *<a href="../../../../builtin/index.html#string">string</a> `json:"vcs_username,omitempty"`
|
|
VCSPassword *<a href="../../../../builtin/index.html#string">string</a> `json:"vcs_password,omitempty"`
|
|
<span class="comment">// For a tfvc import, the name of the project that is being imported.</span>
|
|
TFVCProject *<a href="../../../../builtin/index.html#string">string</a> `json:"tfvc_project,omitempty"`
|
|
|
|
<span class="comment">// Describes whether the import has been opted in or out of using Git</span>
|
|
<span class="comment">// LFS. The value can be 'opt_in', 'opt_out', or 'undecided' if no</span>
|
|
<span class="comment">// action has been taken.</span>
|
|
UseLFS *<a href="../../../../builtin/index.html#string">string</a> `json:"use_lfs,omitempty"`
|
|
<span class="comment">// Describes whether files larger than 100MB were found during the</span>
|
|
<span class="comment">// importing step.</span>
|
|
HasLargeFiles *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_large_files,omitempty"`
|
|
<span class="comment">// The total size in gigabytes of files larger than 100MB found in the</span>
|
|
<span class="comment">// originating repository.</span>
|
|
LargeFilesSize *<a href="../../../../builtin/index.html#int">int</a> `json:"large_files_size,omitempty"`
|
|
<span class="comment">// The total number of files larger than 100MB found in the originating</span>
|
|
<span class="comment">// repository. To see a list of these files, call LargeFiles.</span>
|
|
LargeFilesCount *<a href="../../../../builtin/index.html#int">int</a> `json:"large_files_count,omitempty"`
|
|
|
|
<span class="comment">// Identifies the current status of an import. An import that does not</span>
|
|
<span class="comment">// have errors will progress through these steps:</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// detecting - the "detection" step of the import is in progress</span>
|
|
<span class="comment">// because the request did not include a VCS parameter. The</span>
|
|
<span class="comment">// import is identifying the type of source control present at</span>
|
|
<span class="comment">// the URL.</span>
|
|
<span class="comment">// importing - the "raw" step of the import is in progress. This is</span>
|
|
<span class="comment">// where commit data is fetched from the original repository.</span>
|
|
<span class="comment">// The import progress response will include CommitCount (the</span>
|
|
<span class="comment">// total number of raw commits that will be imported) and</span>
|
|
<span class="comment">// Percent (0 - 100, the current progress through the import).</span>
|
|
<span class="comment">// mapping - the "rewrite" step of the import is in progress. This</span>
|
|
<span class="comment">// is where SVN branches are converted to Git branches, and</span>
|
|
<span class="comment">// where author updates are applied. The import progress</span>
|
|
<span class="comment">// response does not include progress information.</span>
|
|
<span class="comment">// pushing - the "push" step of the import is in progress. This is</span>
|
|
<span class="comment">// where the importer updates the repository on GitHub. The</span>
|
|
<span class="comment">// import progress response will include PushPercent, which is</span>
|
|
<span class="comment">// the percent value reported by git push when it is "Writing</span>
|
|
<span class="comment">// objects".</span>
|
|
<span class="comment">// complete - the import is complete, and the repository is ready</span>
|
|
<span class="comment">// on GitHub.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// If there are problems, you will see one of these in the status field:</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// auth_failed - the import requires authentication in order to</span>
|
|
<span class="comment">// connect to the original repository. Make an UpdateImport</span>
|
|
<span class="comment">// request, and include VCSUsername and VCSPassword.</span>
|
|
<span class="comment">// error - the import encountered an error. The import progress</span>
|
|
<span class="comment">// response will include the FailedStep and an error message.</span>
|
|
<span class="comment">// Contact GitHub support for more information.</span>
|
|
<span class="comment">// detection_needs_auth - the importer requires authentication for</span>
|
|
<span class="comment">// the originating repository to continue detection. Make an</span>
|
|
<span class="comment">// UpdatImport request, and include VCSUsername and</span>
|
|
<span class="comment">// VCSPassword.</span>
|
|
<span class="comment">// detection_found_nothing - the importer didn't recognize any</span>
|
|
<span class="comment">// source control at the URL.</span>
|
|
<span class="comment">// detection_found_multiple - the importer found several projects</span>
|
|
<span class="comment">// or repositories at the provided URL. When this is the case,</span>
|
|
<span class="comment">// the Import Progress response will also include a</span>
|
|
<span class="comment">// ProjectChoices field with the possible project choices as</span>
|
|
<span class="comment">// values. Make an UpdateImport request, and include VCS and</span>
|
|
<span class="comment">// (if applicable) TFVCProject.</span>
|
|
Status *<a href="../../../../builtin/index.html#string">string</a> `json:"status,omitempty"`
|
|
CommitCount *<a href="../../../../builtin/index.html#int">int</a> `json:"commit_count,omitempty"`
|
|
StatusText *<a href="../../../../builtin/index.html#string">string</a> `json:"status_text,omitempty"`
|
|
AuthorsCount *<a href="../../../../builtin/index.html#int">int</a> `json:"authors_count,omitempty"`
|
|
Percent *<a href="../../../../builtin/index.html#int">int</a> `json:"percent,omitempty"`
|
|
PushPercent *<a href="../../../../builtin/index.html#int">int</a> `json:"push_percent,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
AuthorsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"authors_url,omitempty"`
|
|
RepositoryURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repository_url,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
FailedStep *<a href="../../../../builtin/index.html#string">string</a> `json:"failed_step,omitempty"`
|
|
|
|
<span class="comment">// Human readable display name, provided when the Import appears as</span>
|
|
<span class="comment">// part of ProjectChoices.</span>
|
|
HumanName *<a href="../../../../builtin/index.html#string">string</a> `json:"human_name,omitempty"`
|
|
|
|
<span class="comment">// When the importer finds several projects or repositories at the</span>
|
|
<span class="comment">// provided URLs, this will identify the available choices. Call</span>
|
|
<span class="comment">// UpdateImport with the selected Import value.</span>
|
|
ProjectChoices []<a href="index.html#Import">Import</a> `json:"project_choices,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Import represents a repository import request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Import.String">func (Import) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=5408:5439#L99">String</a></h3>
|
|
<pre>func (i <a href="index.html#Import">Import</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Issue">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=447:1890#L10">Issue</a></h2>
|
|
<pre>type Issue struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Number *<a href="../../../../builtin/index.html#int">int</a> `json:"number,omitempty"`
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
Labels []<a href="index.html#Label">Label</a> `json:"labels,omitempty"`
|
|
Assignee *<a href="index.html#User">User</a> `json:"assignee,omitempty"`
|
|
Comments *<a href="../../../../builtin/index.html#int">int</a> `json:"comments,omitempty"`
|
|
ClosedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"closed_at,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
Milestone *<a href="index.html#Milestone">Milestone</a> `json:"milestone,omitempty"`
|
|
PullRequestLinks *<a href="index.html#PullRequestLinks">PullRequestLinks</a> `json:"pull_request,omitempty"`
|
|
Repository *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Reactions *<a href="index.html#Reactions">Reactions</a> `json:"reactions,omitempty"`
|
|
Assignees []*<a href="index.html#User">User</a> `json:"assignees,omitempty"`
|
|
|
|
<span class="comment">// TextMatches is only populated from search results that request text matches</span>
|
|
<span class="comment">// See: search.go and https://developer.github.com/v3/search/#text-match-metadata</span>
|
|
TextMatches []<a href="index.html#TextMatch">TextMatch</a> `json:"text_matches,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Issue represents a GitHub issue on a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Issue.String">func (Issue) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=1892:1922#L36">String</a></h3>
|
|
<pre>func (i <a href="index.html#Issue">Issue</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueActivityEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=4861:5138#L118">IssueActivityEvent</a></h2>
|
|
<pre>type IssueActivityEvent struct {
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Issue *<a href="index.html#Issue">Issue</a> `json:"issue,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
DEPRECATED: IssueActivityEvent represents the payload delivered by Issue webhook
|
|
Use IssuesEvent instead.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueComment">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=268:733#L4">IssueComment</a></h2>
|
|
<pre>type IssueComment struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
Reactions *<a href="index.html#Reactions">Reactions</a> `json:"reactions,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
IssueURL *<a href="../../../../builtin/index.html#string">string</a> `json:"issue_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssueComment represents a comment left on an issue.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssueComment.String">func (IssueComment) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=735:772#L16">String</a></h3>
|
|
<pre>func (i <a href="index.html#IssueComment">IssueComment</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueCommentEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=5668:6175#L143">IssueCommentEvent</a></h2>
|
|
<pre>type IssueCommentEvent struct {
|
|
<span class="comment">// Action is the action that was performed on the comment.</span>
|
|
<span class="comment">// Possible values are: "created", "edited", "deleted".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Issue *<a href="index.html#Issue">Issue</a> `json:"issue,omitempty"`
|
|
Comment *<a href="index.html#IssueComment">IssueComment</a> `json:"comment,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Changes *<a href="index.html#EditChange">EditChange</a> `json:"changes,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssueCommentEvent is triggered when an issue comment is created on an issue
|
|
or pull request.
|
|
The Webhook event name is "issue_comment".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#issuecommentevent">https://developer.github.com/v3/activity/events/types/#issuecommentevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=294:2311#L4">IssueEvent</a></h2>
|
|
<pre>type IssueEvent struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
|
|
<span class="comment">// The User that generated this event.</span>
|
|
Actor *<a href="index.html#User">User</a> `json:"actor,omitempty"`
|
|
|
|
<span class="comment">// Event identifies the actual type of Event that occurred. Possible</span>
|
|
<span class="comment">// values are:</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// closed</span>
|
|
<span class="comment">// The Actor closed the issue.</span>
|
|
<span class="comment">// If the issue was closed by commit message, CommitID holds the SHA1 hash of the commit.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// merged</span>
|
|
<span class="comment">// The Actor merged into master a branch containing a commit mentioning the issue.</span>
|
|
<span class="comment">// CommitID holds the SHA1 of the merge commit.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// referenced</span>
|
|
<span class="comment">// The Actor committed to master a commit mentioning the issue in its commit message.</span>
|
|
<span class="comment">// CommitID holds the SHA1 of the commit.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// reopened, locked, unlocked</span>
|
|
<span class="comment">// The Actor did that to the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// renamed</span>
|
|
<span class="comment">// The Actor changed the issue title from Rename.From to Rename.To.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// mentioned</span>
|
|
<span class="comment">// Someone unspecified @mentioned the Actor [sic] in an issue comment body.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// assigned, unassigned</span>
|
|
<span class="comment">// The Actor assigned the issue to or removed the assignment from the Assignee.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// labeled, unlabeled</span>
|
|
<span class="comment">// The Actor added or removed the Label from the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// milestoned, demilestoned</span>
|
|
<span class="comment">// The Actor added or removed the issue from the Milestone.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// subscribed, unsubscribed</span>
|
|
<span class="comment">// The Actor subscribed to or unsubscribed from notifications for an issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// head_ref_deleted, head_ref_restored</span>
|
|
<span class="comment">// The pull request’s branch was deleted or restored.</span>
|
|
<span class="comment">//</span>
|
|
Event *<a href="../../../../builtin/index.html#string">string</a> `json:"event,omitempty"`
|
|
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
Issue *<a href="index.html#Issue">Issue</a> `json:"issue,omitempty"`
|
|
|
|
<span class="comment">// Only present on certain events; see above.</span>
|
|
Assignee *<a href="index.html#User">User</a> `json:"assignee,omitempty"`
|
|
CommitID *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_id,omitempty"`
|
|
Milestone *<a href="index.html#Milestone">Milestone</a> `json:"milestone,omitempty"`
|
|
Label *<a href="index.html#Label">Label</a> `json:"label,omitempty"`
|
|
Rename *<a href="index.html#Rename">Rename</a> `json:"rename,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssueEvent represents an event that occurred around an Issue or Pull Request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueListByRepoOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=5330:6661#L140">IssueListByRepoOptions</a></h2>
|
|
<pre>type IssueListByRepoOptions struct {
|
|
<span class="comment">// Milestone limits issues for the specified milestone. Possible values are</span>
|
|
<span class="comment">// a milestone number, "none" for issues with no milestone, "*" for issues</span>
|
|
<span class="comment">// with any milestone.</span>
|
|
Milestone <a href="../../../../builtin/index.html#string">string</a> `url:"milestone,omitempty"`
|
|
|
|
<span class="comment">// State filters issues based on their state. Possible values are: open,</span>
|
|
<span class="comment">// closed, all. Default is "open".</span>
|
|
State <a href="../../../../builtin/index.html#string">string</a> `url:"state,omitempty"`
|
|
|
|
<span class="comment">// Assignee filters issues based on their assignee. Possible values are a</span>
|
|
<span class="comment">// user name, "none" for issues that are not assigned, "*" for issues with</span>
|
|
<span class="comment">// any assigned user.</span>
|
|
Assignee <a href="../../../../builtin/index.html#string">string</a> `url:"assignee,omitempty"`
|
|
|
|
<span class="comment">// Creator filters issues based on their creator.</span>
|
|
Creator <a href="../../../../builtin/index.html#string">string</a> `url:"creator,omitempty"`
|
|
|
|
<span class="comment">// Mentioned filters issues to those mentioned a specific user.</span>
|
|
Mentioned <a href="../../../../builtin/index.html#string">string</a> `url:"mentioned,omitempty"`
|
|
|
|
<span class="comment">// Labels filters issues based on their label.</span>
|
|
Labels []<a href="../../../../builtin/index.html#string">string</a> `url:"labels,omitempty,comma"`
|
|
|
|
<span class="comment">// Sort specifies how to sort issues. Possible values are: created, updated,</span>
|
|
<span class="comment">// and comments. Default value is "created".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort issues. Possible values are: asc, desc.</span>
|
|
<span class="comment">// Default is "desc".</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<span class="comment">// Since filters issues by time.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
IssueListByRepoOptions specifies the optional parameters to the
|
|
IssuesService.ListByRepo method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueListCommentsOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=906:1276#L22">IssueListCommentsOptions</a></h2>
|
|
<pre>type IssueListCommentsOptions struct {
|
|
<span class="comment">// Sort specifies how to sort comments. Possible values are: created, updated.</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort comments. Possible values are: asc, desc.</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<span class="comment">// Since filters comments by time.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
IssueListCommentsOptions specifies the optional parameters to the
|
|
IssuesService.ListComments method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=2609:3464#L55">IssueListOptions</a></h2>
|
|
<pre>type IssueListOptions struct {
|
|
<span class="comment">// Filter specifies which issues to list. Possible values are: assigned,</span>
|
|
<span class="comment">// created, mentioned, subscribed, all. Default is "assigned".</span>
|
|
Filter <a href="../../../../builtin/index.html#string">string</a> `url:"filter,omitempty"`
|
|
|
|
<span class="comment">// State filters issues based on their state. Possible values are: open,</span>
|
|
<span class="comment">// closed, all. Default is "open".</span>
|
|
State <a href="../../../../builtin/index.html#string">string</a> `url:"state,omitempty"`
|
|
|
|
<span class="comment">// Labels filters issues based on their label.</span>
|
|
Labels []<a href="../../../../builtin/index.html#string">string</a> `url:"labels,comma,omitempty"`
|
|
|
|
<span class="comment">// Sort specifies how to sort issues. Possible values are: created, updated,</span>
|
|
<span class="comment">// and comments. Default value is "created".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort issues. Possible values are: asc, desc.</span>
|
|
<span class="comment">// Default is "desc".</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<span class="comment">// Since filters issues by time.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
IssueListOptions specifies the optional parameters to the IssuesService.List
|
|
and IssuesService.ListByOrg methods.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssueRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=2126:2487#L43">IssueRequest</a></h2>
|
|
<pre>type IssueRequest struct {
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
Labels *[]<a href="../../../../builtin/index.html#string">string</a> `json:"labels,omitempty"`
|
|
Assignee *<a href="../../../../builtin/index.html#string">string</a> `json:"assignee,omitempty"`
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Milestone *<a href="../../../../builtin/index.html#int">int</a> `json:"milestone,omitempty"`
|
|
Assignees *[]<a href="../../../../builtin/index.html#string">string</a> `json:"assignees,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssueRequest represents a request to create/edit an issue.
|
|
It is separate from Issue above because otherwise Labels
|
|
and Assignee fail to serialize to the correct JSON.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssuesEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=6421:6996#L161">IssuesEvent</a></h2>
|
|
<pre>type IssuesEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible values are: "assigned",</span>
|
|
<span class="comment">// "unassigned", "labeled", "unlabeled", "opened", "closed", "reopened", "edited".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Issue *<a href="index.html#Issue">Issue</a> `json:"issue,omitempty"`
|
|
Assignee *<a href="index.html#User">User</a> `json:"assignee,omitempty"`
|
|
Label *<a href="index.html#Label">Label</a> `json:"label,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Changes *<a href="index.html#EditChange">EditChange</a> `json:"changes,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssuesEvent is triggered when an issue is assigned, unassigned, labeled,
|
|
unlabeled, opened, closed, or reopened.
|
|
The Webhook event name is "issues".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#issuesevent">https://developer.github.com/v3/activity/events/types/#issuesevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssuesSearchResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=1762:1884#L47">IssuesSearchResult</a></h2>
|
|
<pre>type IssuesSearchResult struct {
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
Issues []<a href="index.html#Issue">Issue</a> `json:"items,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
IssuesSearchResult represents the result of an issues search.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="IssuesService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=367:393#L7">IssuesService</a></h2>
|
|
<pre>type IssuesService service</pre>
|
|
<p>
|
|
IssuesService handles communication with the issue related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/">http://developer.github.com/v3/issues/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.AddAssignees">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_assignees.go?s=1563:1678#L41">AddAssignees</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) AddAssignees(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, assignees []<a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddAssignees adds the provided GitHub users as assignees to the issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue">https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.AddLabelsToIssue">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=3822:3947#L131">AddLabelsToIssue</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) AddLabelsToIssue(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, labels []<a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddLabelsToIssue adds labels to an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.Create">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=8156:8261#L230">Create</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) Create(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, issue *<a href="index.html#IssueRequest">IssueRequest</a>) (*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create a new issue on the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#create-an-issue">http://developer.github.com/v3/issues/#create-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.CreateComment">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=3123:3256#L94">CreateComment</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) CreateComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#IssueComment">IssueComment</a>) (*<a href="index.html#IssueComment">IssueComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateComment creates a new comment on the specified issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/comments/#create-a-comment">http://developer.github.com/v3/issues/comments/#create-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.CreateLabel">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=1731:1834#L57">CreateLabel</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) CreateLabel(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, label *<a href="index.html#Label">Label</a>) (*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateLabel creates a new label on the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#create-a-label">http://developer.github.com/v3/issues/labels/#create-a-label</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.CreateMilestone">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=3143:3262#L90">CreateMilestone</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) CreateMilestone(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, milestone *<a href="index.html#Milestone">Milestone</a>) (*<a href="index.html#Milestone">Milestone</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateMilestone creates a new milestone on the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/milestones/#create-a-milestone">https://developer.github.com/v3/issues/milestones/#create-a-milestone</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.DeleteComment">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=4236:4327#L130">DeleteComment</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) DeleteComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteComment deletes an issue comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/comments/#delete-a-comment">http://developer.github.com/v3/issues/comments/#delete-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.DeleteLabel">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=2728:2822#L95">DeleteLabel</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) DeleteLabel(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, name <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteLabel deletes a label.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#delete-a-label">http://developer.github.com/v3/issues/labels/#delete-a-label</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.DeleteMilestone">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=4231:4328#L128">DeleteMilestone</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) DeleteMilestone(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteMilestone deletes a milestone.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/milestones/#delete-a-milestone">https://developer.github.com/v3/issues/milestones/#delete-a-milestone</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.Edit">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=8626:8741#L249">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) Edit(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, issue *<a href="index.html#IssueRequest">IssueRequest</a>) (*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#edit-an-issue">http://developer.github.com/v3/issues/#edit-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.EditComment">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=3682:3809#L112">EditComment</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) EditComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#IssueComment">IssueComment</a>) (*<a href="index.html#IssueComment">IssueComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditComment updates an issue comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/comments/#edit-a-comment">http://developer.github.com/v3/issues/comments/#edit-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.EditLabel">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=2217:2331#L76">EditLabel</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) EditLabel(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, name <a href="../../../../builtin/index.html#string">string</a>, label *<a href="index.html#Label">Label</a>) (*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditLabel edits a label.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#update-a-label">http://developer.github.com/v3/issues/labels/#update-a-label</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.EditMilestone">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=3674:3803#L109">EditMilestone</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) EditMilestone(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, milestone *<a href="index.html#Milestone">Milestone</a>) (*<a href="index.html#Milestone">Milestone</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditMilestone edits a milestone.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/milestones/#update-a-milestone">https://developer.github.com/v3/issues/milestones/#update-a-milestone</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.Get">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=7521:7614#L208">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) Get(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get a single issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#get-a-single-issue">http://developer.github.com/v3/issues/#get-a-single-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.GetComment">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=2437:2540#L71">GetComment</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) GetComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#IssueComment">IssueComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetComment fetches the specified issue comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/comments/#get-a-single-comment">http://developer.github.com/v3/issues/comments/#get-a-single-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.GetEvent">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=3755:3847#L114">GetEvent</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) GetEvent(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#IssueEvent">IssueEvent</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetEvent returns the specified issue event.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/events/#get-a-single-event">https://developer.github.com/v3/issues/events/#get-a-single-event</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.GetLabel">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=1195:1294#L38">GetLabel</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) GetLabel(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, name <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetLabel gets a single label.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#get-a-single-label">http://developer.github.com/v3/issues/labels/#get-a-single-label</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.GetMilestone">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=2561:2667#L71">GetMilestone</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) GetMilestone(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Milestone">Milestone</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetMilestone gets a single milestone.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/milestones/#get-a-single-milestone">https://developer.github.com/v3/issues/milestones/#get-a-single-milestone</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.IsAssignee">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_assignees.go?s=1036:1121#L27">IsAssignee</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) IsAssignee(owner, repo, user <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsAssignee checks if a user is an assignee for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/assignees/#check-assignee">http://developer.github.com/v3/issues/assignees/#check-assignee</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.List">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=4164:4254#L96">List</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) List(all <a href="../../../../builtin/index.html#bool">bool</a>, opt *<a href="index.html#IssueListOptions">IssueListOptions</a>) ([]*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List the issues for the authenticated user. If all is true, list issues
|
|
across all the user's visible repositories including owned, member, and
|
|
organization repositories; if false, list only owned and member
|
|
repositories.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#list-issues">http://developer.github.com/v3/issues/#list-issues</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListAssignees">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_assignees.go?s=399:502#L4">ListAssignees</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListAssignees(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListAssignees fetches all available assignees (owners and collaborators) to
|
|
which issues may be assigned.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/assignees/#list-assignees">http://developer.github.com/v3/issues/assignees/#list-assignees</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListByOrg">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=4528:4625#L110">ListByOrg</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListByOrg(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#IssueListOptions">IssueListOptions</a>) ([]*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListByOrg fetches the issues in the specified organization for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#list-issues">http://developer.github.com/v3/issues/#list-issues</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListByRepo">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=6815:6934#L181">ListByRepo</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListByRepo(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#IssueListByRepoOptions">IssueListByRepoOptions</a>) ([]*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListByRepo lists the issues for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/#list-issues-for-a-repository">http://developer.github.com/v3/issues/#list-issues-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListComments">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_comments.go?s=1529:1671#L39">ListComments</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListComments(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#IssueListCommentsOptions">IssueListCommentsOptions</a>) ([]*<a href="index.html#IssueComment">IssueComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListComments lists all comments on the specified issue. Specifying an issue
|
|
number of 0 will return all comments on all issues for the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue">http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListIssueEvents">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=2465:2588#L66">ListIssueEvents</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListIssueEvents(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#IssueEvent">IssueEvent</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListIssueEvents lists events for the specified issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/events/#list-events-for-an-issue">https://developer.github.com/v3/issues/events/#list-events-for-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListIssueTimeline">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_timeline.go?s=4221:4344#L120">ListIssueTimeline</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListIssueTimeline(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Timeline">Timeline</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListIssueTimeline lists events for the specified issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue">https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListLabels">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=605:713#L14">ListLabels</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListLabels(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListLabels lists all labels for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListLabelsByIssue">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=3166:3293#L107">ListLabelsByIssue</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListLabelsByIssue(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListLabelsByIssue lists all labels for an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListLabelsForMilestone">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=5934:6066#L193">ListLabelsForMilestone</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListLabelsForMilestone(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListLabelsForMilestone lists labels for every issue in a milestone.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone">http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListMilestones">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=1917:2042#L47">ListMilestones</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListMilestones(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#MilestoneListOptions">MilestoneListOptions</a>) ([]*<a href="index.html#Milestone">Milestone</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListMilestones lists all milestones for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository">https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ListRepositoryEvents">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=3134:3250#L90">ListRepositoryEvents</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ListRepositoryEvents(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#IssueEvent">IssueEvent</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListRepositoryEvents lists events for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/events/#list-events-for-a-repository">https://developer.github.com/v3/issues/events/#list-events-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.Lock">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=9134:9220#L268">Lock</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) Lock(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Lock an issue's conversation.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/#lock-an-issue">https://developer.github.com/v3/issues/#lock-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.RemoveAssignees">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_assignees.go?s=2216:2334#L59">RemoveAssignees</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) RemoveAssignees(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, assignees []<a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Issue">Issue</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveAssignees removes the provided GitHub users as assignees from the issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue">https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.RemoveLabelForIssue">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=4392:4507#L150">RemoveLabelForIssue</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) RemoveLabelForIssue(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, label <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveLabelForIssue removes a label for an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue">http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.RemoveLabelsForIssue">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=5454:5556#L181">RemoveLabelsForIssue</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) RemoveLabelsForIssue(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveLabelsForIssue removes all labels for an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue">http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.ReplaceLabelsForIssue">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=4873:5003#L162">ReplaceLabelsForIssue</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) ReplaceLabelsForIssue(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, labels []<a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#Label">Label</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ReplaceLabelsForIssue replaces all labels for an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue">http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="IssuesService.Unlock">func (*IssuesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=9526:9614#L281">Unlock</a></h3>
|
|
<pre>func (s *<a href="index.html#IssuesService">IssuesService</a>) Unlock(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Unlock an issue's conversation.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/#unlock-an-issue">https://developer.github.com/v3/issues/#unlock-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Key">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=281:512#L1">Key</a></h2>
|
|
<pre>type Key struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Key *<a href="../../../../builtin/index.html#string">string</a> `json:"key,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
ReadOnly *<a href="../../../../builtin/index.html#bool">bool</a> `json:"read_only,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Key represents a public SSH key used to authenticate a user or deploy script.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Key.String">func (Key) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=514:542#L9">String</a></h3>
|
|
<pre>func (k <a href="index.html#Key">Key</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Label">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=247:385#L1">Label</a></h2>
|
|
<pre>type Label struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Color *<a href="../../../../builtin/index.html#string">string</a> `json:"color,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Label represents a GitHub label on an Issue
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Label.String">func (Label) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_labels.go?s=387:417#L7">String</a></h3>
|
|
<pre>func (l <a href="index.html#Label">Label</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="LargeFile">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=6254:6446#L123">LargeFile</a></h2>
|
|
<pre>type LargeFile struct {
|
|
RefName *<a href="../../../../builtin/index.html#string">string</a> `json:"ref_name,omitempty"`
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
OID *<a href="../../../../builtin/index.html#string">string</a> `json:"oid,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
LargeFile identifies a file larger than 100MB found during a repository import.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#get-large-files">https://developer.github.com/v3/migration/source_imports/#get-large-files</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="LargeFile.String">func (LargeFile) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=6448:6482#L130">String</a></h3>
|
|
<pre>func (f <a href="index.html#LargeFile">LargeFile</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="License">type <a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go?s=433:1062#L7">License</a></h2>
|
|
<pre>type License struct {
|
|
Key *<a href="../../../../builtin/index.html#string">string</a> `json:"key,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
Featured *<a href="../../../../builtin/index.html#bool">bool</a> `json:"featured,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Category *<a href="../../../../builtin/index.html#string">string</a> `json:"category,omitempty"`
|
|
Implementation *<a href="../../../../builtin/index.html#string">string</a> `json:"implementation,omitempty"`
|
|
Required *[]<a href="../../../../builtin/index.html#string">string</a> `json:"required,omitempty"`
|
|
Permitted *[]<a href="../../../../builtin/index.html#string">string</a> `json:"permitted,omitempty"`
|
|
Forbidden *[]<a href="../../../../builtin/index.html#string">string</a> `json:"forbidden,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
License represents an open source license.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="License.String">func (License) <a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go?s=1064:1096#L23">String</a></h3>
|
|
<pre>func (l <a href="index.html#License">License</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="LicensesService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go?s=357:385#L4">LicensesService</a></h2>
|
|
<pre>type LicensesService service</pre>
|
|
<p>
|
|
LicensesService handles communication with the license related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/pulls/">http://developer.github.com/v3/pulls/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="LicensesService.Get">func (*LicensesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go?s=1811:1889#L51">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#LicensesService">LicensesService</a>) Get(licenseName <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#License">License</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get extended metadata for one license.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/licenses/#get-an-individual-license">https://developer.github.com/v3/licenses/#get-an-individual-license</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="LicensesService.List">func (*LicensesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/licenses.go?s=1244:1307#L30">List</a></h3>
|
|
<pre>func (s *<a href="index.html#LicensesService">LicensesService</a>) List() ([]*<a href="index.html#License">License</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List popular open source licenses.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/licenses/#list-all-licenses">https://developer.github.com/v3/licenses/#list-all-licenses</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ListContributorsOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=13518:13660#L364">ListContributorsOptions</a></h2>
|
|
<pre>type ListContributorsOptions struct {
|
|
<span class="comment">// Include anonymous contributors in results or not</span>
|
|
Anon <a href="../../../../builtin/index.html#string">string</a> `url:"anon,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
ListContributorsOptions specifies the optional parameters to the
|
|
RepositoriesService.ListContributors method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ListMembersOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=1574:2216#L36">ListMembersOptions</a></h2>
|
|
<pre>type ListMembersOptions struct {
|
|
<span class="comment">// If true (or if the authenticated user is not an owner of the</span>
|
|
<span class="comment">// organization), list only publicly visible members.</span>
|
|
PublicOnly <a href="../../../../builtin/index.html#bool">bool</a> `url:"-"`
|
|
|
|
<span class="comment">// Filter members returned in the list. Possible values are:</span>
|
|
<span class="comment">// 2fa_disabled, all. Default is "all".</span>
|
|
Filter <a href="../../../../builtin/index.html#string">string</a> `url:"filter,omitempty"`
|
|
|
|
<span class="comment">// Role filters members returned by their role in the organization.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// all - all members of the organization, regardless of role</span>
|
|
<span class="comment">// admin - organization owners</span>
|
|
<span class="comment">// member - non-organization members</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Default is "all".</span>
|
|
Role <a href="../../../../builtin/index.html#string">string</a> `url:"role,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
ListMembersOptions specifies optional parameters to the
|
|
OrganizationsService.ListMembers method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=4810:5045#L124">ListOptions</a></h2>
|
|
<pre>type ListOptions struct {
|
|
<span class="comment">// For paginated result sets, page of results to retrieve.</span>
|
|
Page <a href="../../../../builtin/index.html#int">int</a> `url:"page,omitempty"`
|
|
|
|
<span class="comment">// For paginated result sets, the number of results to include per page.</span>
|
|
PerPage <a href="../../../../builtin/index.html#int">int</a> `url:"per_page,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ListOptions specifies the optional parameters to various List methods that
|
|
support pagination.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ListOrgMembershipsOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=5539:5749#L160">ListOrgMembershipsOptions</a></h2>
|
|
<pre>type ListOrgMembershipsOptions struct {
|
|
<span class="comment">// Filter memberships to include only those with the specified state.</span>
|
|
<span class="comment">// Possible values are: "active", "pending".</span>
|
|
State <a href="../../../../builtin/index.html#string">string</a> `url:"state,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
ListOrgMembershipsOptions specifies optional parameters to the
|
|
OrganizationsService.ListOrgMemberships method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MarkdownOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=298:883#L5">MarkdownOptions</a></h2>
|
|
<pre>type MarkdownOptions struct {
|
|
<span class="comment">// Mode identifies the rendering mode. Possible values are:</span>
|
|
<span class="comment">// markdown - render a document as plain Markdown, just like</span>
|
|
<span class="comment">// README files are rendered.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// gfm - to render a document as user-content, e.g. like user</span>
|
|
<span class="comment">// comments or issues are rendered. In GFM mode, hard line breaks are</span>
|
|
<span class="comment">// always taken into account, and issue and user mentions are linked</span>
|
|
<span class="comment">// accordingly.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Default is "markdown".</span>
|
|
Mode <a href="../../../../builtin/index.html#string">string</a>
|
|
|
|
<span class="comment">// Context identifies the repository context. Only taken into account</span>
|
|
<span class="comment">// when rendering as "gfm".</span>
|
|
Context <a href="../../../../builtin/index.html#string">string</a>
|
|
}</pre>
|
|
<p>
|
|
MarkdownOptions specifies optional parameters to the Markdown method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Match">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=2799:2905#L77">Match</a></h2>
|
|
<pre>type Match struct {
|
|
Text *<a href="../../../../builtin/index.html#string">string</a> `json:"text,omitempty"`
|
|
Indices []<a href="../../../../builtin/index.html#int">int</a> `json:"indices,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Match represents a single text match.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MemberEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=7207:7551#L179">MemberEvent</a></h2>
|
|
<pre>type MemberEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible value is: "added".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Member *<a href="index.html#User">User</a> `json:"member,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
MemberEvent is triggered when a user is added as a collaborator to a repository.
|
|
The Webhook event name is "member".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#memberevent">https://developer.github.com/v3/activity/events/types/#memberevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Membership">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=287:1407#L1">Membership</a></h2>
|
|
<pre>type Membership struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
|
|
<span class="comment">// State is the user's status within the organization or team.</span>
|
|
<span class="comment">// Possible values are: "active", "pending"</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
|
|
<span class="comment">// Role identifies the user's role within the organization or team.</span>
|
|
<span class="comment">// Possible values for organization membership:</span>
|
|
<span class="comment">// member - non-owner organization member</span>
|
|
<span class="comment">// admin - organization owner</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Possible values for team membership are:</span>
|
|
<span class="comment">// member - a normal member of the team</span>
|
|
<span class="comment">// maintainer - a team maintainer. Able to add/remove other team</span>
|
|
<span class="comment">// members, promote other team members to team</span>
|
|
<span class="comment">// maintainer, and edit the team’s name and description</span>
|
|
Role *<a href="../../../../builtin/index.html#string">string</a> `json:"role,omitempty"`
|
|
|
|
<span class="comment">// For organization membership, the API URL of the organization.</span>
|
|
OrganizationURL *<a href="../../../../builtin/index.html#string">string</a> `json:"organization_url,omitempty"`
|
|
|
|
<span class="comment">// For organization membership, the organization the membership is for.</span>
|
|
Organization *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
|
|
<span class="comment">// For organization membership, the user the membership is for.</span>
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Membership represents the status of a user's membership in an organization or team.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Membership.String">func (Membership) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=1409:1444#L30">String</a></h3>
|
|
<pre>func (m <a href="index.html#Membership">Membership</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MembershipEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=7875:8392#L196">MembershipEvent</a></h2>
|
|
<pre>type MembershipEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible values are: "added", "removed".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
<span class="comment">// Scope is the scope of the membership. Possible value is: "team".</span>
|
|
Scope *<a href="../../../../builtin/index.html#string">string</a> `json:"scope,omitempty"`
|
|
Member *<a href="index.html#User">User</a> `json:"member,omitempty"`
|
|
Team *<a href="index.html#Team">Team</a> `json:"team,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Org *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
MembershipEvent is triggered when a user is added or removed from a team.
|
|
The Webhook event name is "membership".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to
|
|
trigger organization webhooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#membershipevent">https://developer.github.com/v3/activity/events/types/#membershipevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Migration">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=483:1578#L12">Migration</a></h2>
|
|
<pre>type Migration struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
GUID *<a href="../../../../builtin/index.html#string">string</a> `json:"guid,omitempty"`
|
|
<span class="comment">// State is the current state of a migration.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// "pending" which means the migration hasn't started yet,</span>
|
|
<span class="comment">// "exporting" which means the migration is in progress,</span>
|
|
<span class="comment">// "exported" which means the migration finished successfully, or</span>
|
|
<span class="comment">// "failed" which means the migration failed.</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
<span class="comment">// LockRepositories indicates whether repositories are locked (to prevent</span>
|
|
<span class="comment">// manipulation) while migrating data.</span>
|
|
LockRepositories *<a href="../../../../builtin/index.html#bool">bool</a> `json:"lock_repositories,omitempty"`
|
|
<span class="comment">// ExcludeAttachments indicates whether attachments should be excluded from</span>
|
|
<span class="comment">// the migration (to reduce migration archive file size).</span>
|
|
ExcludeAttachments *<a href="../../../../builtin/index.html#bool">bool</a> `json:"exclude_attachments,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
CreatedAt *<a href="../../../../builtin/index.html#string">string</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../builtin/index.html#string">string</a> `json:"updated_at,omitempty"`
|
|
Repositories []*<a href="index.html#Repository">Repository</a> `json:"repositories,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Migration represents a GitHub migration (archival).
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Migration.String">func (Migration) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=1580:1614#L34">String</a></h3>
|
|
<pre>func (m <a href="index.html#Migration">Migration</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MigrationOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=1717:2055#L39">MigrationOptions</a></h2>
|
|
<pre>type MigrationOptions struct {
|
|
<span class="comment">// LockRepositories indicates whether repositories should be locked (to prevent</span>
|
|
<span class="comment">// manipulation) while migrating data.</span>
|
|
LockRepositories <a href="../../../../builtin/index.html#bool">bool</a>
|
|
|
|
<span class="comment">// ExcludeAttachments indicates whether attachments should be excluded from</span>
|
|
<span class="comment">// the migration (to reduce migration archive file size).</span>
|
|
ExcludeAttachments <a href="../../../../builtin/index.html#bool">bool</a>
|
|
}</pre>
|
|
<p>
|
|
MigrationOptions specifies the optional parameters to Migration methods.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MigrationService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=397:426#L9">MigrationService</a></h2>
|
|
<pre>type MigrationService service</pre>
|
|
<p>
|
|
MigrationService provides access to the migration related functions
|
|
in the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/">https://developer.github.com/v3/migration/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.CancelImport">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=12134:12212#L305">CancelImport</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) CancelImport(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CancelImport stops an import for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#cancel-an-import">https://developer.github.com/v3/migration/source_imports/#cancel-an-import</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.CommitAuthors">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=9175:9277#L213">CommitAuthors</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) CommitAuthors(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#SourceImportAuthor">SourceImportAuthor</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CommitAuthors gets the authors mapped from the original repository.
|
|
</p>
|
|
<p>
|
|
Each type of source control system represents authors in a different way.
|
|
For example, a Git commit author has a display name and an email address,
|
|
but a Subversion commit author just has a username. The GitHub Importer will
|
|
make the author information valid, but the author might not be correct. For
|
|
example, it will change the bare Subversion username "hubot" into something
|
|
like "hubot <hubot@12341234-abab-fefe-8787-fedcba987654>".
|
|
</p>
|
|
<p>
|
|
This method and MapCommitAuthor allow you to provide correct Git author
|
|
information.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#get-commit-authors">https://developer.github.com/v3/migration/source_imports/#get-commit-authors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.DeleteMigration">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=6293:6374#L181">DeleteMigration</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) DeleteMigration(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteMigration deletes a previous migration archive.
|
|
id is the migration ID.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive">https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.ImportProgress">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=7327:7416#L159">ImportProgress</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) ImportProgress(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Import">Import</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
QueryImport queries for the status and progress of an ongoing repository import.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#get-import-progress">https://developer.github.com/v3/migration/source_imports/#get-import-progress</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.LargeFiles">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=11478:11568#L283">LargeFiles</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) LargeFiles(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#LargeFile">LargeFile</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
LargeFiles lists files larger than 100MB found during the import.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#get-large-files">https://developer.github.com/v3/migration/source_imports/#get-large-files</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.ListMigrations">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=3709:3795#L96">ListMigrations</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) ListMigrations(org <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#Migration">Migration</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListMigrations lists the most recent migrations.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations">https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.MapCommitAuthor">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=9980:10118#L237">MapCommitAuthor</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) MapCommitAuthor(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, author *<a href="index.html#SourceImportAuthor">SourceImportAuthor</a>) (*<a href="index.html#SourceImportAuthor">SourceImportAuthor</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MapCommitAuthor updates an author's identity for the import. Your
|
|
application can continue updating authors any time before you push new
|
|
commits to the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#map-a-commit-author">https://developer.github.com/v3/migration/source_imports/#map-a-commit-author</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.MigrationArchiveURL">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=5060:5150#L144">MigrationArchiveURL</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) MigrationArchiveURL(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (url <a href="../../../../builtin/index.html#string">string</a>, err <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MigrationArchiveURL fetches a migration archive URL.
|
|
id is the migration ID.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#download-a-migration-archive">https://developer.github.com/v3/migration/migrations/#download-a-migration-archive</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.MigrationStatus">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=4385:4478#L120">MigrationStatus</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) MigrationStatus(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Migration">Migration</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
MigrationStatus gets the status of a specific migration archive.
|
|
id is the migration ID.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration">https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.SetLFSPreference">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=10811:10914#L261">SetLFSPreference</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) SetLFSPreference(owner, repo <a href="../../../../builtin/index.html#string">string</a>, in *<a href="index.html#Import">Import</a>) (*<a href="index.html#Import">Import</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
SetLFSPreference sets whether imported repositories should use Git LFS for
|
|
files larger than 100MB. Only the UseLFS field on the provided Import is
|
|
used.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference">https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.StartImport">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=6652:6750#L137">StartImport</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) StartImport(owner, repo <a href="../../../../builtin/index.html#string">string</a>, in *<a href="index.html#Import">Import</a>) (*<a href="index.html#Import">Import</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
StartImport initiates a repository import.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#start-an-import">https://developer.github.com/v3/migration/source_imports/#start-an-import</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.StartMigration">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=2867:2990#L67">StartMigration</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) StartMigration(org <a href="../../../../builtin/index.html#string">string</a>, repos []<a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#MigrationOptions">MigrationOptions</a>) (*<a href="index.html#Migration">Migration</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
StartMigration starts the generation of a migration archive.
|
|
repos is a slice of repository names to migrate.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#start-a-migration">https://developer.github.com/v3/migration/migrations/#start-a-migration</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.UnlockRepo">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations.go?s=7010:7099#L201">UnlockRepo</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) UnlockRepo(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UnlockRepo unlocks a repository that was locked for migration.
|
|
id is the migration ID.
|
|
You should unlock each migrated repository and delete them when the migration
|
|
is complete and you no longer need the source data.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/migrations/#unlock-a-repository">https://developer.github.com/v3/migration/migrations/#unlock-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="MigrationService.UpdateImport">func (*MigrationService) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=7960:8059#L181">UpdateImport</a></h3>
|
|
<pre>func (s *<a href="index.html#MigrationService">MigrationService</a>) UpdateImport(owner, repo <a href="../../../../builtin/index.html#string">string</a>, in *<a href="index.html#Import">Import</a>) (*<a href="index.html#Import">Import</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UpdateImport initiates a repository import.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#update-existing-import">https://developer.github.com/v3/migration/source_imports/#update-existing-import</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Milestone">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=268:1084#L4">Milestone</a></h2>
|
|
<pre>type Milestone struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
LabelsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"labels_url,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Number *<a href="../../../../builtin/index.html#int">int</a> `json:"number,omitempty"`
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Creator *<a href="index.html#User">User</a> `json:"creator,omitempty"`
|
|
OpenIssues *<a href="../../../../builtin/index.html#int">int</a> `json:"open_issues,omitempty"`
|
|
ClosedIssues *<a href="../../../../builtin/index.html#int">int</a> `json:"closed_issues,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
ClosedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"closed_at,omitempty"`
|
|
DueOn *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"due_on,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Milestone represents a Github repository milestone.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Milestone.String">func (Milestone) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=1086:1120#L22">String</a></h3>
|
|
<pre>func (m <a href="index.html#Milestone">Milestone</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="MilestoneListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_milestones.go?s=1252:1751#L28">MilestoneListOptions</a></h2>
|
|
<pre>type MilestoneListOptions struct {
|
|
<span class="comment">// State filters milestones based on their state. Possible values are:</span>
|
|
<span class="comment">// open, closed. Default is "open".</span>
|
|
State <a href="../../../../builtin/index.html#string">string</a> `url:"state,omitempty"`
|
|
|
|
<span class="comment">// Sort specifies how to sort milestones. Possible values are: due_date, completeness.</span>
|
|
<span class="comment">// Default value is "due_date".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort milestones. Possible values are: asc, desc.</span>
|
|
<span class="comment">// Default is "asc".</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
MilestoneListOptions specifies the optional parameters to the
|
|
IssuesService.ListMilestones method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="NewPullRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=4472:4699#L124">NewPullRequest</a></h2>
|
|
<pre>type NewPullRequest struct {
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Head *<a href="../../../../builtin/index.html#string">string</a> `json:"head,omitempty"`
|
|
Base *<a href="../../../../builtin/index.html#string">string</a> `json:"base,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
Issue *<a href="../../../../builtin/index.html#int">int</a> `json:"issue,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
NewPullRequest represents a new pull request to be created.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Notification">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=274:894#L4">Notification</a></h2>
|
|
<pre>type Notification struct {
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
Repository *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Subject *<a href="index.html#NotificationSubject">NotificationSubject</a> `json:"subject,omitempty"`
|
|
|
|
<span class="comment">// Reason identifies the event that triggered the notification.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// GitHub API Docs: https://developer.github.com/v3/activity/notifications/#notification-reasons</span>
|
|
Reason *<a href="../../../../builtin/index.html#string">string</a> `json:"reason,omitempty"`
|
|
|
|
Unread *<a href="../../../../builtin/index.html#bool">bool</a> `json:"unread,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
LastReadAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"last_read_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Notification identifies a GitHub notification for a user.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="NotificationListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=1325:1581#L30">NotificationListOptions</a></h2>
|
|
<pre>type NotificationListOptions struct {
|
|
All <a href="../../../../builtin/index.html#bool">bool</a> `url:"all,omitempty"`
|
|
Participating <a href="../../../../builtin/index.html#bool">bool</a> `url:"participating,omitempty"`
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
Before <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"before,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
NotificationListOptions specifies the optional parameters to the
|
|
ActivityService.ListNotifications method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="NotificationSubject">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_notifications.go?s=961:1210#L21">NotificationSubject</a></h2>
|
|
<pre>type NotificationSubject struct {
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
LatestCommentURL *<a href="../../../../builtin/index.html#string">string</a> `json:"latest_comment_url,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
NotificationSubject identifies the subject of a notification.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Organization">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=466:2149#L10">Organization</a></h2>
|
|
<pre>type Organization struct {
|
|
Login *<a href="../../../../builtin/index.html#string">string</a> `json:"login,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
AvatarURL *<a href="../../../../builtin/index.html#string">string</a> `json:"avatar_url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Company *<a href="../../../../builtin/index.html#string">string</a> `json:"company,omitempty"`
|
|
Blog *<a href="../../../../builtin/index.html#string">string</a> `json:"blog,omitempty"`
|
|
Location *<a href="../../../../builtin/index.html#string">string</a> `json:"location,omitempty"`
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
PublicRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"public_repos,omitempty"`
|
|
PublicGists *<a href="../../../../builtin/index.html#int">int</a> `json:"public_gists,omitempty"`
|
|
Followers *<a href="../../../../builtin/index.html#int">int</a> `json:"followers,omitempty"`
|
|
Following *<a href="../../../../builtin/index.html#int">int</a> `json:"following,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
TotalPrivateRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"total_private_repos,omitempty"`
|
|
OwnedPrivateRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"owned_private_repos,omitempty"`
|
|
PrivateGists *<a href="../../../../builtin/index.html#int">int</a> `json:"private_gists,omitempty"`
|
|
DiskUsage *<a href="../../../../builtin/index.html#int">int</a> `json:"disk_usage,omitempty"`
|
|
Collaborators *<a href="../../../../builtin/index.html#int">int</a> `json:"collaborators,omitempty"`
|
|
BillingEmail *<a href="../../../../builtin/index.html#string">string</a> `json:"billing_email,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
Plan *<a href="index.html#Plan">Plan</a> `json:"plan,omitempty"`
|
|
|
|
<span class="comment">// API URLs</span>
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
EventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"events_url,omitempty"`
|
|
MembersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"members_url,omitempty"`
|
|
PublicMembersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"public_members_url,omitempty"`
|
|
ReposURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repos_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Organization represents a GitHub organization account.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Organization.String">func (Organization) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=2151:2188#L43">String</a></h3>
|
|
<pre>func (o <a href="index.html#Organization">Organization</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="OrganizationAddTeamMembershipOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=9814:10282#L312">OrganizationAddTeamMembershipOptions</a></h2>
|
|
<pre>type OrganizationAddTeamMembershipOptions struct {
|
|
<span class="comment">// Role specifies the role the user should have in the team. Possible</span>
|
|
<span class="comment">// values are:</span>
|
|
<span class="comment">// member - a normal member of the team</span>
|
|
<span class="comment">// maintainer - a team maintainer. Able to add/remove other team</span>
|
|
<span class="comment">// members, promote other team members to team</span>
|
|
<span class="comment">// maintainer, and edit the team’s name and description</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Default value is "member".</span>
|
|
Role <a href="../../../../builtin/index.html#string">string</a> `json:"role,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
OrganizationAddTeamMembershipOptions does stuff specifies the optional
|
|
parameters to the OrganizationsService.AddTeamMembership method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="OrganizationAddTeamRepoOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=6926:7437#L227">OrganizationAddTeamRepoOptions</a></h2>
|
|
<pre>type OrganizationAddTeamRepoOptions struct {
|
|
<span class="comment">// Permission specifies the permission to grant the team on this repository.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// pull - team members can pull, but not push to or administer this repository</span>
|
|
<span class="comment">// push - team members can pull and push, but not administer this repository</span>
|
|
<span class="comment">// admin - team members can pull, push and administer this repository</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// If not specified, the team's permission attribute will be used.</span>
|
|
Permission <a href="../../../../builtin/index.html#string">string</a> `json:"permission,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
OrganizationAddTeamRepoOptions specifies the optional parameters to the
|
|
OrganizationsService.AddTeamRepo method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="OrganizationListTeamMembersOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=4041:4277#L130">OrganizationListTeamMembersOptions</a></h2>
|
|
<pre>type OrganizationListTeamMembersOptions struct {
|
|
<span class="comment">// Role filters members returned by their role in the team. Possible</span>
|
|
<span class="comment">// values are "all", "member", "maintainer". Default is "all".</span>
|
|
Role <a href="../../../../builtin/index.html#string">string</a> `url:"role,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
OrganizationListTeamMembersOptions specifies the optional parameters to the
|
|
OrganizationsService.ListTeamMembers method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="OrganizationsListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=2701:2829#L61">OrganizationsListOptions</a></h2>
|
|
<pre>type OrganizationsListOptions struct {
|
|
<span class="comment">// Since filters Organizations by ID.</span>
|
|
Since <a href="../../../../builtin/index.html#int">int</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
OrganizationsListOptions specifies the optional parameters to the
|
|
OrganizationsService.ListAll method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="OrganizationsService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=373:406#L7">OrganizationsService</a></h2>
|
|
<pre>type OrganizationsService service</pre>
|
|
<p>
|
|
OrganizationsService provides access to the organization related functions
|
|
in the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/">http://developer.github.com/v3/orgs/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.AddTeamMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=11233:11379#L342">AddTeamMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) AddTeamMembership(team <a href="../../../../builtin/index.html#int">int</a>, user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#OrganizationAddTeamMembershipOptions">OrganizationAddTeamMembershipOptions</a>) (*<a href="index.html#Membership">Membership</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddTeamMembership adds or invites a user to a team.
|
|
</p>
|
|
<p>
|
|
In order to add a membership between a user and a team, the authenticated
|
|
user must have 'admin' permissions to the team or be an owner of the
|
|
organization that the team is associated with.
|
|
</p>
|
|
<p>
|
|
If the user is already a part of the team's organization (meaning they're on
|
|
at least one other team in the organization), this endpoint will add the
|
|
user to the team.
|
|
</p>
|
|
<p>
|
|
If the user is completely unaffiliated with the team's organization (meaning
|
|
they're on none of the organization's teams), this endpoint will send an
|
|
invitation to the user via email. This newly-created membership will be in
|
|
the "pending" state until the user accepts the invitation, at which point
|
|
the membership will transition to the "active" state and the user will be
|
|
added as a member of the team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/teams/#add-team-membership">https://developer.github.com/v3/orgs/teams/#add-team-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.AddTeamRepo">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=7742:7877#L243">AddTeamRepo</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) AddTeamRepo(team <a href="../../../../builtin/index.html#int">int</a>, owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#OrganizationAddTeamRepoOptions">OrganizationAddTeamRepoOptions</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddTeamRepo adds a repository to be managed by the specified team. The
|
|
specified repository must be owned by the organization to which the team
|
|
belongs, or a direct fork of a repository owned by the organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#add-team-repo">http://developer.github.com/v3/orgs/teams/#add-team-repo</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ConcealMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=5153:5238#L148">ConcealMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ConcealMembership(org, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ConcealMembership conceals a user's membership in an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#conceal-a-users-membership">http://developer.github.com/v3/orgs/members/#conceal-a-users-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.CreateHook">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=1389:1480#L42">CreateHook</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) CreateHook(org <a href="../../../../builtin/index.html#string">string</a>, hook *<a href="index.html#Hook">Hook</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateHook creates a Hook for the specified org.
|
|
Name and Config are required fields.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#create-a-hook">https://developer.github.com/v3/orgs/hooks/#create-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.CreateTeam">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=2789:2880#L80">CreateTeam</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) CreateTeam(org <a href="../../../../builtin/index.html#string">string</a>, team *<a href="index.html#Team">Team</a>) (*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateTeam creates a new team within an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#create-team">http://developer.github.com/v3/orgs/teams/#create-team</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.DeleteHook">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=2682:2762#L87">DeleteHook</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) DeleteHook(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteHook deletes a specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#delete-a-hook">https://developer.github.com/v3/orgs/hooks/#delete-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.DeleteTeam">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=3682:3752#L118">DeleteTeam</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) DeleteTeam(team <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteTeam deletes a team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#delete-team">http://developer.github.com/v3/orgs/teams/#delete-team</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.Edit">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=4953:5054#L146">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) Edit(name <a href="../../../../builtin/index.html#string">string</a>, org *<a href="index.html#Organization">Organization</a>) (*<a href="index.html#Organization">Organization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/#edit-an-organization">http://developer.github.com/v3/orgs/#edit-an-organization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.EditHook">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=1853:1950#L61">EditHook</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) EditHook(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, hook *<a href="index.html#Hook">Hook</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditHook updates a specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#edit-a-hook">https://developer.github.com/v3/orgs/hooks/#edit-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.EditOrgMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=7648:7770#L226">EditOrgMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) EditOrgMembership(user, org <a href="../../../../builtin/index.html#string">string</a>, membership *<a href="index.html#Membership">Membership</a>) (*<a href="index.html#Membership">Membership</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditOrgMembership edits the membership for user in specified organization.
|
|
Passing an empty string for user will edit the membership for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership">https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership</a>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#edit-your-organization-membership">https://developer.github.com/v3/orgs/members/#edit-your-organization-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.EditTeam">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=3238:3323#L99">EditTeam</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) EditTeam(id <a href="../../../../builtin/index.html#int">int</a>, team *<a href="index.html#Team">Team</a>) (*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditTeam edits a team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#edit-team">http://developer.github.com/v3/orgs/teams/#edit-team</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.Get">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=4478:4558#L127">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) Get(org <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Organization">Organization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get fetches an organization by name.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/#get-an-organization">http://developer.github.com/v3/orgs/#get-an-organization</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.GetHook">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=908:992#L27">GetHook</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) GetHook(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetHook returns a single specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#get-single-hook">https://developer.github.com/v3/orgs/hooks/#get-single-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.GetOrgMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=6776:6873#L198">GetOrgMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) GetOrgMembership(user, org <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Membership">Membership</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetOrgMembership gets the membership for a user in a specified organization.
|
|
Passing an empty string for user will get the membership for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#get-organization-membership">https://developer.github.com/v3/orgs/members/#get-organization-membership</a>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#get-your-organization-membership">https://developer.github.com/v3/orgs/members/#get-your-organization-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.GetTeam">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=2330:2404#L61">GetTeam</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) GetTeam(team <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetTeam fetches a team by ID.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#get-team">http://developer.github.com/v3/orgs/teams/#get-team</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.GetTeamMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=9292:9395#L294">GetTeamMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) GetTeamMembership(team <a href="../../../../builtin/index.html#int">int</a>, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Membership">Membership</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetTeamMembership returns the membership status for a user in a team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/teams/#get-team-membership">https://developer.github.com/v3/orgs/teams/#get-team-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.IsMember">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=3233:3315#L91">IsMember</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) IsMember(org, user <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsMember checks if a user is a member of an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#check-membership">http://developer.github.com/v3/orgs/members/#check-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.IsPublicMember">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=3733:3821#L106">IsPublicMember</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) IsPublicMember(org, user <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsPublicMember checks if a user is a public member of an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#check-public-membership">http://developer.github.com/v3/orgs/members/#check-public-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.IsTeamMember">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=5076:5167#L166">IsTeamMember</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) IsTeamMember(team <a href="../../../../builtin/index.html#int">int</a>, user <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsTeamMember checks if a user is a member of the specified team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#get-team-member">http://developer.github.com/v3/orgs/teams/#get-team-member</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.IsTeamRepo">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=6334:6444#L207">IsTeamRepo</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) IsTeamRepo(team <a href="../../../../builtin/index.html#int">int</a>, owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsTeamRepo checks if a team manages the specified repository. If the
|
|
repository is managed by team, a Repository is returned which includes the
|
|
permissions team has for that repo.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/teams/#check-if-a-team-manages-a-repository">https://developer.github.com/v3/orgs/teams/#check-if-a-team-manages-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.List">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=3844:3946#L98">List</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) List(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Organization">Organization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List the organizations for a user. Passing the empty string will list
|
|
organizations for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/#list-user-organizations">http://developer.github.com/v3/orgs/#list-user-organizations</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListAll">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=3217:3322#L75">ListAll</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListAll(opt *<a href="index.html#OrganizationsListOptions">OrganizationsListOptions</a>) ([]*<a href="index.html#Organization">Organization</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListAll lists all organizations, in the order that they were created on GitHub.
|
|
</p>
|
|
<p>
|
|
Note: Pagination is powered exclusively by the since parameter. To continue
|
|
listing the next set of organizations, use the ID of the last-returned organization
|
|
as the opts.Since parameter for the next call.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/#list-all-organizations">https://developer.github.com/v3/orgs/#list-all-organizations</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListHooks">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=339:437#L3">ListHooks</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListHooks(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListHooks lists all Hooks for the specified organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#list-hooks">https://developer.github.com/v3/orgs/hooks/#list-hooks</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListMembers">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=2517:2624#L62">ListMembers</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListMembers(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListMembersOptions">ListMembersOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListMembers lists the members for an organization. If the authenticated
|
|
user is an owner of the organization, this will return both concealed and
|
|
public members, otherwise it will only return public members.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#members-list">http://developer.github.com/v3/orgs/members/#members-list</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListOrgMemberships">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=5940:6055#L171">ListOrgMemberships</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListOrgMemberships(opt *<a href="index.html#ListOrgMembershipsOptions">ListOrgMembershipsOptions</a>) ([]*<a href="index.html#Membership">Membership</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListOrgMemberships lists the organization memberships for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#list-your-organization-memberships">https://developer.github.com/v3/orgs/members/#list-your-organization-memberships</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListTeamMembers">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=4447:4572#L142">ListTeamMembers</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListTeamMembers(team <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#OrganizationListTeamMembersOptions">OrganizationListTeamMembersOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListTeamMembers lists all of the users who are members of the specified
|
|
team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#list-team-members">http://developer.github.com/v3/orgs/teams/#list-team-members</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListTeamRepos">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=5582:5688#L181">ListTeamRepos</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListTeamRepos(team <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListTeamRepos lists the repositories that the specified team has access to.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#list-team-repos">http://developer.github.com/v3/orgs/teams/#list-team-repos</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListTeams">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=1780:1878#L37">ListTeams</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListTeams(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListTeams lists all of the teams for an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#list-teams">http://developer.github.com/v3/orgs/teams/#list-teams</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.ListUserTeams">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=8719:8809#L270">ListUserTeams</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) ListUserTeams(opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListUserTeams lists a user's teams
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/teams/#list-user-teams">https://developer.github.com/v3/orgs/teams/#list-user-teams</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.PingHook">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_hooks.go?s=2307:2385#L75">PingHook</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) PingHook(org <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
PingHook triggers a 'ping' event to be sent to the Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/hooks/#ping-a-hook">https://developer.github.com/v3/orgs/hooks/#ping-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.PublicizeMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=4720:4807#L135">PublicizeMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) PublicizeMembership(org, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
PublicizeMembership publicizes a user's membership in an organization. (A
|
|
user cannot publicize the membership for another user.)
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#publicize-a-users-membership">http://developer.github.com/v3/orgs/members/#publicize-a-users-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.RemoveMember">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=4230:4310#L121">RemoveMember</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) RemoveMember(org, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveMember removes a user from all teams of an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/members/#remove-a-member">http://developer.github.com/v3/orgs/members/#remove-a-member</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.RemoveOrgMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_members.go?s=8451:8538#L254">RemoveOrgMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) RemoveOrgMembership(user, org <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveOrgMembership removes user from the specified organization. If the
|
|
user has been invited to the organization, this will cancel their invitation.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/members/#remove-organization-membership">https://developer.github.com/v3/orgs/members/#remove-organization-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.RemoveTeamMembership">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=11798:11891#L361">RemoveTeamMembership</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) RemoveTeamMembership(team <a href="../../../../builtin/index.html#int">int</a>, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveTeamMembership removes a user from a team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/orgs/teams/#remove-team-membership">https://developer.github.com/v3/orgs/teams/#remove-team-membership</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="OrganizationsService.RemoveTeamRepo">func (*OrganizationsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=8313:8414#L258">RemoveTeamRepo</a></h3>
|
|
<pre>func (s *<a href="index.html#OrganizationsService">OrganizationsService</a>) RemoveTeamRepo(team <a href="../../../../builtin/index.html#int">int</a>, owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveTeamRepo removes a repository from being managed by the specified
|
|
team. Note that this does not delete the repository, it just removes it
|
|
from the team.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/orgs/teams/#remove-team-repo">http://developer.github.com/v3/orgs/teams/#remove-team-repo</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Page">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=4039:4325#L95">Page</a></h2>
|
|
<pre>type Page struct {
|
|
PageName *<a href="../../../../builtin/index.html#string">string</a> `json:"page_name,omitempty"`
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Summary *<a href="../../../../builtin/index.html#string">string</a> `json:"summary,omitempty"`
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Page represents a single Wiki page.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PageBuildEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=8865:9141#L219">PageBuildEvent</a></h2>
|
|
<pre>type PageBuildEvent struct {
|
|
Build *<a href="index.html#PagesBuild">PagesBuild</a> `json:"build,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PageBuildEvent represents an attempted build of a GitHub Pages site, whether
|
|
successful or not.
|
|
The Webhook event name is "page_build".
|
|
</p>
|
|
<p>
|
|
This event is triggered on push to a GitHub Pages enabled branch (gh-pages
|
|
for project pages, master for user and organization pages).
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to trigger hooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#pagebuildevent">https://developer.github.com/v3/activity/events/types/#pagebuildevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Pages">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=255:503#L1">Pages</a></h2>
|
|
<pre>type Pages struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Status *<a href="../../../../builtin/index.html#string">string</a> `json:"status,omitempty"`
|
|
CNAME *<a href="../../../../builtin/index.html#string">string</a> `json:"cname,omitempty"`
|
|
Custom404 *<a href="../../../../builtin/index.html#bool">bool</a> `json:"custom_404,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Pages represents a GitHub Pages site configuration.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PagesBuild">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=713:1137#L15">PagesBuild</a></h2>
|
|
<pre>type PagesBuild struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Status *<a href="../../../../builtin/index.html#string">string</a> `json:"status,omitempty"`
|
|
Error *<a href="index.html#PagesError">PagesError</a> `json:"error,omitempty"`
|
|
Pusher *<a href="index.html#User">User</a> `json:"pusher,omitempty"`
|
|
Commit *<a href="../../../../builtin/index.html#string">string</a> `json:"commit,omitempty"`
|
|
Duration *<a href="../../../../builtin/index.html#int">int</a> `json:"duration,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PagesBuild represents the build information for a GitHub Pages site.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PagesError">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=569:639#L10">PagesError</a></h2>
|
|
<pre>type PagesError struct {
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PagesError represents a build error for a GitHub Pages site.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Plan">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=2307:2534#L48">Plan</a></h2>
|
|
<pre>type Plan struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Space *<a href="../../../../builtin/index.html#int">int</a> `json:"space,omitempty"`
|
|
Collaborators *<a href="../../../../builtin/index.html#int">int</a> `json:"collaborators,omitempty"`
|
|
PrivateRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"private_repos,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Plan represents the payment plan for an account. See plans at <a href="https://github.com/plans">https://github.com/plans</a>.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Plan.String">func (Plan) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs.go?s=2536:2565#L55">String</a></h3>
|
|
<pre>func (p <a href="index.html#Plan">Plan</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Protection">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=16819:17002#L485">Protection</a></h2>
|
|
<pre>type Protection struct {
|
|
Enabled *<a href="../../../../builtin/index.html#bool">bool</a> `json:"enabled,omitempty"`
|
|
RequiredStatusChecks *<a href="index.html#RequiredStatusChecks">RequiredStatusChecks</a> `json:"required_status_checks,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Protection represents a repository branch's protection
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PublicEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=9405:9591#L233">PublicEvent</a></h2>
|
|
<pre>type PublicEvent struct {
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PublicEvent is triggered when a private repository is open sourced.
|
|
According to GitHub: "Without a doubt: the best GitHub event."
|
|
The Webhook event name is "public".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#publicevent">https://developer.github.com/v3/activity/events/types/#publicevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=478:1949#L10">PullRequest</a></h2>
|
|
<pre>type PullRequest struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Number *<a href="../../../../builtin/index.html#int">int</a> `json:"number,omitempty"`
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Title *<a href="../../../../builtin/index.html#string">string</a> `json:"title,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
ClosedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"closed_at,omitempty"`
|
|
MergedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"merged_at,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
Merged *<a href="../../../../builtin/index.html#bool">bool</a> `json:"merged,omitempty"`
|
|
Mergeable *<a href="../../../../builtin/index.html#bool">bool</a> `json:"mergeable,omitempty"`
|
|
MergedBy *<a href="index.html#User">User</a> `json:"merged_by,omitempty"`
|
|
Comments *<a href="../../../../builtin/index.html#int">int</a> `json:"comments,omitempty"`
|
|
Commits *<a href="../../../../builtin/index.html#int">int</a> `json:"commits,omitempty"`
|
|
Additions *<a href="../../../../builtin/index.html#int">int</a> `json:"additions,omitempty"`
|
|
Deletions *<a href="../../../../builtin/index.html#int">int</a> `json:"deletions,omitempty"`
|
|
ChangedFiles *<a href="../../../../builtin/index.html#int">int</a> `json:"changed_files,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
IssueURL *<a href="../../../../builtin/index.html#string">string</a> `json:"issue_url,omitempty"`
|
|
StatusesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"statuses_url,omitempty"`
|
|
DiffURL *<a href="../../../../builtin/index.html#string">string</a> `json:"diff_url,omitempty"`
|
|
PatchURL *<a href="../../../../builtin/index.html#string">string</a> `json:"patch_url,omitempty"`
|
|
Assignee *<a href="index.html#User">User</a> `json:"assignee,omitempty"` <span class="comment">// probably only in webhooks</span>
|
|
|
|
Head *<a href="index.html#PullRequestBranch">PullRequestBranch</a> `json:"head,omitempty"`
|
|
Base *<a href="index.html#PullRequestBranch">PullRequestBranch</a> `json:"base,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequest represents a GitHub pull request on a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequest.String">func (PullRequest) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=1951:1987#L41">String</a></h3>
|
|
<pre>func (p <a href="index.html#PullRequest">PullRequest</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestBranch">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=2094:2341#L46">PullRequestBranch</a></h2>
|
|
<pre>type PullRequestBranch struct {
|
|
Label *<a href="../../../../builtin/index.html#string">string</a> `json:"label,omitempty"`
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repo,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestBranch represents a base or head branch in a GitHub pull request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestComment">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=280:1240#L4">PullRequestComment</a></h2>
|
|
<pre>type PullRequestComment struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
InReplyTo *<a href="../../../../builtin/index.html#int">int</a> `json:"in_reply_to,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
DiffHunk *<a href="../../../../builtin/index.html#string">string</a> `json:"diff_hunk,omitempty"`
|
|
Position *<a href="../../../../builtin/index.html#int">int</a> `json:"position,omitempty"`
|
|
OriginalPosition *<a href="../../../../builtin/index.html#int">int</a> `json:"original_position,omitempty"`
|
|
CommitID *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_id,omitempty"`
|
|
OriginalCommitID *<a href="../../../../builtin/index.html#string">string</a> `json:"original_commit_id,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
Reactions *<a href="index.html#Reactions">Reactions</a> `json:"reactions,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
PullRequestURL *<a href="../../../../builtin/index.html#string">string</a> `json:"pull_request_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestComment represents a comment left on a pull request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestComment.String">func (PullRequestComment) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=1242:1285#L23">String</a></h3>
|
|
<pre>func (p <a href="index.html#PullRequestComment">PullRequestComment</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=9873:10658#L244">PullRequestEvent</a></h2>
|
|
<pre>type PullRequestEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible values are: "assigned",</span>
|
|
<span class="comment">// "unassigned", "labeled", "unlabeled", "opened", "closed", or "reopened",</span>
|
|
<span class="comment">// "synchronize", "edited". If the action is "closed" and the merged key is false,</span>
|
|
<span class="comment">// the pull request was closed with unmerged commits. If the action is "closed"</span>
|
|
<span class="comment">// and the merged key is true, the pull request was merged.</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Number *<a href="../../../../builtin/index.html#int">int</a> `json:"number,omitempty"`
|
|
PullRequest *<a href="index.html#PullRequest">PullRequest</a> `json:"pull_request,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Changes *<a href="index.html#EditChange">EditChange</a> `json:"changes,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestEvent is triggered when a pull request is assigned, unassigned,
|
|
labeled, unlabeled, opened, closed, reopened, or synchronized.
|
|
The Webhook event name is "pull_request".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#pullrequestevent">https://developer.github.com/v3/activity/events/types/#pullrequestevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestLinks">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues.go?s=3641:3853#L83">PullRequestLinks</a></h2>
|
|
<pre>type PullRequestLinks struct {
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
DiffURL *<a href="../../../../builtin/index.html#string">string</a> `json:"diff_url,omitempty"`
|
|
PatchURL *<a href="../../../../builtin/index.html#string">string</a> `json:"patch_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestLinks object is added to the Issue object when it's an issue included
|
|
in the IssueCommentEvent webhook payload, if the webhooks is fired by a comment on a PR
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestListCommentsOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=1431:1807#L29">PullRequestListCommentsOptions</a></h2>
|
|
<pre>type PullRequestListCommentsOptions struct {
|
|
<span class="comment">// Sort specifies how to sort comments. Possible values are: created, updated.</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort comments. Possible values are: asc, desc.</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<span class="comment">// Since filters comments by time.</span>
|
|
Since <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
PullRequestListCommentsOptions specifies the optional parameters to the
|
|
PullRequestsService.ListComments method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=2446:3267#L56">PullRequestListOptions</a></h2>
|
|
<pre>type PullRequestListOptions struct {
|
|
<span class="comment">// State filters pull requests based on their state. Possible values are:</span>
|
|
<span class="comment">// open, closed. Default is "open".</span>
|
|
State <a href="../../../../builtin/index.html#string">string</a> `url:"state,omitempty"`
|
|
|
|
<span class="comment">// Head filters pull requests by head user and branch name in the format of:</span>
|
|
<span class="comment">// "user:ref-name".</span>
|
|
Head <a href="../../../../builtin/index.html#string">string</a> `url:"head,omitempty"`
|
|
|
|
<span class="comment">// Base filters pull requests by base branch name.</span>
|
|
Base <a href="../../../../builtin/index.html#string">string</a> `url:"base,omitempty"`
|
|
|
|
<span class="comment">// Sort specifies how to sort pull requests. Possible values are: created,</span>
|
|
<span class="comment">// updated, popularity, long-running. Default is "created".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort pull requests. Possible values are: asc, desc.</span>
|
|
<span class="comment">// If Sort is "created" or not specified, Default is "desc", otherwise Default</span>
|
|
<span class="comment">// is "asc"</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
PullRequestListOptions specifies the optional parameters to the
|
|
PullRequestsService.List method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestMergeResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=7695:7860#L234">PullRequestMergeResult</a></h2>
|
|
<pre>type PullRequestMergeResult struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Merged *<a href="../../../../builtin/index.html#bool">bool</a> `json:"merged,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestMergeResult represents the result of merging a pull request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=7935:7982#L241">PullRequestOptions</a></h2>
|
|
<pre>type PullRequestOptions struct {
|
|
Squash <a href="../../../../builtin/index.html#bool">bool</a>
|
|
}</pre>
|
|
<p>
|
|
PullRequestOptions lets you define how a pull request will be merged.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestReviewCommentEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=10951:11507#L265">PullRequestReviewCommentEvent</a></h2>
|
|
<pre>type PullRequestReviewCommentEvent struct {
|
|
<span class="comment">// Action is the action that was performed on the comment.</span>
|
|
<span class="comment">// Possible values are: "created", "edited", "deleted".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
PullRequest *<a href="index.html#PullRequest">PullRequest</a> `json:"pull_request,omitempty"`
|
|
Comment *<a href="index.html#PullRequestComment">PullRequestComment</a> `json:"comment,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Changes *<a href="index.html#EditChange">EditChange</a> `json:"changes,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PullRequestReviewCommentEvent is triggered when a comment is created on a
|
|
portion of the unified diff of a pull request.
|
|
The Webhook event name is "pull_request_review_comment".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent">https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PullRequestsService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=379:411#L7">PullRequestsService</a></h2>
|
|
<pre>type PullRequestsService service</pre>
|
|
<p>
|
|
PullRequestsService handles communication with the pull request related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/pulls/">http://developer.github.com/v3/pulls/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.Create">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=4843:4961#L135">Create</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) Create(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, pull *<a href="index.html#NewPullRequest">NewPullRequest</a>) (*<a href="index.html#PullRequest">PullRequest</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create a new pull request on the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#create-a-pull-request">https://developer.github.com/v3/pulls/#create-a-pull-request</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.CreateComment">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=3743:3894#L101">CreateComment</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) CreateComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#PullRequestComment">PullRequestComment</a>) (*<a href="index.html#PullRequestComment">PullRequestComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateComment creates a new comment on the specified pull request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/comments/#create-a-comment">https://developer.github.com/v3/pulls/comments/#create-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.DeleteComment">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=4924:5025#L139">DeleteComment</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) DeleteComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteComment deletes a pull request comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/comments/#delete-a-comment">https://developer.github.com/v3/pulls/comments/#delete-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.Edit">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=5344:5469#L154">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) Edit(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, pull *<a href="index.html#PullRequest">PullRequest</a>) (*<a href="index.html#PullRequest">PullRequest</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit a pull request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#update-a-pull-request">https://developer.github.com/v3/pulls/#update-a-pull-request</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.EditComment">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=4332:4481#L120">EditComment</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) EditComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#PullRequestComment">PullRequestComment</a>) (*<a href="index.html#PullRequestComment">PullRequestComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditComment updates a pull request comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/comments/#edit-a-comment">https://developer.github.com/v3/pulls/comments/#edit-a-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.Get">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=4011:4116#L107">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) Get(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#PullRequest">PullRequest</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get a single pull request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#get-a-single-pull-request">https://developer.github.com/v3/pulls/#get-a-single-pull-request</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.GetComment">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=3026:3145#L79">GetComment</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) GetComment(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#PullRequestComment">PullRequestComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetComment fetches the specified pull request comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/comments/#get-a-single-comment">https://developer.github.com/v3/pulls/comments/#get-a-single-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.IsMerged">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=7248:7350#L221">IsMerged</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) IsMerged(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsMerged checks if a pull request has been merged.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged">https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.List">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=3405:3530#L83">List</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) List(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#PullRequestListOptions">PullRequestListOptions</a>) ([]*<a href="index.html#PullRequest">PullRequest</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List the pull requests for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/pulls/#list-pull-requests">http://developer.github.com/v3/pulls/#list-pull-requests</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.ListComments">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls_comments.go?s=2089:2249#L47">ListComments</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) ListComments(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#PullRequestListCommentsOptions">PullRequestListCommentsOptions</a>) ([]*<a href="index.html#PullRequestComment">PullRequestComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListComments lists all comments on the specified pull request. Specifying a
|
|
pull request number of 0 will return all comments on all pull requests for
|
|
the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request">https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.ListCommits">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=5901:6039#L173">ListCommits</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) ListCommits(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryCommit">RepositoryCommit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommits lists the commits in a pull request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request">https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.ListFiles">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=6567:6697#L197">ListFiles</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) ListFiles(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#CommitFile">CommitFile</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListFiles lists the files in a pull request.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#list-pull-requests-files">https://developer.github.com/v3/pulls/#list-pull-requests-files</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PullRequestsService.Merge">func (*PullRequestsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/pulls.go?s=8265:8434#L253">Merge</a></h3>
|
|
<pre>func (s *<a href="index.html#PullRequestsService">PullRequestsService</a>) Merge(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, commitMessage <a href="../../../../builtin/index.html#string">string</a>, options *<a href="index.html#PullRequestOptions">PullRequestOptions</a>) (*<a href="index.html#PullRequestMergeResult">PullRequestMergeResult</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Merge a pull request (Merge Button™).
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade">https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PunchCard">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=6111:6269#L170">PunchCard</a></h2>
|
|
<pre>type PunchCard struct {
|
|
Day *<a href="../../../../builtin/index.html#int">int</a> <span class="comment">// Day of the week (0-6: =Sunday - Saturday).</span>
|
|
Hour *<a href="../../../../builtin/index.html#int">int</a> <span class="comment">// Hour of day (0-23).</span>
|
|
Commits *<a href="../../../../builtin/index.html#int">int</a> <span class="comment">// Number of commits.</span>
|
|
}</pre>
|
|
<p>
|
|
PunchCard represents the number of commits made during a given hour of a
|
|
day of thew eek.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PushEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=11655:12742#L281">PushEvent</a></h2>
|
|
<pre>type PushEvent struct {
|
|
PushID *<a href="../../../../builtin/index.html#int">int</a> `json:"push_id,omitempty"`
|
|
Head *<a href="../../../../builtin/index.html#string">string</a> `json:"head,omitempty"`
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
Commits []<a href="index.html#PushEventCommit">PushEventCommit</a> `json:"commits,omitempty"`
|
|
Repo *<a href="index.html#PushEventRepository">PushEventRepository</a> `json:"repository,omitempty"`
|
|
Before *<a href="../../../../builtin/index.html#string">string</a> `json:"before,omitempty"`
|
|
DistinctSize *<a href="../../../../builtin/index.html#int">int</a> `json:"distinct_size,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
After *<a href="../../../../builtin/index.html#string">string</a> `json:"after,omitempty"`
|
|
Created *<a href="../../../../builtin/index.html#bool">bool</a> `json:"created,omitempty"`
|
|
Deleted *<a href="../../../../builtin/index.html#bool">bool</a> `json:"deleted,omitempty"`
|
|
Forced *<a href="../../../../builtin/index.html#bool">bool</a> `json:"forced,omitempty"`
|
|
BaseRef *<a href="../../../../builtin/index.html#string">string</a> `json:"base_ref,omitempty"`
|
|
Compare *<a href="../../../../builtin/index.html#string">string</a> `json:"compare,omitempty"`
|
|
HeadCommit *<a href="index.html#PushEventCommit">PushEventCommit</a> `json:"head_commit,omitempty"`
|
|
Pusher *<a href="index.html#User">User</a> `json:"pusher,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PushEvent represents a git push to a GitHub repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/activity/events/types/#pushevent">http://developer.github.com/v3/activity/events/types/#pushevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PushEvent.String">func (PushEvent) <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=12744:12778#L303">String</a></h3>
|
|
<pre>func (p <a href="index.html#PushEvent">PushEvent</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PushEventCommit">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=12871:13624#L308">PushEventCommit</a></h2>
|
|
<pre>type PushEventCommit struct {
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
Author *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"author,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Distinct *<a href="../../../../builtin/index.html#bool">bool</a> `json:"distinct,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Events API.</span>
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
TreeID *<a href="../../../../builtin/index.html#string">string</a> `json:"tree_id,omitempty"`
|
|
Timestamp *<a href="index.html#Timestamp">Timestamp</a> `json:"timestamp,omitempty"`
|
|
Committer *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"committer,omitempty"`
|
|
Added []<a href="../../../../builtin/index.html#string">string</a> `json:"added,omitempty"`
|
|
Removed []<a href="../../../../builtin/index.html#string">string</a> `json:"removed,omitempty"`
|
|
Modified []<a href="../../../../builtin/index.html#string">string</a> `json:"modified,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PushEventCommit represents a git commit in a GitHub PushEvent.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="PushEventCommit.String">func (PushEventCommit) <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=13626:13666#L327">String</a></h3>
|
|
<pre>func (p <a href="index.html#PushEventCommit">PushEventCommit</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PushEventRepoOwner">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=15631:15744#L364">PushEventRepoOwner</a></h2>
|
|
<pre>type PushEventRepoOwner struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PushEventRepoOwner is a basic reporesntation of user/org in a PushEvent payload
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="PushEventRepository">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=13766:15546#L332">PushEventRepository</a></h2>
|
|
<pre>type PushEventRepository struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
FullName *<a href="../../../../builtin/index.html#string">string</a> `json:"full_name,omitempty"`
|
|
Owner *<a href="index.html#PushEventRepoOwner">PushEventRepoOwner</a> `json:"owner,omitempty"`
|
|
Private *<a href="../../../../builtin/index.html#bool">bool</a> `json:"private,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Fork *<a href="../../../../builtin/index.html#bool">bool</a> `json:"fork,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
PushedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"pushed_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
Homepage *<a href="../../../../builtin/index.html#string">string</a> `json:"homepage,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
StargazersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"stargazers_count,omitempty"`
|
|
WatchersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"watchers_count,omitempty"`
|
|
Language *<a href="../../../../builtin/index.html#string">string</a> `json:"language,omitempty"`
|
|
HasIssues *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_issues,omitempty"`
|
|
HasDownloads *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_downloads,omitempty"`
|
|
HasWiki *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_wiki,omitempty"`
|
|
HasPages *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_pages,omitempty"`
|
|
ForksCount *<a href="../../../../builtin/index.html#int">int</a> `json:"forks_count,omitempty"`
|
|
OpenIssuesCount *<a href="../../../../builtin/index.html#int">int</a> `json:"open_issues_count,omitempty"`
|
|
DefaultBranch *<a href="../../../../builtin/index.html#string">string</a> `json:"default_branch,omitempty"`
|
|
MasterBranch *<a href="../../../../builtin/index.html#string">string</a> `json:"master_branch,omitempty"`
|
|
Organization *<a href="../../../../builtin/index.html#string">string</a> `json:"organization,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
PushEventRepository represents the repo object in a PushEvent payload
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Rate">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=19856:20167#L576">Rate</a></h2>
|
|
<pre>type Rate struct {
|
|
<span class="comment">// The number of requests per hour the client is currently limited to.</span>
|
|
Limit <a href="../../../../builtin/index.html#int">int</a> `json:"limit"`
|
|
|
|
<span class="comment">// The number of remaining requests the client can make this hour.</span>
|
|
Remaining <a href="../../../../builtin/index.html#int">int</a> `json:"remaining"`
|
|
|
|
<span class="comment">// The time at which the current rate limit will reset.</span>
|
|
Reset <a href="index.html#Timestamp">Timestamp</a> `json:"reset"`
|
|
}</pre>
|
|
<p>
|
|
Rate represents the rate limit for the current client.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Rate.String">func (Rate) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=20169:20198#L587">String</a></h3>
|
|
<pre>func (r <a href="index.html#Rate">Rate</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RateLimitError">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=15897:16131#L469">RateLimitError</a></h2>
|
|
<pre>type RateLimitError struct {
|
|
Rate <a href="index.html#Rate">Rate</a> <span class="comment">// Rate specifies last known rate limit for the client</span>
|
|
Response *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a> <span class="comment">// HTTP response that caused this error</span>
|
|
Message <a href="../../../../builtin/index.html#string">string</a> `json:"message"` <span class="comment">// error message</span>
|
|
}</pre>
|
|
<p>
|
|
RateLimitError occurs when GitHub returns 403 Forbidden response with a rate limit
|
|
remaining value of 0, and error message starts with "API rate limit exceeded for ".
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RateLimitError.Error">func (*RateLimitError) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=16133:16172#L475">Error</a></h3>
|
|
<pre>func (r *<a href="index.html#RateLimitError">RateLimitError</a>) Error() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RateLimits">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=20290:20857#L592">RateLimits</a></h2>
|
|
<pre>type RateLimits struct {
|
|
<span class="comment">// The rate limit for non-search API requests. Unauthenticated</span>
|
|
<span class="comment">// requests are limited to 60 per hour. Authenticated requests are</span>
|
|
<span class="comment">// limited to 5,000 per hour.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// GitHub API docs: https://developer.github.com/v3/#rate-limiting</span>
|
|
Core *<a href="index.html#Rate">Rate</a> `json:"core"`
|
|
|
|
<span class="comment">// The rate limit for search API requests. Unauthenticated requests</span>
|
|
<span class="comment">// are limited to 5 requests per minutes. Authenticated requests are</span>
|
|
<span class="comment">// limited to 20 per minute.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// GitHub API docs: https://developer.github.com/v3/search/#rate-limit</span>
|
|
Search *<a href="index.html#Rate">Rate</a> `json:"search"`
|
|
}</pre>
|
|
<p>
|
|
RateLimits represents the rate limits for the current client.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RateLimits.String">func (RateLimits) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=20859:20894#L608">String</a></h3>
|
|
<pre>func (r <a href="index.html#RateLimits">RateLimits</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Reaction">type <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=432:719#L7">Reaction</a></h2>
|
|
<pre>type Reaction struct {
|
|
<span class="comment">// ID is the Reaction ID.</span>
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
<span class="comment">// Content is the type of reaction.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// "+1", "-1", "laugh", "confused", "heart", "hooray".</span>
|
|
Content *<a href="../../../../builtin/index.html#string">string</a> `json:"content,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Reaction represents a GitHub reaction.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Reaction.String">func (Reaction) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=1165:1198#L29">String</a></h3>
|
|
<pre>func (r <a href="index.html#Reaction">Reaction</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Reactions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=776:1163#L18">Reactions</a></h2>
|
|
<pre>type Reactions struct {
|
|
TotalCount *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
PlusOne *<a href="../../../../builtin/index.html#int">int</a> `json:"+1,omitempty"`
|
|
MinusOne *<a href="../../../../builtin/index.html#int">int</a> `json:"-1,omitempty"`
|
|
Laugh *<a href="../../../../builtin/index.html#int">int</a> `json:"laugh,omitempty"`
|
|
Confused *<a href="../../../../builtin/index.html#int">int</a> `json:"confused,omitempty"`
|
|
Heart *<a href="../../../../builtin/index.html#int">int</a> `json:"heart,omitempty"`
|
|
Hooray *<a href="../../../../builtin/index.html#int">int</a> `json:"hooray,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Reactions represents a summary of GitHub reactions.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ReactionsService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=359:388#L4">ReactionsService</a></h2>
|
|
<pre>type ReactionsService service</pre>
|
|
<p>
|
|
ReactionsService provides access to the reactions-related functions in the
|
|
GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/">https://developer.github.com/v3/reactions/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.CreateCommentReaction">func (ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=2315:2436#L65">CreateCommentReaction</a></h3>
|
|
<pre>func (s <a href="index.html#ReactionsService">ReactionsService</a>) CreateCommentReaction(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, content <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateCommentReaction creates a reaction for a commit comment.
|
|
Note that if you have already created a reaction of type content, the
|
|
previously created reaction will be returned with Status: 200 OK.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment">https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.CreateIssueCommentReaction">func (ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=5647:5773#L171">CreateIssueCommentReaction</a></h3>
|
|
<pre>func (s <a href="index.html#ReactionsService">ReactionsService</a>) CreateIssueCommentReaction(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, content <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateIssueCommentReaction creates a reaction for an issue comment.
|
|
Note that if you have already created a reaction of type content, the
|
|
previously created reaction will be returned with Status: 200 OK.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment">https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.CreateIssueReaction">func (ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=3952:4075#L118">CreateIssueReaction</a></h3>
|
|
<pre>func (s <a href="index.html#ReactionsService">ReactionsService</a>) CreateIssueReaction(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, content <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateIssueReaction creates a reaction for an issue.
|
|
Note that if you have already created a reaction of type content, the
|
|
previously created reaction will be returned with Status: 200 OK.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#create-reaction-for-an-issue">https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.CreatePullRequestCommentReaction">func (ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=7393:7525#L224">CreatePullRequestCommentReaction</a></h3>
|
|
<pre>func (s <a href="index.html#ReactionsService">ReactionsService</a>) CreatePullRequestCommentReaction(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, content <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreatePullRequestCommentReaction creates a reaction for a pull request review comment.
|
|
Note that if you have already created a reaction of type content, the
|
|
previously created reaction will be returned with Status: 200 OK.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment">https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.DeleteReaction">func (*ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=8128:8196#L248">DeleteReaction</a></h3>
|
|
<pre>func (s *<a href="index.html#ReactionsService">ReactionsService</a>) DeleteReaction(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteReaction deletes a reaction.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reaction/reactions/#delete-a-reaction-archive">https://developer.github.com/v3/reaction/reactions/#delete-a-reaction-archive</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.ListCommentReactions">func (*ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=1393:1518#L36">ListCommentReactions</a></h3>
|
|
<pre>func (s *<a href="index.html#ReactionsService">ReactionsService</a>) ListCommentReactions(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommentReactions lists the reactions for a commit comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment">https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.ListIssueCommentReactions">func (*ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=4708:4838#L142">ListIssueCommentReactions</a></h3>
|
|
<pre>func (s *<a href="index.html#ReactionsService">ReactionsService</a>) ListIssueCommentReactions(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListIssueCommentReactions lists the reactions for an issue comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment">https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.ListIssueReactions">func (*ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=3044:3171#L89">ListIssueReactions</a></h3>
|
|
<pre>func (s *<a href="index.html#ReactionsService">ReactionsService</a>) ListIssueReactions(owner, repo <a href="../../../../builtin/index.html#string">string</a>, number <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListIssueReactions lists the reactions for an issue.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#list-reactions-for-an-issue">https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReactionsService.ListPullRequestCommentReactions">func (*ReactionsService) <a href="http://localhost:6060/src/github.com/google/go-github/github/reactions.go?s=6430:6566#L195">ListPullRequestCommentReactions</a></h3>
|
|
<pre>func (s *<a href="index.html#ReactionsService">ReactionsService</a>) ListPullRequestCommentReactions(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Reaction">Reaction</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListPullRequestCommentReactions lists the reactions for a pull request review comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment">https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Reference">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=260:384#L4">Reference</a></h2>
|
|
<pre>type Reference struct {
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url"`
|
|
Object *<a href="index.html#GitObject">GitObject</a> `json:"object"`
|
|
}</pre>
|
|
<p>
|
|
Reference represents a GitHub reference.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Reference.String">func (Reference) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=386:420#L10">String</a></h3>
|
|
<pre>func (r <a href="index.html#Reference">Reference</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ReferenceListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_refs.go?s=1622:1695#L59">ReferenceListOptions</a></h2>
|
|
<pre>type ReferenceListOptions struct {
|
|
Type <a href="../../../../builtin/index.html#string">string</a> `url:"-"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
ReferenceListOptions specifies optional parameters to the
|
|
GitService.ListRefs method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ReleaseAsset">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=1532:2269#L35">ReleaseAsset</a></h2>
|
|
<pre>type ReleaseAsset struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Label *<a href="../../../../builtin/index.html#string">string</a> `json:"label,omitempty"`
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
ContentType *<a href="../../../../builtin/index.html#string">string</a> `json:"content_type,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
DownloadCount *<a href="../../../../builtin/index.html#int">int</a> `json:"download_count,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
BrowserDownloadURL *<a href="../../../../builtin/index.html#string">string</a> `json:"browser_download_url,omitempty"`
|
|
Uploader *<a href="index.html#User">User</a> `json:"uploader,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ReleaseAsset represents a Github release asset in a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ReleaseAsset.String">func (ReleaseAsset) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=2271:2308#L50">String</a></h3>
|
|
<pre>func (r <a href="index.html#ReleaseAsset">ReleaseAsset</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ReleaseEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=15931:16305#L373">ReleaseEvent</a></h2>
|
|
<pre>type ReleaseEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible value is: "published".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Release *<a href="index.html#RepositoryRelease">RepositoryRelease</a> `json:"release,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ReleaseEvent is triggered when a release is published.
|
|
The Webhook event name is "release".
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#releaseevent">https://developer.github.com/v3/activity/events/types/#releaseevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Rename">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=4196:4292#L132">Rename</a></h2>
|
|
<pre>type Rename struct {
|
|
From *<a href="../../../../builtin/index.html#string">string</a> `json:"from,omitempty"`
|
|
To *<a href="../../../../builtin/index.html#string">string</a> `json:"to,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Rename contains details for 'renamed' events.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Rename.String">func (Rename) <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_events.go?s=4294:4325#L137">String</a></h3>
|
|
<pre>func (r <a href="index.html#Rename">Rename</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepoStatus">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=292:1143#L4">RepoStatus</a></h2>
|
|
<pre>type RepoStatus struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
|
|
<span class="comment">// State is the current state of the repository. Possible values are:</span>
|
|
<span class="comment">// pending, success, error, or failure.</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
|
|
<span class="comment">// TargetURL is the URL of the page representing this status. It will be</span>
|
|
<span class="comment">// linked from the GitHub UI to allow users to see the source of the status.</span>
|
|
TargetURL *<a href="../../../../builtin/index.html#string">string</a> `json:"target_url,omitempty"`
|
|
|
|
<span class="comment">// Description is a short high level summary of the status.</span>
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
|
|
<span class="comment">// A string label to differentiate this status from the statuses of other systems.</span>
|
|
Context *<a href="../../../../builtin/index.html#string">string</a> `json:"context,omitempty"`
|
|
|
|
Creator *<a href="index.html#User">User</a> `json:"creator,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepoStatus represents the status of a repository at a particular reference.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepoStatus.String">func (RepoStatus) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=1145:1180#L27">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepoStatus">RepoStatus</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoriesSearchResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=1155:1305#L32">RepositoriesSearchResult</a></h2>
|
|
<pre>type RepositoriesSearchResult struct {
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
Repositories []<a href="index.html#Repository">Repository</a> `json:"items,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoriesSearchResult represents the result of a repositories search.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoriesService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=364:396#L4">RepositoriesService</a></h2>
|
|
<pre>type RepositoriesService service</pre>
|
|
<p>
|
|
RepositoriesService handles communication with the repository related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/">http://developer.github.com/v3/repos/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.AddCollaborator">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go?s=2345:2474#L58">AddCollaborator</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) AddCollaborator(owner, repo, user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryAddCollaboratorOptions">RepositoryAddCollaboratorOptions</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddCollaborator adds the specified Github user as collaborator to the given repo.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator">https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CompareCommits">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=5815:5937#L173">CompareCommits</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CompareCommits(owner, repo <a href="../../../../builtin/index.html#string">string</a>, base, head <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#CommitsComparison">CommitsComparison</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CompareCommits compares a range of commits with each other.
|
|
todo: support media formats - <a href="https://github.com/google/go-github/issues/6">https://github.com/google/go-github/issues/6</a>
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/commits/index.html#compare-two-commits">http://developer.github.com/v3/repos/commits/index.html#compare-two-commits</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.Create">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=9688:9786#L240">Create</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) Create(org <a href="../../../../builtin/index.html#string">string</a>, repo *<a href="index.html#Repository">Repository</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Create a new repository. If an organization is specified, the new
|
|
repository will be created under that org. If the empty string is
|
|
specified, it will be created for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#create">http://developer.github.com/v3/repos/#create</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateComment">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=2818:2953#L83">CreateComment</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateComment(owner, repo, sha <a href="../../../../builtin/index.html#string">string</a>, comment *<a href="index.html#RepositoryComment">RepositoryComment</a>) (*<a href="index.html#RepositoryComment">RepositoryComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateComment creates a comment for the given commit.
|
|
Note: GitHub allows for comments to be created for non-existing files and positions.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#create-a-commit-comment">http://developer.github.com/v3/repos/comments/#create-a-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateDeployment">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=3023:3149#L78">CreateDeployment</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateDeployment(owner, repo <a href="../../../../builtin/index.html#string">string</a>, request *<a href="index.html#DeploymentRequest">DeploymentRequest</a>) (*<a href="index.html#Deployment">Deployment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateDeployment creates a new deployment for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/deployments/#create-a-deployment">https://developer.github.com/v3/repos/deployments/#create-a-deployment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateDeploymentStatus">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=5633:5793#L151">CreateDeploymentStatus</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateDeploymentStatus(owner, repo <a href="../../../../builtin/index.html#string">string</a>, deployment <a href="../../../../builtin/index.html#int">int</a>, request *<a href="index.html#DeploymentStatusRequest">DeploymentStatusRequest</a>) (*<a href="index.html#DeploymentStatus">DeploymentStatus</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateDeploymentStatus creates a new status for a deployment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/deployments/#create-a-deployment-status">https://developer.github.com/v3/repos/deployments/#create-a-deployment-status</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateFile">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=6426:6574#L178">CreateFile</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateFile(owner, repo, path <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentFileOptions">RepositoryContentFileOptions</a>) (*<a href="index.html#RepositoryContentResponse">RepositoryContentResponse</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateFile creates a new file in a repository at the given path and returns
|
|
the commit and file metadata.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#create-a-file">http://developer.github.com/v3/repos/contents/#create-a-file</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateFork">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_forks.go?s=1533:1659#L44">CreateFork</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateFork(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryCreateForkOptions">RepositoryCreateForkOptions</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateFork creates a fork of the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/forks/#list-forks">http://developer.github.com/v3/repos/forks/#list-forks</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=3252:3350#L79">CreateHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, hook *<a href="index.html#Hook">Hook</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateHook creates a Hook for the specified repository.
|
|
Name and Config are required fields.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">http://developer.github.com/v3/repos/hooks/#create-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateKey">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go?s=1434:1535#L49">CreateKey</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateKey(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, key *<a href="index.html#Key">Key</a>) (*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateKey adds a deploy key for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/keys/#create">http://developer.github.com/v3/repos/keys/#create</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateRelease">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=4556:4686#L118">CreateRelease</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateRelease(owner, repo <a href="../../../../builtin/index.html#string">string</a>, release *<a href="index.html#RepositoryRelease">RepositoryRelease</a>) (*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateRelease adds a new release for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#create-a-release">http://developer.github.com/v3/repos/releases/#create-a-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.CreateStatus">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=2170:2289#L60">CreateStatus</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) CreateStatus(owner, repo, ref <a href="../../../../builtin/index.html#string">string</a>, status *<a href="index.html#RepoStatus">RepoStatus</a>) (*<a href="index.html#RepoStatus">RepoStatus</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateStatus creates a new status for a repository at the specified
|
|
reference. Ref can be a SHA, a branch name, or a tag name.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/statuses/#create-a-status">http://developer.github.com/v3/repos/statuses/#create-a-status</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.Delete">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=12055:12130#L330">Delete</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) Delete(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Delete a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/#delete-a-repository">https://developer.github.com/v3/repos/#delete-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteComment">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=4664:4754#L143">DeleteComment</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteComment(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteComment deletes a single comment from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#delete-a-commit-comment">http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteFile">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=7842:7990#L214">DeleteFile</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteFile(owner, repo, path <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentFileOptions">RepositoryContentFileOptions</a>) (*<a href="index.html#RepositoryContentResponse">RepositoryContentResponse</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteFile deletes a file from a repository and returns the commit.
|
|
Requires the blob SHA of the file to be deleted.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#delete-a-file">http://developer.github.com/v3/repos/contents/#delete-a-file</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=5236:5323#L150">DeleteHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteHook deletes a specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">http://developer.github.com/v3/repos/hooks/#delete-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteInvitation">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_invitations.go?s=1827:1918#L45">DeleteInvitation</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteInvitation(repoID, invitationID <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteInvitation deletes a repository invitation.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation">https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteKey">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go?s=2392:2485#L89">DeleteKey</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteKey(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteKey deletes a deploy key.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/keys/#delete">http://developer.github.com/v3/repos/keys/#delete</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteRelease">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=5681:5771#L156">DeleteRelease</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteRelease(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteRelease delete a single release from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#delete-a-release">http://developer.github.com/v3/repos/releases/#delete-a-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DeleteReleaseAsset">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=9397:9492#L274">DeleteReleaseAsset</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DeleteReleaseAsset(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteReleaseAsset delete a single release asset from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#delete-a-release-asset">http://developer.github.com/v3/repos/releases/#delete-a-release-asset</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DownloadContents">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=3914:4047#L117">DownloadContents</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DownloadContents(owner, repo, filepath <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentGetOptions">RepositoryContentGetOptions</a>) (<a href="../../../../io/index.html">io</a>.<a href="../../../../io/index.html#ReadCloser">ReadCloser</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DownloadContents returns an io.ReadCloser that reads the contents of the
|
|
specified file. This function will work with files of any size, as opposed
|
|
to GetContents which is limited to 1 Mb files. It is the caller's
|
|
responsibility to close the ReadCloser.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.DownloadReleaseAsset">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=7678:7806#L216">DownloadReleaseAsset</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) DownloadReleaseAsset(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (rc <a href="../../../../io/index.html">io</a>.<a href="../../../../io/index.html#ReadCloser">ReadCloser</a>, redirectURL <a href="../../../../builtin/index.html#string">string</a>, err <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DownloadReleaseAsset downloads a release asset or returns a redirect URL.
|
|
</p>
|
|
<p>
|
|
DownloadReleaseAsset returns an io.ReadCloser that reads the contents of the
|
|
specified release asset. It is the caller's responsibility to close the ReadCloser.
|
|
If a redirect is returned, the redirect URL will be returned as a string instead
|
|
of the io.ReadCloser. Exactly one of rc and redirectURL will be zero.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#get-a-single-release-asset">http://developer.github.com/v3/repos/releases/#get-a-single-release-asset</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.Edit">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=11564:11674#L311">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) Edit(owner, repo <a href="../../../../builtin/index.html#string">string</a>, repository *<a href="index.html#Repository">Repository</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit updates a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#edit">http://developer.github.com/v3/repos/#edit</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.EditBranch">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=18819:18935#L552">EditBranch</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) EditBranch(owner, repo, branchName <a href="../../../../builtin/index.html#string">string</a>, branch *<a href="index.html#Branch">Branch</a>) (*<a href="index.html#Branch">Branch</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditBranch edits the branch (currently only Branch Protection)
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/#enabling-and-disabling-branch-protection">https://developer.github.com/v3/repos/#enabling-and-disabling-branch-protection</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.EditHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=4781:4885#L136">EditHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) EditHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, hook *<a href="index.html#Hook">Hook</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditHook updates a specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">http://developer.github.com/v3/repos/hooks/#edit-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.EditKey">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go?s=1903:2010#L69">EditKey</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) EditKey(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, key *<a href="index.html#Key">Key</a>) (*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditKey edits a deploy key.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/keys/#edit">http://developer.github.com/v3/repos/keys/#edit</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.EditRelease">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=5102:5238#L137">EditRelease</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) EditRelease(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, release *<a href="index.html#RepositoryRelease">RepositoryRelease</a>) (*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditRelease edits a repository release.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#edit-a-release">http://developer.github.com/v3/repos/releases/#edit-a-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.EditReleaseAsset">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=8792:8923#L255">EditReleaseAsset</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) EditReleaseAsset(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, release *<a href="index.html#ReleaseAsset">ReleaseAsset</a>) (*<a href="index.html#ReleaseAsset">ReleaseAsset</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
EditReleaseAsset edits a repository release asset.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#edit-a-release-asset">http://developer.github.com/v3/repos/releases/#edit-a-release-asset</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.Get">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=10205:10290#L265">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) Get(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get fetches a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#get">http://developer.github.com/v3/repos/#get</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetArchiveLink">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=8900:9056#L244">GetArchiveLink</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetArchiveLink(owner, repo <a href="../../../../builtin/index.html#string">string</a>, archiveformat archiveFormat, opt *<a href="index.html#RepositoryContentGetOptions">RepositoryContentGetOptions</a>) (*<a href="../../../../net/url/index.html">url</a>.<a href="../../../../net/url/index.html#URL">URL</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetArchiveLink returns an URL to download a tarball or zipball archive for a
|
|
repository. The archiveFormat can be specified by either the github.Tarball
|
|
or github.Zipball constant.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#get-archive-link">http://developer.github.com/v3/repos/contents/#get-archive-link</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetBranch">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=18211:18306#L531">GetBranch</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetBranch(owner, repo, branch <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Branch">Branch</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetBranch gets the specified branch for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/#get-branch">https://developer.github.com/v3/repos/#get-branch</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetByID">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=10900:10977#L288">GetByID</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetByID(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetByID fetches a repository.
|
|
</p>
|
|
<p>
|
|
Note: GetByID uses the undocumented GitHub API endpoint /repositories/:id.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetCombinedStatus">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=3517:3643#L99">GetCombinedStatus</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetCombinedStatus(owner, repo, ref <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) (*<a href="index.html#CombinedStatus">CombinedStatus</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetCombinedStatus returns the combined status of a repository at the specified
|
|
reference. ref can be a SHA, a branch name, or a tag name.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref">https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetComment">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=3409:3516#L102">GetComment</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetComment(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#RepositoryComment">RepositoryComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetComment gets a single comment from a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment">http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetCommit">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=4259:4361#L123">GetCommit</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetCommit(owner, repo, sha <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#RepositoryCommit">RepositoryCommit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetCommit fetches the specified commit, including all details about it.
|
|
todo: support media formats - <a href="https://github.com/google/go-github/issues/6">https://github.com/google/go-github/issues/6</a>
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/commits/#get-a-single-commit">http://developer.github.com/v3/repos/commits/#get-a-single-commit</a>
|
|
See also: <a href="http://developer.github.com//v3/git/commits/#get-a-single-commit">http://developer.github.com//v3/git/commits/#get-a-single-commit</a> provides the same functionality
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetCommitSHA1">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=5059:5163#L147">GetCommitSHA1</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetCommitSHA1(owner, repo, ref, lastSHA <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#string">string</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetCommitSHA1 gets the SHA-1 of a commit reference. If a last-known SHA1 is
|
|
supplied and no new commits have occurred, a 304 Unmodified response is returned.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference">https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetContents">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=5141:5341#L147">GetContents</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetContents(owner, repo, path <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentGetOptions">RepositoryContentGetOptions</a>) (fileContent *<a href="index.html#RepositoryContent">RepositoryContent</a>, directoryContent []*<a href="index.html#RepositoryContent">RepositoryContent</a>, resp *<a href="index.html#Response">Response</a>, err <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetContents can return either the metadata and content of a single file
|
|
(when path references a file) or the metadata of all the files and/or
|
|
subdirectories of a directory (when path references a directory). To make it
|
|
easy to distinguish between both result types and to mimic the API as much
|
|
as possible, both result types will be returned but only one will contain a
|
|
value and the other will be nil.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#get-contents">http://developer.github.com/v3/repos/contents/#get-contents</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=4337:4428#L122">GetHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetHook returns a single specified Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">http://developer.github.com/v3/repos/hooks/#get-single-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetKey">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go?s=938:1034#L29">GetKey</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetKey(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetKey fetches a single deploy key.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/keys/#get">http://developer.github.com/v3/repos/keys/#get</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetLatestPagesBuild">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=2516:2624#L70">GetLatestPagesBuild</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetLatestPagesBuild(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#PagesBuild">PagesBuild</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetLatestPagesBuild fetches the latest build information for a GitHub pages site.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/pages/#list-latest-pages-build">https://developer.github.com/v3/repos/pages/#list-latest-pages-build</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetLatestRelease">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=3497:3602#L88">GetLatestRelease</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetLatestRelease(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetLatestRelease fetches the latest published release for the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/releases/#get-the-latest-release">https://developer.github.com/v3/repos/releases/#get-the-latest-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetPagesInfo">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=1305:1401#L29">GetPagesInfo</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetPagesInfo(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Pages">Pages</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetPagesInfo fetches information about a GitHub Pages site.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site">https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetReadme">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=3150:3282#L95">GetReadme</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetReadme(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentGetOptions">RepositoryContentGetOptions</a>) (*<a href="index.html#RepositoryContent">RepositoryContent</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetReadme gets the Readme file for the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#get-the-readme">http://developer.github.com/v3/repos/contents/#get-the-readme</a>
|
|
</p>
|
|
|
|
|
|
<div id="example_RepositoriesService_GetReadme" class="toggle">
|
|
<div class="collapsed">
|
|
<p class="exampleHeading toggleButton">▹ <span class="text">Example</span></p>
|
|
</div>
|
|
<div class="expanded">
|
|
<p class="exampleHeading toggleButton">▾ <span class="text">Example</span></p>
|
|
|
|
|
|
|
|
<p>Code:</p>
|
|
<pre class="code">
|
|
client := github.NewClient(nil)
|
|
|
|
readme, _, err := client.Repositories.GetReadme("google", "go-github", nil)
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
|
|
content, err := readme.GetContent()
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
|
|
fmt.Printf("google/go-github README:\n%v\n", content)
|
|
</pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetRelease">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=3121:3228#L80">GetRelease</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetRelease(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetRelease fetches a single release.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/releases/#get-a-single-release">http://developer.github.com/v3/repos/releases/#get-a-single-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetReleaseAsset">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=6766:6873#L192">GetReleaseAsset</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetReleaseAsset(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#ReleaseAsset">ReleaseAsset</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetReleaseAsset fetches a single release asset.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#get-a-single-release-asset">http://developer.github.com/v3/repos/releases/#get-a-single-release-asset</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.GetReleaseByTag">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=3858:3967#L96">GetReleaseByTag</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) GetReleaseByTag(owner, repo, tag <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetReleaseByTag fetches a release with the specified tag.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name">https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.IsCollaborator">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go?s=1124:1219#L30">IsCollaborator</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) IsCollaborator(owner, repo, user <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsCollaborator checks whether the specified Github user has collaborator
|
|
access to the given repo.
|
|
Note: This will return false if the user is not a collaborator OR the user
|
|
is not a GitHub user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/collaborators/#get">http://developer.github.com/v3/repos/collaborators/#get</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.License">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=19470:19556#L573">License</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) License(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#License">License</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
License gets the contents of a repository's license if one is detected.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license">https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.List">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=6866:6975#L137">List</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) List(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryListOptions">RepositoryListOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
List the repositories for a user. Passing the empty string will list
|
|
repositories for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#list-user-repositories">http://developer.github.com/v3/repos/#list-user-repositories</a>
|
|
</p>
|
|
|
|
|
|
<div id="example_RepositoriesService_List" class="toggle">
|
|
<div class="collapsed">
|
|
<p class="exampleHeading toggleButton">▹ <span class="text">Example</span></p>
|
|
</div>
|
|
<div class="expanded">
|
|
<p class="exampleHeading toggleButton">▾ <span class="text">Example</span></p>
|
|
|
|
|
|
|
|
<p>Code:</p>
|
|
<pre class="code">
|
|
client := github.NewClient(nil)
|
|
|
|
user := "willnorris"
|
|
opt := &github.RepositoryListOptions{Type: "owner", Sort: "updated", Direction: "desc"}
|
|
|
|
repos, _, err := client.Repositories.List(user, opt)
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
fmt.Printf("Recently updated repositories by %q: %v", user, github.Stringify(repos))
|
|
</pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListAll">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=8994:9096#L215">ListAll</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListAll(opt *<a href="index.html#RepositoryListAllOptions">RepositoryListAllOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListAll lists all GitHub repositories in the order that they were created.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#list-all-public-repositories">http://developer.github.com/v3/repos/#list-all-public-repositories</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListBranches">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=17532:17649#L505">ListBranches</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListBranches(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Branch">Branch</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListBranches lists branches for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#list-branches">http://developer.github.com/v3/repos/#list-branches</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListByOrg">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=7997:8115#L179">ListByOrg</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListByOrg(org <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryListByOrgOptions">RepositoryListByOrgOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListByOrg lists the repositories for an organization.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#list-organization-repositories">http://developer.github.com/v3/repos/#list-organization-repositories</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListCodeFrequency">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=3720:3822#L98">ListCodeFrequency</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListCodeFrequency(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#WeeklyStats">WeeklyStats</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCodeFrequency returns a weekly aggregate of the number of additions and
|
|
deletions pushed to a repository. Returned WeeklyStats will contain
|
|
additions and deletions, but not total commits.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/repos/statistics/#code-frequency">https://developer.github.com/v3/repos/statistics/#code-frequency</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListCollaborators">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go?s=360:473#L3">ListCollaborators</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListCollaborators(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCollaborators lists the Github users that have access to the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/collaborators/#list">http://developer.github.com/v3/repos/collaborators/#list</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListComments">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=1131:1252#L28">ListComments</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListComments(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryComment">RepositoryComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListComments lists all the comments for the repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository">http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListCommitActivity">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=2963:3075#L77">ListCommitActivity</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListCommitActivity(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#WeeklyCommitActivity">WeeklyCommitActivity</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommitActivity returns the last year of commit activity
|
|
grouped by week. The days array is a group of commits per day,
|
|
starting on Sunday.
|
|
</p>
|
|
<p>
|
|
If this is the first time these statistics are requested for the given
|
|
repository, this method will return a non-nil error and a status code of
|
|
202. This is because this is the status that github returns to signify that
|
|
it is now computing the requested statistics. A follow up request, after a
|
|
delay of a second or so, should result in a successful request.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/repos/statistics/#commit-activity">https://developer.github.com/v3/repos/statistics/#commit-activity</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListCommitComments">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=1928:2060#L55">ListCommitComments</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListCommitComments(owner, repo, sha <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryComment">RepositoryComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommitComments lists all the comments for a given commit SHA.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit">http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListCommits">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=3405:3531#L97">ListCommits</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListCommits(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#CommitsListOptions">CommitsListOptions</a>) ([]*<a href="index.html#RepositoryCommit">RepositoryCommit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListCommits lists the commits of a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/commits/#list">http://developer.github.com/v3/repos/commits/#list</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListContributors">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=13798:13942#L374">ListContributors</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListContributors(owner <a href="../../../../builtin/index.html#string">string</a>, repository <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListContributorsOptions">ListContributorsOptions</a>) ([]*<a href="index.html#Contributor">Contributor</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListContributors lists contributors for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/#list-contributors">http://developer.github.com/v3/repos/#list-contributors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListContributorsStats">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=1512:1623#L38">ListContributorsStats</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListContributorsStats(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#ContributorStats">ContributorStats</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListContributorsStats gets a repo's contributor list with additions,
|
|
deletions and commit counts.
|
|
</p>
|
|
<p>
|
|
If this is the first time these statistics are requested for the given
|
|
repository, this method will return a non-nil error and a status code of
|
|
202. This is because this is the status that github returns to signify that
|
|
it is now computing the requested statistics. A follow up request, after a
|
|
delay of a second or so, should result in a successful request.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/repos/statistics/#contributors">https://developer.github.com/v3/repos/statistics/#contributors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListDeploymentStatuses">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=4914:5060#L127">ListDeploymentStatuses</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListDeploymentStatuses(owner, repo <a href="../../../../builtin/index.html#string">string</a>, deployment <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#DeploymentStatus">DeploymentStatus</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListDeploymentStatuses lists the statuses of a given deployment of a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/deployments/#list-deployment-statuses">https://developer.github.com/v3/repos/deployments/#list-deployment-statuses</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListDeployments">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_deployments.go?s=2352:2480#L54">ListDeployments</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListDeployments(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#DeploymentsListOptions">DeploymentsListOptions</a>) ([]*<a href="index.html#Deployment">Deployment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListDeployments lists the deployments of a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/deployments/#list-deployments">https://developer.github.com/v3/repos/deployments/#list-deployments</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListForks">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_forks.go?s=648:774#L13">ListForks</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListForks(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryListForksOptions">RepositoryListForksOptions</a>) ([]*<a href="index.html#Repository">Repository</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListForks lists the forks of the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/forks/#list-forks">http://developer.github.com/v3/repos/forks/#list-forks</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListHooks">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=3749:3854#L98">ListHooks</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListHooks(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Hook">Hook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListHooks lists all Hooks for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#list">http://developer.github.com/v3/repos/hooks/#list</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListInvitations">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_invitations.go?s=1036:1155#L18">ListInvitations</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListInvitations(repoID <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryInvitation">RepositoryInvitation</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListInvitations lists all currently-open repository invitations.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository">https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListKeys">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_keys.go?s=368:478#L5">ListKeys</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListKeys(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListKeys lists the deploy keys for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/keys/#list">http://developer.github.com/v3/repos/keys/#list</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListLanguages">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=14658:14763#L405">ListLanguages</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListLanguages(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#int">int</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListLanguages lists languages for the specified repository. The returned map
|
|
specifies the languages and the number of bytes of code written in that
|
|
language. For example:
|
|
</p>
|
|
<pre>{
|
|
"C": 78769,
|
|
"Python": 7769
|
|
}
|
|
</pre>
|
|
<p>
|
|
GitHub API Docs: <a href="http://developer.github.com/v3/repos/#list-languages">http://developer.github.com/v3/repos/#list-languages</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListPagesBuilds">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=1942:2048#L51">ListPagesBuilds</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListPagesBuilds(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#PagesBuild">PagesBuild</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListPagesBuilds lists the builds for a GitHub Pages site.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/pages/#list-pages-builds">https://developer.github.com/v3/repos/pages/#list-pages-builds</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListParticipation">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=5568:5680#L152">ListParticipation</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListParticipation(owner, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#RepositoryParticipation">RepositoryParticipation</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListParticipation returns the total commit counts for the 'owner'
|
|
and total commit counts in 'all'. 'all' is everyone combined,
|
|
including the 'owner' in the last 52 weeks. If you’d like to get
|
|
the commit counts for non-owners, you can subtract 'all' from 'owner'.
|
|
</p>
|
|
<p>
|
|
The array order is oldest week (index 0) to most recent week.
|
|
</p>
|
|
<p>
|
|
If this is the first time these statistics are requested for the given
|
|
repository, this method will return a non-nil error and a status code
|
|
of 202. This is because this is the status that github returns to
|
|
signify that it is now computing the requested statistics. A follow
|
|
up request, after a delay of a second or so, should result in a
|
|
successful request.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/repos/statistics/#participation">https://developer.github.com/v3/repos/statistics/#participation</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListPunchCard">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=6424:6520#L179">ListPunchCard</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListPunchCard(owner, repo <a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#PunchCard">PunchCard</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListPunchCard returns the number of commits per hour in each day.
|
|
</p>
|
|
<p>
|
|
GitHub API Docs: <a href="https://developer.github.com/v3/repos/statistics/#punch-card">https://developer.github.com/v3/repos/statistics/#punch-card</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListReleaseAssets">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=6105:6234#L169">ListReleaseAssets</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListReleaseAssets(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#ReleaseAsset">ReleaseAsset</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListReleaseAssets lists the release's assets.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#list-assets-for-a-release">http://developer.github.com/v3/repos/releases/#list-assets-for-a-release</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListReleases">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=2489:2610#L57">ListReleases</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListReleases(owner, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryRelease">RepositoryRelease</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListReleases lists the releases for a repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/releases/#list-releases-for-a-repository">http://developer.github.com/v3/repos/releases/#list-releases-for-a-repository</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListServiceHooks">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=6394:6477#L184">ListServiceHooks</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListServiceHooks() ([]*<a href="index.html#ServiceHook">ServiceHook</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListServiceHooks is deprecated. Use Client.ListServiceHooks instead.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListStatuses">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_statuses.go?s=1441:1560#L35">ListStatuses</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListStatuses(owner, repo, ref <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepoStatus">RepoStatus</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListStatuses lists the statuses of a repository at the specified
|
|
reference. ref can be a SHA, a branch name, or a tag name.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref">http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListTags">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=16063:16183#L456">ListTags</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListTags(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#RepositoryTag">RepositoryTag</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListTags lists tags for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/#list-tags">https://developer.github.com/v3/repos/#list-tags</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.ListTeams">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=15201:15313#L424">ListTeams</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) ListTeams(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Team">Team</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListTeams lists the teams for the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/#list-teams">https://developer.github.com/v3/repos/#list-teams</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.Merge">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_merging.go?s=614:740#L13">Merge</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) Merge(owner, repo <a href="../../../../builtin/index.html#string">string</a>, request *<a href="index.html#RepositoryMergeRequest">RepositoryMergeRequest</a>) (*<a href="index.html#RepositoryCommit">RepositoryCommit</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Merge a branch in the specified repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/merging/#perform-a-merge">https://developer.github.com/v3/repos/merging/#perform-a-merge</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.PingHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=5647:5732#L162">PingHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) PingHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
PingHook triggers a 'ping' event to be sent to the Hook.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/hooks/#ping-a-hook">https://developer.github.com/v3/repos/hooks/#ping-a-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.RemoveCollaborator">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go?s=3074:3167#L75">RemoveCollaborator</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) RemoveCollaborator(owner, repo, user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RemoveCollaborator removes the specified Github user as collaborator from the given repo.
|
|
Note: Does not return error if a valid user that is not a collaborator is removed.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/collaborators/#remove-collaborator">http://developer.github.com/v3/repos/collaborators/#remove-collaborator</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.RequestPageBuild">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_pages.go?s=3107:3212#L89">RequestPageBuild</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) RequestPageBuild(owner <a href="../../../../builtin/index.html#string">string</a>, repo <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#PagesBuild">PagesBuild</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RequestPageBuild requests a build of a GitHub Pages site without needing to push new commit.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/pages/#request-a-page-build">https://developer.github.com/v3/repos/pages/#request-a-page-build</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.TestHook">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=6048:6133#L174">TestHook</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) TestHook(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
TestHook triggers a test Hook by github.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/hooks/#test-a-push-hook">http://developer.github.com/v3/repos/hooks/#test-a-push-hook</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.UpdateComment">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=4076:4214#L124">UpdateComment</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) UpdateComment(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, comment *<a href="index.html#RepositoryComment">RepositoryComment</a>) (*<a href="index.html#RepositoryComment">RepositoryComment</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UpdateComment updates the body of a single comment.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/comments/#update-a-commit-comment">http://developer.github.com/v3/repos/comments/#update-a-commit-comment</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.UpdateFile">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=7151:7299#L196">UpdateFile</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) UpdateFile(owner, repo, path <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#RepositoryContentFileOptions">RepositoryContentFileOptions</a>) (*<a href="index.html#RepositoryContentResponse">RepositoryContentResponse</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UpdateFile updates a file in a repository at the given path and returns the
|
|
commit and file metadata. Requires the blob SHA of the file being updated.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/repos/contents/#update-a-file">http://developer.github.com/v3/repos/contents/#update-a-file</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.UpdateInvitation">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_invitations.go?s=2594:2728#L65">UpdateInvitation</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) UpdateInvitation(repoID, invitationID <a href="../../../../builtin/index.html#int">int</a>, permissions <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#RepositoryInvitation">RepositoryInvitation</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UpdateInvitation updates the permissions associated with a repository
|
|
invitation.
|
|
</p>
|
|
<p>
|
|
permissions represents the permissions that the associated user will have
|
|
on the repository. Possible values are: "read", "write", "admin".
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation">https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoriesService.UploadReleaseAsset">func (*RepositoriesService) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=9961:10106#L288">UploadReleaseAsset</a></h3>
|
|
<pre>func (s *<a href="index.html#RepositoriesService">RepositoriesService</a>) UploadReleaseAsset(owner, repo <a href="../../../../builtin/index.html#string">string</a>, id <a href="../../../../builtin/index.html#int">int</a>, opt *<a href="index.html#UploadOptions">UploadOptions</a>, file *<a href="../../../../os/index.html">os</a>.<a href="../../../../os/index.html#File">File</a>) (*<a href="index.html#ReleaseAsset">ReleaseAsset</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UploadReleaseAsset creates an asset by uploading a file into a release repository.
|
|
To upload assets that cannot be represented by an os.File, call NewUploadRequest directly.
|
|
</p>
|
|
<p>
|
|
GitHub API docs : <a href="http://developer.github.com/v3/repos/releases/#upload-a-release-asset">http://developer.github.com/v3/repos/releases/#upload-a-release-asset</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Repository">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=444:5213#L7">Repository</a></h2>
|
|
<pre>type Repository struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Owner *<a href="index.html#User">User</a> `json:"owner,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
FullName *<a href="../../../../builtin/index.html#string">string</a> `json:"full_name,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
Homepage *<a href="../../../../builtin/index.html#string">string</a> `json:"homepage,omitempty"`
|
|
DefaultBranch *<a href="../../../../builtin/index.html#string">string</a> `json:"default_branch,omitempty"`
|
|
MasterBranch *<a href="../../../../builtin/index.html#string">string</a> `json:"master_branch,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
PushedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"pushed_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
CloneURL *<a href="../../../../builtin/index.html#string">string</a> `json:"clone_url,omitempty"`
|
|
GitURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_url,omitempty"`
|
|
MirrorURL *<a href="../../../../builtin/index.html#string">string</a> `json:"mirror_url,omitempty"`
|
|
SSHURL *<a href="../../../../builtin/index.html#string">string</a> `json:"ssh_url,omitempty"`
|
|
SVNURL *<a href="../../../../builtin/index.html#string">string</a> `json:"svn_url,omitempty"`
|
|
Language *<a href="../../../../builtin/index.html#string">string</a> `json:"language,omitempty"`
|
|
Fork *<a href="../../../../builtin/index.html#bool">bool</a> `json:"fork"`
|
|
ForksCount *<a href="../../../../builtin/index.html#int">int</a> `json:"forks_count,omitempty"`
|
|
NetworkCount *<a href="../../../../builtin/index.html#int">int</a> `json:"network_count,omitempty"`
|
|
OpenIssuesCount *<a href="../../../../builtin/index.html#int">int</a> `json:"open_issues_count,omitempty"`
|
|
StargazersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"stargazers_count,omitempty"`
|
|
SubscribersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"subscribers_count,omitempty"`
|
|
WatchersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"watchers_count,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
AutoInit *<a href="../../../../builtin/index.html#bool">bool</a> `json:"auto_init,omitempty"`
|
|
Parent *<a href="index.html#Repository">Repository</a> `json:"parent,omitempty"`
|
|
Source *<a href="index.html#Repository">Repository</a> `json:"source,omitempty"`
|
|
Organization *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
Permissions *map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#bool">bool</a> `json:"permissions,omitempty"`
|
|
|
|
<span class="comment">// Only provided when using RepositoriesService.Get while in preview</span>
|
|
License *<a href="index.html#License">License</a> `json:"license,omitempty"`
|
|
|
|
<span class="comment">// Additional mutable fields when creating and editing a repository</span>
|
|
Private *<a href="../../../../builtin/index.html#bool">bool</a> `json:"private"`
|
|
HasIssues *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_issues"`
|
|
HasWiki *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_wiki"`
|
|
HasDownloads *<a href="../../../../builtin/index.html#bool">bool</a> `json:"has_downloads"`
|
|
<span class="comment">// Creating an organization repository. Required for non-owners.</span>
|
|
TeamID *<a href="../../../../builtin/index.html#int">int</a> `json:"team_id"`
|
|
|
|
<span class="comment">// API URLs</span>
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
ArchiveURL *<a href="../../../../builtin/index.html#string">string</a> `json:"archive_url,omitempty"`
|
|
AssigneesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"assignees_url,omitempty"`
|
|
BlobsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"blobs_url,omitempty"`
|
|
BranchesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"branches_url,omitempty"`
|
|
CollaboratorsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"collaborators_url,omitempty"`
|
|
CommentsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"comments_url,omitempty"`
|
|
CommitsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"commits_url,omitempty"`
|
|
CompareURL *<a href="../../../../builtin/index.html#string">string</a> `json:"compare_url,omitempty"`
|
|
ContentsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"contents_url,omitempty"`
|
|
ContributorsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"contributors_url,omitempty"`
|
|
DownloadsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"downloads_url,omitempty"`
|
|
EventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"events_url,omitempty"`
|
|
ForksURL *<a href="../../../../builtin/index.html#string">string</a> `json:"forks_url,omitempty"`
|
|
GitCommitsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_commits_url,omitempty"`
|
|
GitRefsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_refs_url,omitempty"`
|
|
GitTagsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_tags_url,omitempty"`
|
|
HooksURL *<a href="../../../../builtin/index.html#string">string</a> `json:"hooks_url,omitempty"`
|
|
IssueCommentURL *<a href="../../../../builtin/index.html#string">string</a> `json:"issue_comment_url,omitempty"`
|
|
IssueEventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"issue_events_url,omitempty"`
|
|
IssuesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"issues_url,omitempty"`
|
|
KeysURL *<a href="../../../../builtin/index.html#string">string</a> `json:"keys_url,omitempty"`
|
|
LabelsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"labels_url,omitempty"`
|
|
LanguagesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"languages_url,omitempty"`
|
|
MergesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"merges_url,omitempty"`
|
|
MilestonesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"milestones_url,omitempty"`
|
|
NotificationsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"notifications_url,omitempty"`
|
|
PullsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"pulls_url,omitempty"`
|
|
ReleasesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"releases_url,omitempty"`
|
|
StargazersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"stargazers_url,omitempty"`
|
|
StatusesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"statuses_url,omitempty"`
|
|
SubscribersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"subscribers_url,omitempty"`
|
|
SubscriptionURL *<a href="../../../../builtin/index.html#string">string</a> `json:"subscription_url,omitempty"`
|
|
TagsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"tags_url,omitempty"`
|
|
TreesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"trees_url,omitempty"`
|
|
TeamsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"teams_url,omitempty"`
|
|
|
|
<span class="comment">// TextMatches is only populated from search results that request text matches</span>
|
|
<span class="comment">// See: search.go and https://developer.github.com/v3/search/#text-match-metadata</span>
|
|
TextMatches []<a href="index.html#TextMatch">TextMatch</a> `json:"text_matches,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Repository represents a GitHub repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Repository.String">func (Repository) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=5215:5250#L94">String</a></h3>
|
|
<pre>func (r <a href="index.html#Repository">Repository</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryAddCollaboratorOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_collaborators.go?s=1617:2155#L44">RepositoryAddCollaboratorOptions</a></h2>
|
|
<pre>type RepositoryAddCollaboratorOptions struct {
|
|
<span class="comment">// Permission specifies the permission to grant the user on this repository.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// pull - team members can pull, but not push to or administer this repository</span>
|
|
<span class="comment">// push - team members can pull and push, but not administer this repository</span>
|
|
<span class="comment">// admin - team members can pull, push and administer this repository</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Default value is "push". This option is only valid for organization-owned repositories.</span>
|
|
Permission <a href="../../../../builtin/index.html#string">string</a> `json:"permission,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryAddCollaboratorOptions specifies the optional parameters to the
|
|
RepositoriesService.AddCollaborator method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryComment">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=300:893#L4">RepositoryComment</a></h2>
|
|
<pre>type RepositoryComment struct {
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
CommitID *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_id,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
Reactions *<a href="index.html#Reactions">Reactions</a> `json:"reactions,omitempty"`
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"updated_at,omitempty"`
|
|
|
|
<span class="comment">// User-mutable fields</span>
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body"`
|
|
<span class="comment">// User-initialized fields</span>
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
Position *<a href="../../../../builtin/index.html#int">int</a> `json:"position,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryComment represents a comment for a commit, file, or line in a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryComment.String">func (RepositoryComment) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_comments.go?s=895:937#L21">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepositoryComment">RepositoryComment</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryCommit">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=470:1106#L7">RepositoryCommit</a></h2>
|
|
<pre>type RepositoryCommit struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Commit *<a href="index.html#Commit">Commit</a> `json:"commit,omitempty"`
|
|
Author *<a href="index.html#User">User</a> `json:"author,omitempty"`
|
|
Committer *<a href="index.html#User">User</a> `json:"committer,omitempty"`
|
|
Parents []<a href="index.html#Commit">Commit</a> `json:"parents,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
|
|
<span class="comment">// Details about how many changes were made in this commit. Only filled in during GetCommit!</span>
|
|
Stats *<a href="index.html#CommitStats">CommitStats</a> `json:"stats,omitempty"`
|
|
<span class="comment">// Details about which files, and how this commit touched. Only filled in during GetCommit!</span>
|
|
Files []<a href="index.html#CommitFile">CommitFile</a> `json:"files,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryCommit represents a commit in a repo.
|
|
Note that it's wrapping a Commit, so author/committer information is in two places,
|
|
but contain different details about them: in RepositoryCommit "github details", in Commit - "git details".
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryCommit.String">func (RepositoryCommit) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_commits.go?s=1108:1149#L22">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepositoryCommit">RepositoryCommit</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryContent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=451:1135#L13">RepositoryContent</a></h2>
|
|
<pre>type RepositoryContent struct {
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
Encoding *<a href="../../../../builtin/index.html#string">string</a> `json:"encoding,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
<span class="comment">// Content contains the actual file content, which may be encoded.</span>
|
|
<span class="comment">// Callers should call GetContent which will decode the content if</span>
|
|
<span class="comment">// necessary.</span>
|
|
Content *<a href="../../../../builtin/index.html#string">string</a> `json:"content,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
GitURL *<a href="../../../../builtin/index.html#string">string</a> `json:"git_url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
DownloadURL *<a href="../../../../builtin/index.html#string">string</a> `json:"download_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryContent represents a file or directory in a github repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryContent.Decode">func (*RepositoryContent) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=2278:2330#L60">Decode</a></h3>
|
|
<pre>func (r *<a href="index.html#RepositoryContent">RepositoryContent</a>) Decode() ([]<a href="../../../../builtin/index.html#byte">byte</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Decode decodes the file content if it is base64 encoded.
|
|
</p>
|
|
<p>
|
|
Deprecated: Use GetContent instead.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryContent.GetContent">func (*RepositoryContent) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=2596:2652#L72">GetContent</a></h3>
|
|
<pre>func (r *<a href="index.html#RepositoryContent">RepositoryContent</a>) GetContent() (<a href="../../../../builtin/index.html#string">string</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetContent returns the content of r, decoding it if necessary.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryContent.String">func (RepositoryContent) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=2107:2149#L53">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepositoryContent">RepositoryContent</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
String converts RepositoryContent to a string. It's primarily for testing.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryContentFileOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=1476:1841#L37">RepositoryContentFileOptions</a></h2>
|
|
<pre>type RepositoryContentFileOptions struct {
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
Content []<a href="../../../../builtin/index.html#byte">byte</a> `json:"content,omitempty"` <span class="comment">// unencoded</span>
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Branch *<a href="../../../../builtin/index.html#string">string</a> `json:"branch,omitempty"`
|
|
Author *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"author,omitempty"`
|
|
Committer *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"committer,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryContentFileOptions specifies optional parameters for CreateFile, UpdateFile, and DeleteFile.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryContentGetOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=1950:2027#L48">RepositoryContentGetOptions</a></h2>
|
|
<pre>type RepositoryContentGetOptions struct {
|
|
Ref <a href="../../../../builtin/index.html#string">string</a> `url:"ref,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryContentGetOptions represents an optional ref parameter, which can be a SHA,
|
|
branch, or tag
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryContentResponse">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_contents.go?s=1237:1368#L31">RepositoryContentResponse</a></h2>
|
|
<pre>type RepositoryContentResponse struct {
|
|
Content *<a href="index.html#RepositoryContent">RepositoryContent</a> `json:"content,omitempty"`
|
|
<a href="index.html#Commit">Commit</a> `json:"commit,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryContentResponse holds the parsed response from CreateFile, UpdateFile, and DeleteFile.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryCreateForkOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_forks.go?s=1250:1395#L36">RepositoryCreateForkOptions</a></h2>
|
|
<pre>type RepositoryCreateForkOptions struct {
|
|
<span class="comment">// The organization to fork the repository into.</span>
|
|
Organization <a href="../../../../builtin/index.html#string">string</a> `url:"organization,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryCreateForkOptions specifies the optional parameters to the
|
|
RepositoriesService.CreateFork method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=16614:17027#L390">RepositoryEvent</a></h2>
|
|
<pre>type RepositoryEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible values are: "created", "deleted",</span>
|
|
<span class="comment">// "publicized", "privatized".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Org *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryEvent is triggered when a repository is created.
|
|
The Webhook event name is "repository".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to
|
|
trigger organization webhooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#repositoryevent">https://developer.github.com/v3/activity/events/types/#repositoryevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryInvitation">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_invitations.go?s=275:858#L1">RepositoryInvitation</a></h2>
|
|
<pre>type RepositoryInvitation struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Invitee *<a href="index.html#User">User</a> `json:"invitee,omitempty"`
|
|
Inviter *<a href="index.html#User">User</a> `json:"inviter,omitempty"`
|
|
|
|
<span class="comment">// Permissions represents the permissions that the associated user will have</span>
|
|
<span class="comment">// on the repository. Possible values are: "read", "write", "admin".</span>
|
|
Permissions *<a href="../../../../builtin/index.html#string">string</a> `json:"permissions,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryInvitation represents an invitation to collaborate on a repo.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryListAllOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=8700:8824#L205">RepositoryListAllOptions</a></h2>
|
|
<pre>type RepositoryListAllOptions struct {
|
|
<span class="comment">// ID of the last repository seen</span>
|
|
Since <a href="../../../../builtin/index.html#int">int</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
RepositoryListAllOptions specifies the optional parameters to the
|
|
RepositoriesService.ListAll method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryListByOrgOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=7629:7846#L168">RepositoryListByOrgOptions</a></h2>
|
|
<pre>type RepositoryListByOrgOptions struct {
|
|
<span class="comment">// Type of repositories to list. Possible values are: all, public, private,</span>
|
|
<span class="comment">// forks, sources, member. Default is "all".</span>
|
|
Type <a href="../../../../builtin/index.html#string">string</a> `url:"type,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
RepositoryListByOrgOptions specifies the optional parameters to the
|
|
RepositoriesService.ListByOrg method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryListForksOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_forks.go?s=312:510#L2">RepositoryListForksOptions</a></h2>
|
|
<pre>type RepositoryListForksOptions struct {
|
|
<span class="comment">// How to sort the forks list. Possible values are: newest, oldest,</span>
|
|
<span class="comment">// watchers. Default is "newest".</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
RepositoryListForksOptions specifies the optional parameters to the
|
|
RepositoriesService.ListForks method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=5379:6663#L100">RepositoryListOptions</a></h2>
|
|
<pre>type RepositoryListOptions struct {
|
|
<span class="comment">// Visibility of repositories to list. Can be one of all, public, or private.</span>
|
|
<span class="comment">// Default: all</span>
|
|
Visibility <a href="../../../../builtin/index.html#string">string</a> `url:"visibility,omitempty"`
|
|
|
|
<span class="comment">// List repos of given affiliation[s].</span>
|
|
<span class="comment">// Comma-separated list of values. Can include:</span>
|
|
<span class="comment">// * owner: Repositories that are owned by the authenticated user.</span>
|
|
<span class="comment">// * collaborator: Repositories that the user has been added to as a</span>
|
|
<span class="comment">// collaborator.</span>
|
|
<span class="comment">// * organization_member: Repositories that the user has access to through</span>
|
|
<span class="comment">// being a member of an organization. This includes every repository on</span>
|
|
<span class="comment">// every team that the user is on.</span>
|
|
<span class="comment">// Default: owner,collaborator,organization_member</span>
|
|
Affiliation <a href="../../../../builtin/index.html#string">string</a> `url:"affiliation,omitempty"`
|
|
|
|
<span class="comment">// Type of repositories to list.</span>
|
|
<span class="comment">// Can be one of all, owner, public, private, member. Default: all</span>
|
|
<span class="comment">// Will cause a 422 error if used in the same request as visibility or</span>
|
|
<span class="comment">// affiliation.</span>
|
|
Type <a href="../../../../builtin/index.html#string">string</a> `url:"type,omitempty"`
|
|
|
|
<span class="comment">// How to sort the repository list. Can be one of created, updated, pushed,</span>
|
|
<span class="comment">// full_name. Default: full_name</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Direction in which to sort repositories. Can be one of asc or desc.</span>
|
|
<span class="comment">// Default: when using full_name: asc; otherwise desc</span>
|
|
Direction <a href="../../../../builtin/index.html#string">string</a> `url:"direction,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
RepositoryListOptions specifies the optional parameters to the
|
|
RepositoriesService.List method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryMergeRequest">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_merging.go?s=290:479#L4">RepositoryMergeRequest</a></h2>
|
|
<pre>type RepositoryMergeRequest struct {
|
|
Base *<a href="../../../../builtin/index.html#string">string</a> `json:"base,omitempty"`
|
|
Head *<a href="../../../../builtin/index.html#string">string</a> `json:"head,omitempty"`
|
|
CommitMessage *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_message,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryMergeRequest represents a request to merge a branch in a
|
|
repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryParticipation">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=4565:4678#L128">RepositoryParticipation</a></h2>
|
|
<pre>type RepositoryParticipation struct {
|
|
All []<a href="../../../../builtin/index.html#int">int</a> `json:"all,omitempty"`
|
|
Owner []<a href="../../../../builtin/index.html#int">int</a> `json:"owner,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryParticipation is the number of commits by everyone
|
|
who has contributed to the repository (including the owner)
|
|
as well as the number of commits by the owner themself.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryParticipation.String">func (RepositoryParticipation) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=4680:4728#L133">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepositoryParticipation">RepositoryParticipation</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryRelease">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=341:1394#L10">RepositoryRelease</a></h2>
|
|
<pre>type RepositoryRelease struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
TagName *<a href="../../../../builtin/index.html#string">string</a> `json:"tag_name,omitempty"`
|
|
TargetCommitish *<a href="../../../../builtin/index.html#string">string</a> `json:"target_commitish,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Body *<a href="../../../../builtin/index.html#string">string</a> `json:"body,omitempty"`
|
|
Draft *<a href="../../../../builtin/index.html#bool">bool</a> `json:"draft,omitempty"`
|
|
Prerelease *<a href="../../../../builtin/index.html#bool">bool</a> `json:"prerelease,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
PublishedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"published_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
AssetsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"assets_url,omitempty"`
|
|
Assets []<a href="index.html#ReleaseAsset">ReleaseAsset</a> `json:"assets,omitempty"`
|
|
UploadURL *<a href="../../../../builtin/index.html#string">string</a> `json:"upload_url,omitempty"`
|
|
ZipballURL *<a href="../../../../builtin/index.html#string">string</a> `json:"zipball_url,omitempty"`
|
|
TarballURL *<a href="../../../../builtin/index.html#string">string</a> `json:"tarball_url,omitempty"`
|
|
Author *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"author,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryRelease represents a GitHub release in a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="RepositoryRelease.String">func (RepositoryRelease) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_releases.go?s=1396:1438#L30">String</a></h3>
|
|
<pre>func (r <a href="index.html#RepositoryRelease">RepositoryRelease</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RepositoryTag">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=15715:15936#L446">RepositoryTag</a></h2>
|
|
<pre>type RepositoryTag struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Commit *<a href="index.html#Commit">Commit</a> `json:"commit,omitempty"`
|
|
ZipballURL *<a href="../../../../builtin/index.html#string">string</a> `json:"zipball_url,omitempty"`
|
|
TarballURL *<a href="../../../../builtin/index.html#string">string</a> `json:"tarball_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RepositoryTag represents a repository tag.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="RequiredStatusChecks">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos.go?s=17084:17394#L491">RequiredStatusChecks</a></h2>
|
|
<pre>type RequiredStatusChecks struct {
|
|
<span class="comment">// Who required status checks apply to.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// off</span>
|
|
<span class="comment">// non_admins</span>
|
|
<span class="comment">// everyone</span>
|
|
EnforcementLevel *<a href="../../../../builtin/index.html#string">string</a> `json:"enforcement_level,omitempty"`
|
|
<span class="comment">// The list of status checks which are required</span>
|
|
Contexts *[]<a href="../../../../builtin/index.html#string">string</a> `json:"contexts,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
RequiredStatusChecks represents the protection status of a individual branch
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Response">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=8845:9194#L254">Response</a></h2>
|
|
<pre>type Response struct {
|
|
*<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>
|
|
|
|
NextPage <a href="../../../../builtin/index.html#int">int</a>
|
|
PrevPage <a href="../../../../builtin/index.html#int">int</a>
|
|
FirstPage <a href="../../../../builtin/index.html#int">int</a>
|
|
LastPage <a href="../../../../builtin/index.html#int">int</a>
|
|
|
|
<a href="index.html#Rate">Rate</a>
|
|
}</pre>
|
|
<p>
|
|
Response is a GitHub API response. This wraps the standard http.Response
|
|
returned from GitHub and provides convenient access to things like
|
|
pagination links.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Scope">type <a href="http://localhost:6060/src/github.com/google/go-github/github/authorizations.go?s=314:331#L3">Scope</a></h2>
|
|
<pre>type Scope <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
<p>
|
|
Scope models a GitHub authorization scope.
|
|
</p>
|
|
<p>
|
|
GitHub API docs:<a href="https://developer.github.com/v3/oauth/#scopes">https://developer.github.com/v3/oauth/#scopes</a>
|
|
</p>
|
|
|
|
|
|
|
|
<pre>const (
|
|
<span id="ScopeNone">ScopeNone</span> <a href="index.html#Scope">Scope</a> = "(no scope)" <span class="comment">// REVISIT: is this actually returned, or just a documentation artifact?</span>
|
|
<span id="ScopeUser">ScopeUser</span> <a href="index.html#Scope">Scope</a> = "user"
|
|
<span id="ScopeUserEmail">ScopeUserEmail</span> <a href="index.html#Scope">Scope</a> = "user:email"
|
|
<span id="ScopeUserFollow">ScopeUserFollow</span> <a href="index.html#Scope">Scope</a> = "user:follow"
|
|
<span id="ScopePublicRepo">ScopePublicRepo</span> <a href="index.html#Scope">Scope</a> = "public_repo"
|
|
<span id="ScopeRepo">ScopeRepo</span> <a href="index.html#Scope">Scope</a> = "repo"
|
|
<span id="ScopeRepoDeployment">ScopeRepoDeployment</span> <a href="index.html#Scope">Scope</a> = "repo_deployment"
|
|
<span id="ScopeRepoStatus">ScopeRepoStatus</span> <a href="index.html#Scope">Scope</a> = "repo:status"
|
|
<span id="ScopeDeleteRepo">ScopeDeleteRepo</span> <a href="index.html#Scope">Scope</a> = "delete_repo"
|
|
<span id="ScopeNotifications">ScopeNotifications</span> <a href="index.html#Scope">Scope</a> = "notifications"
|
|
<span id="ScopeGist">ScopeGist</span> <a href="index.html#Scope">Scope</a> = "gist"
|
|
<span id="ScopeReadRepoHook">ScopeReadRepoHook</span> <a href="index.html#Scope">Scope</a> = "read:repo_hook"
|
|
<span id="ScopeWriteRepoHook">ScopeWriteRepoHook</span> <a href="index.html#Scope">Scope</a> = "write:repo_hook"
|
|
<span id="ScopeAdminRepoHook">ScopeAdminRepoHook</span> <a href="index.html#Scope">Scope</a> = "admin:repo_hook"
|
|
<span id="ScopeAdminOrgHook">ScopeAdminOrgHook</span> <a href="index.html#Scope">Scope</a> = "admin:org_hook"
|
|
<span id="ScopeReadOrg">ScopeReadOrg</span> <a href="index.html#Scope">Scope</a> = "read:org"
|
|
<span id="ScopeWriteOrg">ScopeWriteOrg</span> <a href="index.html#Scope">Scope</a> = "write:org"
|
|
<span id="ScopeAdminOrg">ScopeAdminOrg</span> <a href="index.html#Scope">Scope</a> = "admin:org"
|
|
<span id="ScopeReadPublicKey">ScopeReadPublicKey</span> <a href="index.html#Scope">Scope</a> = "read:public_key"
|
|
<span id="ScopeWritePublicKey">ScopeWritePublicKey</span> <a href="index.html#Scope">Scope</a> = "write:public_key"
|
|
<span id="ScopeAdminPublicKey">ScopeAdminPublicKey</span> <a href="index.html#Scope">Scope</a> = "admin:public_key"
|
|
<span id="ScopeReadGPGKey">ScopeReadGPGKey</span> <a href="index.html#Scope">Scope</a> = "read:gpg_key"
|
|
<span id="ScopeWriteGPGKey">ScopeWriteGPGKey</span> <a href="index.html#Scope">Scope</a> = "write:gpg_key"
|
|
<span id="ScopeAdminGPGKey">ScopeAdminGPGKey</span> <a href="index.html#Scope">Scope</a> = "admin:gpg_key"
|
|
)</pre>
|
|
<p>
|
|
This is the set of scopes for GitHub API V3
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="SearchOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=505:1077#L11">SearchOptions</a></h2>
|
|
<pre>type SearchOptions struct {
|
|
<span class="comment">// How to sort the search results. Possible values are:</span>
|
|
<span class="comment">// - for repositories: stars, fork, updated</span>
|
|
<span class="comment">// - for code: indexed</span>
|
|
<span class="comment">// - for issues: comments, created, updated</span>
|
|
<span class="comment">// - for users: followers, repositories, joined</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// Default is to sort by best match.</span>
|
|
Sort <a href="../../../../builtin/index.html#string">string</a> `url:"sort,omitempty"`
|
|
|
|
<span class="comment">// Sort order if sort parameter is provided. Possible values are: asc,</span>
|
|
<span class="comment">// desc. Default is desc.</span>
|
|
Order <a href="../../../../builtin/index.html#string">string</a> `url:"order,omitempty"`
|
|
|
|
<span class="comment">// Whether to retrieve text match metadata with a query</span>
|
|
TextMatch <a href="../../../../builtin/index.html#bool">bool</a> `url:"-"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
SearchOptions specifies optional parameters to the SearchService methods.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="SearchService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=400:426#L8">SearchService</a></h2>
|
|
<pre>type SearchService service</pre>
|
|
<p>
|
|
SearchService provides access to the search related functions
|
|
in the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/search/">http://developer.github.com/v3/search/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="SearchService.Code">func (*SearchService) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=4068:4168#L118">Code</a></h3>
|
|
<pre>func (s *<a href="index.html#SearchService">SearchService</a>) Code(query <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#SearchOptions">SearchOptions</a>) (*<a href="index.html#CodeSearchResult">CodeSearchResult</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Code searches code via various criteria.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/search/#search-code">http://developer.github.com/v3/search/#search-code</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="SearchService.Issues">func (*SearchService) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=2010:2114#L55">Issues</a></h3>
|
|
<pre>func (s *<a href="index.html#SearchService">SearchService</a>) Issues(query <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#SearchOptions">SearchOptions</a>) (*<a href="index.html#IssuesSearchResult">IssuesSearchResult</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Issues searches issues via various criteria.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/search/#search-issues">http://developer.github.com/v3/search/#search-issues</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="SearchService.Repositories">func (*SearchService) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=1449:1565#L40">Repositories</a></h3>
|
|
<pre>func (s *<a href="index.html#SearchService">SearchService</a>) Repositories(query <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#SearchOptions">SearchOptions</a>) (*<a href="index.html#RepositoriesSearchResult">RepositoriesSearchResult</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Repositories searches repositories via various criteria.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/search/#search-repositories">http://developer.github.com/v3/search/#search-repositories</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="SearchService.Users">func (*SearchService) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=2538:2640#L70">Users</a></h3>
|
|
<pre>func (s *<a href="index.html#SearchService">SearchService</a>) Users(query <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#SearchOptions">SearchOptions</a>) (*<a href="index.html#UsersSearchResult">UsersSearchResult</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Users searches users via various criteria.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/search/#search-users">http://developer.github.com/v3/search/#search-users</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="ServiceHook">type <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=4617:4868#L159">ServiceHook</a></h2>
|
|
<pre>type ServiceHook struct {
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Events []<a href="../../../../builtin/index.html#string">string</a> `json:"events,omitempty"`
|
|
SupportedEvents []<a href="../../../../builtin/index.html#string">string</a> `json:"supported_events,omitempty"`
|
|
Schema [][]<a href="../../../../builtin/index.html#string">string</a> `json:"schema,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
ServiceHook represents a hook that has configuration settings, a list of
|
|
available events, and default events.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="ServiceHook.String">func (*ServiceHook) <a href="http://localhost:6060/src/github.com/google/go-github/github/misc.go?s=4870:4907#L166">String</a></h3>
|
|
<pre>func (s *<a href="index.html#ServiceHook">ServiceHook</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="SignatureVerification">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_commits.go?s=277:500#L4">SignatureVerification</a></h2>
|
|
<pre>type SignatureVerification struct {
|
|
Verified *<a href="../../../../builtin/index.html#bool">bool</a> `json:"verified,omitempty"`
|
|
Reason *<a href="../../../../builtin/index.html#string">string</a> `json:"reason,omitempty"`
|
|
Signature *<a href="../../../../builtin/index.html#string">string</a> `json:"signature,omitempty"`
|
|
Payload *<a href="../../../../builtin/index.html#string">string</a> `json:"payload,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
SignatureVerification represents GPG signature verification.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Source">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_timeline.go?s=3926:4063#L111">Source</a></h2>
|
|
<pre>type Source struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Actor *<a href="index.html#User">User</a> `json:"actor,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Source represents a reference's source.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="SourceImportAuthor">type <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=5644:6002#L106">SourceImportAuthor</a></h2>
|
|
<pre>type SourceImportAuthor struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
RemoteID *<a href="../../../../builtin/index.html#string">string</a> `json:"remote_id,omitempty"`
|
|
RemoteName *<a href="../../../../builtin/index.html#string">string</a> `json:"remote_name,omitempty"`
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
ImportURL *<a href="../../../../builtin/index.html#string">string</a> `json:"import_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
SourceImportAuthor identifies an author imported from a source repository.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/migration/source_imports/#get-commit-authors">https://developer.github.com/v3/migration/source_imports/#get-commit-authors</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="SourceImportAuthor.String">func (SourceImportAuthor) <a href="http://localhost:6060/src/github.com/google/go-github/github/migrations_source_import.go?s=6004:6047#L116">String</a></h3>
|
|
<pre>func (a <a href="index.html#SourceImportAuthor">SourceImportAuthor</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Stargazer">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=448:571#L7">Stargazer</a></h2>
|
|
<pre>type Stargazer struct {
|
|
StarredAt *<a href="index.html#Timestamp">Timestamp</a> `json:"starred_at,omitempty"`
|
|
User *<a href="index.html#User">User</a> `json:"user,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Stargazer represents a user that has starred a repository.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="StarredRepository">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_star.go?s=249:384#L1">StarredRepository</a></h2>
|
|
<pre>type StarredRepository struct {
|
|
StarredAt *<a href="index.html#Timestamp">Timestamp</a> `json:"starred_at,omitempty"`
|
|
Repository *<a href="index.html#Repository">Repository</a> `json:"repo,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
StarredRepository is returned by ListStarred.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="StatusEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=17319:18182#L408">StatusEvent</a></h2>
|
|
<pre>type StatusEvent struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
<span class="comment">// State is the new state. Possible values are: "pending", "success", "failure", "error".</span>
|
|
State *<a href="../../../../builtin/index.html#string">string</a> `json:"state,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
TargetURL *<a href="../../../../builtin/index.html#string">string</a> `json:"target_url,omitempty"`
|
|
Branches []*<a href="index.html#Branch">Branch</a> `json:"branches,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Context *<a href="../../../../builtin/index.html#string">string</a> `json:"context,omitempty"`
|
|
Commit *<a href="index.html#PushEventCommit">PushEventCommit</a> `json:"commit,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
StatusEvent is triggered when the status of a Git commit changes.
|
|
The Webhook event name is "status".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines, they are only used to
|
|
trigger hooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#statusevent">https://developer.github.com/v3/activity/events/types/#statusevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Subscription">type <a href="http://localhost:6060/src/github.com/google/go-github/github/activity_watching.go?s=264:743#L1">Subscription</a></h2>
|
|
<pre>type Subscription struct {
|
|
Subscribed *<a href="../../../../builtin/index.html#bool">bool</a> `json:"subscribed,omitempty"`
|
|
Ignored *<a href="../../../../builtin/index.html#bool">bool</a> `json:"ignored,omitempty"`
|
|
Reason *<a href="../../../../builtin/index.html#string">string</a> `json:"reason,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
|
|
<span class="comment">// only populated for repository subscriptions</span>
|
|
RepositoryURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repository_url,omitempty"`
|
|
|
|
<span class="comment">// only populated for thread subscriptions</span>
|
|
ThreadURL *<a href="../../../../builtin/index.html#string">string</a> `json:"thread_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Subscription identifies a repository or thread subscription.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Tag">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_tags.go?s=237:695#L3">Tag</a></h2>
|
|
<pre>type Tag struct {
|
|
Tag *<a href="../../../../builtin/index.html#string">string</a> `json:"tag,omitempty"`
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
Tagger *<a href="index.html#CommitAuthor">CommitAuthor</a> `json:"tagger,omitempty"`
|
|
Object *<a href="index.html#GitObject">GitObject</a> `json:"object,omitempty"`
|
|
Verification *<a href="index.html#SignatureVerification">SignatureVerification</a> `json:"verification,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Tag represents a tag object.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Team">type <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=327:1588#L2">Team</a></h2>
|
|
<pre>type Team struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Description *<a href="../../../../builtin/index.html#string">string</a> `json:"description,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
Slug *<a href="../../../../builtin/index.html#string">string</a> `json:"slug,omitempty"`
|
|
|
|
<span class="comment">// Permission is deprecated when creating or editing a team in an org</span>
|
|
<span class="comment">// using the new GitHub permission model. It no longer identifies the</span>
|
|
<span class="comment">// permission a team has on its repos, but only specifies the default</span>
|
|
<span class="comment">// permission a repo is initially added with. Avoid confusion by</span>
|
|
<span class="comment">// specifying a permission value when calling AddTeamRepo.</span>
|
|
Permission *<a href="../../../../builtin/index.html#string">string</a> `json:"permission,omitempty"`
|
|
|
|
<span class="comment">// Privacy identifies the level of privacy this team should have.</span>
|
|
<span class="comment">// Possible values are:</span>
|
|
<span class="comment">// secret - only visible to organization owners and members of this team</span>
|
|
<span class="comment">// closed - visible to all members of this organization</span>
|
|
<span class="comment">// Default is "secret".</span>
|
|
Privacy *<a href="../../../../builtin/index.html#string">string</a> `json:"privacy,omitempty"`
|
|
|
|
MembersCount *<a href="../../../../builtin/index.html#int">int</a> `json:"members_count,omitempty"`
|
|
ReposCount *<a href="../../../../builtin/index.html#int">int</a> `json:"repos_count,omitempty"`
|
|
Organization *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
MembersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"members_url,omitempty"`
|
|
RepositoriesURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repositories_url,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Team represents a team within a GitHub organization. Teams are used to
|
|
manage access to an organization's repositories.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Team.String">func (Team) <a href="http://localhost:6060/src/github.com/google/go-github/github/orgs_teams.go?s=1590:1619#L30">String</a></h3>
|
|
<pre>func (t <a href="index.html#Team">Team</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="TeamAddEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=18483:18767#L434">TeamAddEvent</a></h2>
|
|
<pre>type TeamAddEvent struct {
|
|
Team *<a href="index.html#Team">Team</a> `json:"team,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Org *<a href="index.html#Organization">Organization</a> `json:"organization,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
TeamAddEvent is triggered when a repository is added to a team.
|
|
The Webhook event name is "team_add".
|
|
</p>
|
|
<p>
|
|
Events of this type are not visible in timelines. These events are only used
|
|
to trigger hooks.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#teamaddevent">https://developer.github.com/v3/activity/events/types/#teamaddevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="TextMatch">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=2963:3232#L83">TextMatch</a></h2>
|
|
<pre>type TextMatch struct {
|
|
ObjectURL *<a href="../../../../builtin/index.html#string">string</a> `json:"object_url,omitempty"`
|
|
ObjectType *<a href="../../../../builtin/index.html#string">string</a> `json:"object_type,omitempty"`
|
|
Property *<a href="../../../../builtin/index.html#string">string</a> `json:"property,omitempty"`
|
|
Fragment *<a href="../../../../builtin/index.html#string">string</a> `json:"fragment,omitempty"`
|
|
Matches []<a href="index.html#Match">Match</a> `json:"matches,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
TextMatch represents a text match for a SearchResult
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="TextMatch.String">func (TextMatch) <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=3234:3269#L91">String</a></h3>
|
|
<pre>func (tm <a href="index.html#TextMatch">TextMatch</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Timeline">type <a href="http://localhost:6060/src/github.com/google/go-github/github/issues_timeline.go?s=432:3881#L7">Timeline</a></h2>
|
|
<pre>type Timeline struct {
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
CommitURL *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_url,omitempty"`
|
|
|
|
<span class="comment">// The User object that generated the event.</span>
|
|
Actor *<a href="index.html#User">User</a> `json:"actor,omitempty"`
|
|
|
|
<span class="comment">// Event identifies the actual type of Event that occurred. Possible values</span>
|
|
<span class="comment">// are:</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// assigned</span>
|
|
<span class="comment">// The issue was assigned to the assignee.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// closed</span>
|
|
<span class="comment">// The issue was closed by the actor. When the commit_id is present, it</span>
|
|
<span class="comment">// identifies the commit that closed the issue using "closes / fixes #NN"</span>
|
|
<span class="comment">// syntax.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// commented</span>
|
|
<span class="comment">// A comment was added to the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// committed</span>
|
|
<span class="comment">// A commit was added to the pull request's 'HEAD' branch. Only provided</span>
|
|
<span class="comment">// for pull requests.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// cross-referenced</span>
|
|
<span class="comment">// The issue was referenced from another issue. The 'source' attribute</span>
|
|
<span class="comment">// contains the 'id', 'actor', and 'url' of the reference's source.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// demilestoned</span>
|
|
<span class="comment">// The issue was removed from a milestone.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// head_ref_deleted</span>
|
|
<span class="comment">// The pull request's branch was deleted.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// head_ref_restored</span>
|
|
<span class="comment">// The pull request's branch was restored.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// labeled</span>
|
|
<span class="comment">// A label was added to the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// locked</span>
|
|
<span class="comment">// The issue was locked by the actor.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// mentioned</span>
|
|
<span class="comment">// The actor was @mentioned in an issue body.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// merged</span>
|
|
<span class="comment">// The issue was merged by the actor. The 'commit_id' attribute is the</span>
|
|
<span class="comment">// SHA1 of the HEAD commit that was merged.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// milestoned</span>
|
|
<span class="comment">// The issue was added to a milestone.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// referenced</span>
|
|
<span class="comment">// The issue was referenced from a commit message. The 'commit_id'</span>
|
|
<span class="comment">// attribute is the commit SHA1 of where that happened.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// renamed</span>
|
|
<span class="comment">// The issue title was changed.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// reopened</span>
|
|
<span class="comment">// The issue was reopened by the actor.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// subscribed</span>
|
|
<span class="comment">// The actor subscribed to receive notifications for an issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// unassigned</span>
|
|
<span class="comment">// The assignee was unassigned from the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// unlabeled</span>
|
|
<span class="comment">// A label was removed from the issue.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// unlocked</span>
|
|
<span class="comment">// The issue was unlocked by the actor.</span>
|
|
<span class="comment">//</span>
|
|
<span class="comment">// unsubscribed</span>
|
|
<span class="comment">// The actor unsubscribed to stop receiving notifications for an issue.</span>
|
|
<span class="comment">//</span>
|
|
Event *<a href="../../../../builtin/index.html#string">string</a> `json:"event,omitempty"`
|
|
|
|
<span class="comment">// The string SHA of a commit that referenced this Issue or Pull Request.</span>
|
|
CommitID *<a href="../../../../builtin/index.html#string">string</a> `json:"commit_id,omitempty"`
|
|
<span class="comment">// The timestamp indicating when the event occurred.</span>
|
|
CreatedAt *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"created_at,omitempty"`
|
|
<span class="comment">// The Label object including `name` and `color` attributes. Only provided for</span>
|
|
<span class="comment">// 'labeled' and 'unlabeled' events.</span>
|
|
Label *<a href="index.html#Label">Label</a> `json:"label,omitempty"`
|
|
<span class="comment">// The User object which was assigned to (or unassigned from) this Issue or</span>
|
|
<span class="comment">// Pull Request. Only provided for 'assigned' and 'unassigned' events.</span>
|
|
Assignee *<a href="index.html#User">User</a> `json:"assignee,omitempty"`
|
|
<span class="comment">// The Milestone object including a 'title' attribute.</span>
|
|
<span class="comment">// Only provided for 'milestoned' and 'demilestoned' events.</span>
|
|
Milestone *<a href="index.html#Milestone">Milestone</a> `json:"milestone,omitempty"`
|
|
<span class="comment">// The 'id', 'actor', and 'url' for the source of a reference from another issue.</span>
|
|
<span class="comment">// Only provided for 'cross-referenced' events.</span>
|
|
Source *<a href="index.html#Source">Source</a> `json:"source,omitempty"`
|
|
<span class="comment">// An object containing rename details including 'from' and 'to' attributes.</span>
|
|
<span class="comment">// Only provided for 'renamed' events.</span>
|
|
Rename *<a href="index.html#Rename">Rename</a> `json:"rename,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Timeline represents an event that occurred around an Issue or Pull Request.
|
|
</p>
|
|
<p>
|
|
It is similar to an IssueEvent but may contain more information.
|
|
GitHub API docs: <a href="https://developer.github.com/v3/issues/timeline/">https://developer.github.com/v3/issues/timeline/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Timestamp">type <a href="http://localhost:6060/src/github.com/google/go-github/github/timestamp.go?s=512:548#L7">Timestamp</a></h2>
|
|
<pre>type Timestamp struct {
|
|
<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a>
|
|
}</pre>
|
|
<p>
|
|
Timestamp represents a time that can be unmarshalled from a JSON string
|
|
formatted as either an RFC3339 or Unix timestamp. This is necessary for some
|
|
fields since the GitHub API is inconsistent in how it represents times. All
|
|
exported methods of time.Time can be called on Timestamp.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Timestamp.Equal">func (Timestamp) <a href="http://localhost:6060/src/github.com/google/go-github/github/timestamp.go?s=1035:1077#L29">Equal</a></h3>
|
|
<pre>func (t <a href="index.html#Timestamp">Timestamp</a>) Equal(u <a href="index.html#Timestamp">Timestamp</a>) <a href="../../../../builtin/index.html#bool">bool</a></pre>
|
|
<p>
|
|
Equal reports whether t and u are equal based on time.Equal
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Timestamp.String">func (Timestamp) <a href="http://localhost:6060/src/github.com/google/go-github/github/timestamp.go?s=550:584#L11">String</a></h3>
|
|
<pre>func (t <a href="index.html#Timestamp">Timestamp</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Timestamp.UnmarshalJSON">func (*Timestamp) <a href="http://localhost:6060/src/github.com/google/go-github/github/timestamp.go?s=721:779#L17">UnmarshalJSON</a></h3>
|
|
<pre>func (t *<a href="index.html#Timestamp">Timestamp</a>) UnmarshalJSON(data []<a href="../../../../builtin/index.html#byte">byte</a>) (err <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
UnmarshalJSON implements the json.Unmarshaler interface.
|
|
Time is expected in RFC3339 or Unix format.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Tree">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=234:343#L1">Tree</a></h2>
|
|
<pre>type Tree struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Entries []<a href="index.html#TreeEntry">TreeEntry</a> `json:"tree,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
Tree represents a GitHub tree.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="Tree.String">func (Tree) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=345:374#L6">String</a></h3>
|
|
<pre>func (t <a href="index.html#Tree">Tree</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="TreeEntry">type <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=561:834#L13">TreeEntry</a></h2>
|
|
<pre>type TreeEntry struct {
|
|
SHA *<a href="../../../../builtin/index.html#string">string</a> `json:"sha,omitempty"`
|
|
Path *<a href="../../../../builtin/index.html#string">string</a> `json:"path,omitempty"`
|
|
Mode *<a href="../../../../builtin/index.html#string">string</a> `json:"mode,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
Size *<a href="../../../../builtin/index.html#int">int</a> `json:"size,omitempty"`
|
|
Content *<a href="../../../../builtin/index.html#string">string</a> `json:"content,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
TreeEntry represents the contents of a tree structure. TreeEntry can
|
|
represent either a blob, a commit (in the case of a submodule), or another
|
|
tree.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="TreeEntry.String">func (TreeEntry) <a href="http://localhost:6060/src/github.com/google/go-github/github/git_trees.go?s=836:870#L22">String</a></h3>
|
|
<pre>func (t <a href="index.html#TreeEntry">TreeEntry</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="TwoFactorAuthError">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=15601:15638#L463">TwoFactorAuthError</a></h2>
|
|
<pre>type TwoFactorAuthError <a href="index.html#ErrorResponse">ErrorResponse</a></pre>
|
|
<p>
|
|
TwoFactorAuthError occurs when using HTTP Basic Authentication for a user
|
|
that has two-factor authentication enabled. The request can be reattempted
|
|
by providing a one-time password in the request.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="TwoFactorAuthError.Error">func (*TwoFactorAuthError) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=15640:15683#L465">Error</a></h3>
|
|
<pre>func (r *<a href="index.html#TwoFactorAuthError">TwoFactorAuthError</a>) Error() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UnauthenticatedRateLimitedTransport">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=22820:23330#L686">UnauthenticatedRateLimitedTransport</a></h2>
|
|
<pre>type UnauthenticatedRateLimitedTransport struct {
|
|
<span class="comment">// ClientID is the GitHub OAuth client ID of the current application, which</span>
|
|
<span class="comment">// can be found by selecting its entry in the list at</span>
|
|
<span class="comment">// https://github.com/settings/applications.</span>
|
|
ClientID <a href="../../../../builtin/index.html#string">string</a>
|
|
|
|
<span class="comment">// ClientSecret is the GitHub OAuth client secret of the current</span>
|
|
<span class="comment">// application.</span>
|
|
ClientSecret <a href="../../../../builtin/index.html#string">string</a>
|
|
|
|
<span class="comment">// Transport is the underlying HTTP transport to use when making requests.</span>
|
|
<span class="comment">// It will default to http.DefaultTransport if nil.</span>
|
|
Transport <a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#RoundTripper">RoundTripper</a>
|
|
}</pre>
|
|
<p>
|
|
UnauthenticatedRateLimitedTransport allows you to make unauthenticated calls
|
|
that need to use a higher rate limit associated with your OAuth application.
|
|
</p>
|
|
<pre>t := &github.UnauthenticatedRateLimitedTransport{
|
|
ClientID: "your app's client ID",
|
|
ClientSecret: "your app's client secret",
|
|
}
|
|
client := github.NewClient(t.Client())
|
|
</pre>
|
|
<p>
|
|
This will append the querystring params client_id=xxx&client_secret=yyy to all
|
|
requests.
|
|
</p>
|
|
<p>
|
|
See <a href="http://developer.github.com/v3/#unauthenticated-rate-limited-requests">http://developer.github.com/v3/#unauthenticated-rate-limited-requests</a> for
|
|
more information.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UnauthenticatedRateLimitedTransport.Client">func (*UnauthenticatedRateLimitedTransport) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=24171:24238#L725">Client</a></h3>
|
|
<pre>func (t *<a href="index.html#UnauthenticatedRateLimitedTransport">UnauthenticatedRateLimitedTransport</a>) Client() *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a></pre>
|
|
<p>
|
|
Client returns an *http.Client that makes requests which are subject to the
|
|
rate limit of your OAuth application.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UnauthenticatedRateLimitedTransport.RoundTrip">func (*UnauthenticatedRateLimitedTransport) <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=23384:23482#L702">RoundTrip</a></h3>
|
|
<pre>func (t *<a href="index.html#UnauthenticatedRateLimitedTransport">UnauthenticatedRateLimitedTransport</a>) RoundTrip(req *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Request">Request</a>) (*<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
RoundTrip implements the RoundTripper interface.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UploadOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/github.go?s=5122:5187#L133">UploadOptions</a></h2>
|
|
<pre>type UploadOptions struct {
|
|
Name <a href="../../../../builtin/index.html#string">string</a> `url:"name,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
UploadOptions specifies the parameters to methods that support uploads.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="User">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=412:3065#L7">User</a></h2>
|
|
<pre>type User struct {
|
|
Login *<a href="../../../../builtin/index.html#string">string</a> `json:"login,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#int">int</a> `json:"id,omitempty"`
|
|
AvatarURL *<a href="../../../../builtin/index.html#string">string</a> `json:"avatar_url,omitempty"`
|
|
HTMLURL *<a href="../../../../builtin/index.html#string">string</a> `json:"html_url,omitempty"`
|
|
GravatarID *<a href="../../../../builtin/index.html#string">string</a> `json:"gravatar_id,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Company *<a href="../../../../builtin/index.html#string">string</a> `json:"company,omitempty"`
|
|
Blog *<a href="../../../../builtin/index.html#string">string</a> `json:"blog,omitempty"`
|
|
Location *<a href="../../../../builtin/index.html#string">string</a> `json:"location,omitempty"`
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
Hireable *<a href="../../../../builtin/index.html#bool">bool</a> `json:"hireable,omitempty"`
|
|
Bio *<a href="../../../../builtin/index.html#string">string</a> `json:"bio,omitempty"`
|
|
PublicRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"public_repos,omitempty"`
|
|
PublicGists *<a href="../../../../builtin/index.html#int">int</a> `json:"public_gists,omitempty"`
|
|
Followers *<a href="../../../../builtin/index.html#int">int</a> `json:"followers,omitempty"`
|
|
Following *<a href="../../../../builtin/index.html#int">int</a> `json:"following,omitempty"`
|
|
CreatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"created_at,omitempty"`
|
|
UpdatedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"updated_at,omitempty"`
|
|
SuspendedAt *<a href="index.html#Timestamp">Timestamp</a> `json:"suspended_at,omitempty"`
|
|
Type *<a href="../../../../builtin/index.html#string">string</a> `json:"type,omitempty"`
|
|
SiteAdmin *<a href="../../../../builtin/index.html#bool">bool</a> `json:"site_admin,omitempty"`
|
|
TotalPrivateRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"total_private_repos,omitempty"`
|
|
OwnedPrivateRepos *<a href="../../../../builtin/index.html#int">int</a> `json:"owned_private_repos,omitempty"`
|
|
PrivateGists *<a href="../../../../builtin/index.html#int">int</a> `json:"private_gists,omitempty"`
|
|
DiskUsage *<a href="../../../../builtin/index.html#int">int</a> `json:"disk_usage,omitempty"`
|
|
Collaborators *<a href="../../../../builtin/index.html#int">int</a> `json:"collaborators,omitempty"`
|
|
Plan *<a href="index.html#Plan">Plan</a> `json:"plan,omitempty"`
|
|
|
|
<span class="comment">// API URLs</span>
|
|
URL *<a href="../../../../builtin/index.html#string">string</a> `json:"url,omitempty"`
|
|
EventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"events_url,omitempty"`
|
|
FollowingURL *<a href="../../../../builtin/index.html#string">string</a> `json:"following_url,omitempty"`
|
|
FollowersURL *<a href="../../../../builtin/index.html#string">string</a> `json:"followers_url,omitempty"`
|
|
GistsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"gists_url,omitempty"`
|
|
OrganizationsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"organizations_url,omitempty"`
|
|
ReceivedEventsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"received_events_url,omitempty"`
|
|
ReposURL *<a href="../../../../builtin/index.html#string">string</a> `json:"repos_url,omitempty"`
|
|
StarredURL *<a href="../../../../builtin/index.html#string">string</a> `json:"starred_url,omitempty"`
|
|
SubscriptionsURL *<a href="../../../../builtin/index.html#string">string</a> `json:"subscriptions_url,omitempty"`
|
|
|
|
<span class="comment">// TextMatches is only populated from search results that request text matches</span>
|
|
<span class="comment">// See: search.go and https://developer.github.com/v3/search/#text-match-metadata</span>
|
|
TextMatches []<a href="index.html#TextMatch">TextMatch</a> `json:"text_matches,omitempty"`
|
|
|
|
<span class="comment">// Permissions identifies the permissions that a user has on a given</span>
|
|
<span class="comment">// repository. This is only populated when calling Repositories.ListCollaborators.</span>
|
|
Permissions *map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#bool">bool</a> `json:"permissions,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
User represents a GitHub user.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="User.String">func (User) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=3067:3096#L57">String</a></h3>
|
|
<pre>func (u <a href="index.html#User">User</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UserEmail">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users_emails.go?s=231:390#L1">UserEmail</a></h2>
|
|
<pre>type UserEmail struct {
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
Primary *<a href="../../../../builtin/index.html#bool">bool</a> `json:"primary,omitempty"`
|
|
Verified *<a href="../../../../builtin/index.html#bool">bool</a> `json:"verified,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
UserEmail represents user's email address
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UserListOptions">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=4611:4720#L126">UserListOptions</a></h2>
|
|
<pre>type UserListOptions struct {
|
|
<span class="comment">// ID of the last user seen</span>
|
|
Since <a href="../../../../builtin/index.html#int">int</a> `url:"since,omitempty"`
|
|
|
|
<a href="index.html#ListOptions">ListOptions</a>
|
|
}</pre>
|
|
<p>
|
|
UserListOptions specifies optional parameters to the UsersService.ListAll
|
|
method.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UsersSearchResult">type <a href="http://localhost:6060/src/github.com/google/go-github/github/search.go?s=2298:2415#L62">UsersSearchResult</a></h2>
|
|
<pre>type UsersSearchResult struct {
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total_count,omitempty"`
|
|
Users []<a href="index.html#User">User</a> `json:"items,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
UsersSearchResult represents the result of an issues search.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="UsersService">type <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=351:376#L4">UsersService</a></h2>
|
|
<pre>type UsersService service</pre>
|
|
<p>
|
|
UsersService handles communication with the user related
|
|
methods of the GitHub API.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/">http://developer.github.com/v3/users/</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.AcceptInvitation">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=6214:6290#L184">AcceptInvitation</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) AcceptInvitation(invitationID <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AcceptInvitation accepts the currently-open repository invitation for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation">https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.AddEmails">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_emails.go?s=1125:1207#L32">AddEmails</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) AddEmails(emails []<a href="../../../../builtin/index.html#string">string</a>) ([]*<a href="index.html#UserEmail">UserEmail</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
AddEmails adds email addresses of the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/emails/#add-email-addresses">http://developer.github.com/v3/users/emails/#add-email-addresses</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.CreateGPGKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=2970:3058#L81">CreateGPGKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) CreateGPGKey(armoredPublicKey <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#GPGKey">GPGKey</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateGPGKey creates a GPG key. It requires authenticatation via Basic Auth
|
|
or OAuth with at least write:gpg_key scope.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key">https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.CreateKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=1877:1944#L66">CreateKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) CreateKey(key *<a href="index.html#Key">Key</a>) (*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
CreateKey adds a public key for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/keys/#create-a-public-key">http://developer.github.com/v3/users/keys/#create-a-public-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.DeclineInvitation">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=6823:6900#L201">DeclineInvitation</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) DeclineInvitation(invitationID <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeclineInvitation declines the currently-open repository invitation for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation">https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.DeleteEmails">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_emails.go?s=1610:1681#L51">DeleteEmails</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) DeleteEmails(emails []<a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteEmails deletes email addresses from authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/emails/#delete-email-addresses">http://developer.github.com/v3/users/emails/#delete-email-addresses</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.DeleteGPGKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=3749:3811#L106">DeleteGPGKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) DeleteGPGKey(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteGPGKey deletes a GPG key. It requires authentication via Basic Auth or
|
|
via OAuth with at least admin:gpg_key scope.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key">https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.DeleteKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=2298:2357#L86">DeleteKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) DeleteKey(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DeleteKey deletes a public key.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/keys/#delete-a-public-key">http://developer.github.com/v3/users/keys/#delete-a-public-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.DemoteSiteAdmin">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_administration.go?s=877:947#L17">DemoteSiteAdmin</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) DemoteSiteAdmin(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
DemoteSiteAdmin demotes a user from site administrator of a GitHub Enterprise instance.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user">https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Edit">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=4216:4281#L108">Edit</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Edit(user *<a href="index.html#User">User</a>) (*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Edit the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/#update-the-authenticated-user">http://developer.github.com/v3/users/#update-the-authenticated-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Follow">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go?s=2552:2613#L85">Follow</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Follow(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Follow will cause the authenticated user to follow the specified user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/followers/#follow-a-user">http://developer.github.com/v3/users/followers/#follow-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Get">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=3289:3354#L65">Get</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Get(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Get fetches a user. Passing the empty string will fetch the authenticated
|
|
user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/#get-a-single-user">http://developer.github.com/v3/users/#get-a-single-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.GetByID">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=3773:3837#L89">GetByID</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) GetByID(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetByID fetches a user.
|
|
</p>
|
|
<p>
|
|
Note: GetByID uses the undocumented GitHub API endpoint /user/:id.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.GetGPGKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=2303:2371#L58">GetGPGKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) GetGPGKey(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#GPGKey">GPGKey</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetGPGKey gets extended details for a single GPG key. It requires authentication
|
|
via Basic Auth or via OAuth with at least read:gpg_key scope.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key">https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.GetKey">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=1412:1474#L46">GetKey</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) GetKey(id <a href="../../../../builtin/index.html#int">int</a>) (*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
GetKey fetches a single public key.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/keys/#get-a-single-public-key">http://developer.github.com/v3/users/keys/#get-a-single-public-key</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.IsFollowing">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go?s=1957:2037#L64">IsFollowing</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) IsFollowing(user, target <a href="../../../../builtin/index.html#string">string</a>) (<a href="../../../../builtin/index.html#bool">bool</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
IsFollowing checks if "user" is following "target". Passing the empty
|
|
string for "user" will check if the authenticated user is following "target".
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user">http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListAll">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=4916:4996#L138">ListAll</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListAll(opt *<a href="index.html#UserListOptions">UserListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListAll lists all GitHub users.
|
|
</p>
|
|
<p>
|
|
To paginate through all users, populate 'Since' with the ID of the last user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/#get-all-users">http://developer.github.com/v3/users/#get-all-users</a>
|
|
</p>
|
|
|
|
|
|
<div id="example_UsersService_ListAll" class="toggle">
|
|
<div class="collapsed">
|
|
<p class="exampleHeading toggleButton">▹ <span class="text">Example</span></p>
|
|
</div>
|
|
<div class="expanded">
|
|
<p class="exampleHeading toggleButton">▾ <span class="text">Example</span></p>
|
|
|
|
|
|
|
|
<p>Code:</p>
|
|
<pre class="code">
|
|
client := github.NewClient(nil)
|
|
opts := &github.UserListOptions{}
|
|
for {
|
|
users, _, err := client.Users.ListAll(opts)
|
|
if err != nil {
|
|
log.Fatalf("error listing users: %v", err)
|
|
}
|
|
if len(users) == 0 {
|
|
break
|
|
}
|
|
opts.Since = *users[len(users)-1].ID
|
|
<span class="comment">// Process users...</span>
|
|
}
|
|
</pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListEmails">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_emails.go?s=560:644#L8">ListEmails</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListEmails(opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#UserEmail">UserEmail</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListEmails lists all email addresses for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user">http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListFollowers">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go?s=423:518#L4">ListFollowers</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListFollowers(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListFollowers lists the followers for a user. Passing the empty string will
|
|
fetch followers for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/followers/#list-followers-of-a-user">http://developer.github.com/v3/users/followers/#list-followers-of-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListFollowing">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go?s=1185:1280#L34">ListFollowing</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListFollowing(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#User">User</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListFollowing lists the people that a user is following. Passing the empty
|
|
string will list people the authenticated user is following.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user">http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListGPGKeys">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_gpg_keys.go?s=1634:1700#L36">ListGPGKeys</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListGPGKeys() ([]*<a href="index.html#GPGKey">GPGKey</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListGPGKeys lists the current user's GPG keys. It requires authentication
|
|
via Basic Auth or via OAuth with at least read:gpg_key scope.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys">https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListInvitations">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users.go?s=5514:5598#L162">ListInvitations</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListInvitations() ([]*<a href="index.html#RepositoryInvitation">RepositoryInvitation</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListInvitations lists all currently-open repository invitations for the
|
|
authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations">https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.ListKeys">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_keys.go?s=791:880#L17">ListKeys</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) ListKeys(user <a href="../../../../builtin/index.html#string">string</a>, opt *<a href="index.html#ListOptions">ListOptions</a>) ([]*<a href="index.html#Key">Key</a>, *<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
ListKeys lists the verified public keys for a user. Passing the empty
|
|
string will fetch keys for the authenticated user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user">http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.PromoteSiteAdmin">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_administration.go?s=419:490#L3">PromoteSiteAdmin</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) PromoteSiteAdmin(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
PromoteSiteAdmin promotes a user to a site administrator of a GitHub Enterprise instance.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator">https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Suspend">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_administration.go?s=1264:1326#L31">Suspend</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Suspend(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Suspend a user on a GitHub Enterprise instance.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/administration/#suspend-a-user">https://developer.github.com/v3/users/administration/#suspend-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Unfollow">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_followers.go?s=2946:3009#L98">Unfollow</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Unfollow(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Unfollow will cause the authenticated user to unfollow the specified user.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="http://developer.github.com/v3/users/followers/#unfollow-a-user">http://developer.github.com/v3/users/followers/#unfollow-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="UsersService.Unsuspend">func (*UsersService) <a href="http://localhost:6060/src/github.com/google/go-github/github/users_administration.go?s=1643:1707#L45">Unsuspend</a></h3>
|
|
<pre>func (s *<a href="index.html#UsersService">UsersService</a>) Unsuspend(user <a href="../../../../builtin/index.html#string">string</a>) (*<a href="index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
|
|
<p>
|
|
Unsuspend a user on a GitHub Enterprise instance.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://developer.github.com/v3/users/administration/#unsuspend-a-user">https://developer.github.com/v3/users/administration/#unsuspend-a-user</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WatchEvent">type <a href="http://localhost:6060/src/github.com/google/go-github/github/event_types.go?s=19158:19461#L450">WatchEvent</a></h2>
|
|
<pre>type WatchEvent struct {
|
|
<span class="comment">// Action is the action that was performed. Possible value is: "started".</span>
|
|
Action *<a href="../../../../builtin/index.html#string">string</a> `json:"action,omitempty"`
|
|
|
|
<span class="comment">// The following fields are only populated by Webhook events.</span>
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WatchEvent is related to starring a repository, not watching. See this API
|
|
blog post for an explanation: <a href="https://developer.github.com/changes/2012-09-05-watcher-api/">https://developer.github.com/changes/2012-09-05-watcher-api/</a>
|
|
</p>
|
|
<p>
|
|
The event’s actor is the user who starred a repository, and the event’s
|
|
repository is the repository that was starred.
|
|
</p>
|
|
<p>
|
|
GitHub docs: <a href="https://developer.github.com/v3/activity/events/types/#watchevent">https://developer.github.com/v3/activity/events/types/#watchevent</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WebHookAuthor">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=2219:2379#L49">WebHookAuthor</a></h2>
|
|
<pre>type WebHookAuthor struct {
|
|
Email *<a href="../../../../builtin/index.html#string">string</a> `json:"email,omitempty"`
|
|
Name *<a href="../../../../builtin/index.html#string">string</a> `json:"name,omitempty"`
|
|
Username *<a href="../../../../builtin/index.html#string">string</a> `json:"username,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WebHookAuthor represents the author or committer of a commit, as specified
|
|
in a WebHookCommit. The commit author may not correspond to a GitHub User.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="WebHookAuthor.String">func (WebHookAuthor) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=2381:2419#L55">String</a></h3>
|
|
<pre>func (w <a href="index.html#WebHookAuthor">WebHookAuthor</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WebHookCommit">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=1491:1995#L31">WebHookCommit</a></h2>
|
|
<pre>type WebHookCommit struct {
|
|
Added []<a href="../../../../builtin/index.html#string">string</a> `json:"added,omitempty"`
|
|
Author *<a href="index.html#WebHookAuthor">WebHookAuthor</a> `json:"author,omitempty"`
|
|
Committer *<a href="index.html#WebHookAuthor">WebHookAuthor</a> `json:"committer,omitempty"`
|
|
Distinct *<a href="../../../../builtin/index.html#bool">bool</a> `json:"distinct,omitempty"`
|
|
ID *<a href="../../../../builtin/index.html#string">string</a> `json:"id,omitempty"`
|
|
Message *<a href="../../../../builtin/index.html#string">string</a> `json:"message,omitempty"`
|
|
Modified []<a href="../../../../builtin/index.html#string">string</a> `json:"modified,omitempty"`
|
|
Removed []<a href="../../../../builtin/index.html#string">string</a> `json:"removed,omitempty"`
|
|
Timestamp *<a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Time">Time</a> `json:"timestamp,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WebHookCommit represents the commit variant we receive from GitHub in a
|
|
WebHookPayload.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="WebHookCommit.String">func (WebHookCommit) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=1997:2035#L43">String</a></h3>
|
|
<pre>func (w <a href="index.html#WebHookCommit">WebHookCommit</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WebHookPayload">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=642:1329#L10">WebHookPayload</a></h2>
|
|
<pre>type WebHookPayload struct {
|
|
After *<a href="../../../../builtin/index.html#string">string</a> `json:"after,omitempty"`
|
|
Before *<a href="../../../../builtin/index.html#string">string</a> `json:"before,omitempty"`
|
|
Commits []<a href="index.html#WebHookCommit">WebHookCommit</a> `json:"commits,omitempty"`
|
|
Compare *<a href="../../../../builtin/index.html#string">string</a> `json:"compare,omitempty"`
|
|
Created *<a href="../../../../builtin/index.html#bool">bool</a> `json:"created,omitempty"`
|
|
Deleted *<a href="../../../../builtin/index.html#bool">bool</a> `json:"deleted,omitempty"`
|
|
Forced *<a href="../../../../builtin/index.html#bool">bool</a> `json:"forced,omitempty"`
|
|
HeadCommit *<a href="index.html#WebHookCommit">WebHookCommit</a> `json:"head_commit,omitempty"`
|
|
Pusher *<a href="index.html#User">User</a> `json:"pusher,omitempty"`
|
|
Ref *<a href="../../../../builtin/index.html#string">string</a> `json:"ref,omitempty"`
|
|
Repo *<a href="index.html#Repository">Repository</a> `json:"repository,omitempty"`
|
|
Sender *<a href="index.html#User">User</a> `json:"sender,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WebHookPayload represents the data that is received from GitHub when a push
|
|
event hook is triggered. The format of these payloads pre-date most of the
|
|
GitHub v3 API, so there are lots of minor incompatibilities with the types
|
|
defined in the rest of the API. Therefore, several types are duplicated
|
|
here to account for these differences.
|
|
</p>
|
|
<p>
|
|
GitHub API docs: <a href="https://help.github.com/articles/post-receive-hooks">https://help.github.com/articles/post-receive-hooks</a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="WebHookPayload.String">func (WebHookPayload) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_hooks.go?s=1331:1370#L25">String</a></h3>
|
|
<pre>func (w <a href="index.html#WebHookPayload">WebHookPayload</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WeeklyCommitActivity">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=2108:2271#L56">WeeklyCommitActivity</a></h2>
|
|
<pre>type WeeklyCommitActivity struct {
|
|
Days []<a href="../../../../builtin/index.html#int">int</a> `json:"days,omitempty"`
|
|
Total *<a href="../../../../builtin/index.html#int">int</a> `json:"total,omitempty"`
|
|
Week *<a href="index.html#Timestamp">Timestamp</a> `json:"week,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WeeklyCommitActivity represents the weekly commit activity for a repository.
|
|
The days array is a group of commits per day, starting on Sunday.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="WeeklyCommitActivity.String">func (WeeklyCommitActivity) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=2273:2318#L62">String</a></h3>
|
|
<pre>func (w <a href="index.html#WeeklyCommitActivity">WeeklyCommitActivity</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="WeeklyStats">type <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=681:880#L17">WeeklyStats</a></h2>
|
|
<pre>type WeeklyStats struct {
|
|
Week *<a href="index.html#Timestamp">Timestamp</a> `json:"w,omitempty"`
|
|
Additions *<a href="../../../../builtin/index.html#int">int</a> `json:"a,omitempty"`
|
|
Deletions *<a href="../../../../builtin/index.html#int">int</a> `json:"d,omitempty"`
|
|
Commits *<a href="../../../../builtin/index.html#int">int</a> `json:"c,omitempty"`
|
|
}</pre>
|
|
<p>
|
|
WeeklyStats represents the number of additions, deletions and commits
|
|
a Contributor made in a given week.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="WeeklyStats.String">func (WeeklyStats) <a href="http://localhost:6060/src/github.com/google/go-github/github/repos_stats.go?s=882:918#L24">String</a></h3>
|
|
<pre>func (w <a href="index.html#WeeklyStats">WeeklyStats</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
|
Build version go1.6.<br>
|
|
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
|
|
the content of this page is licensed under the
|
|
Creative Commons Attribution 3.0 License,
|
|
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
|
|
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
|
|
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
|
|
</div>
|
|
|
|
</div><!-- .container -->
|
|
</div><!-- #page -->
|
|
|
|
<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
|
|
<script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script>
|
|
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
|
|
|
|
|
|
<script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
|
|
|
|
</body>
|
|
</html>
|
|
|