class

Github

Description

A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API.

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

mixin

authorization

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

authorization#create

    • authorization#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • scopes (Array): Optional. A list of scopes that this authorization is in.
  • note (String): Optional. A note to remind you what the OAuth token is for.
  • note_url (String): Optional. A URL to remind you what app the OAuth token is for.
instance method

authorization#delete

    • authorization#delete(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

authorization#get

    • authorization#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

authorization#getAll

    • authorization#getAll(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

authorization#update

    • authorization#update(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • scopes (Array): Optional. A list of scopes that this authorization is in.
  • add_scopes (Array): Optional. A list of scopes to add to this authorization.
  • remove_scopes (Array): Optional. A list of scopes to remove from this authorization.
  • note (String): Optional. A note to remind you what the OAuth token is for.
  • note_url (String): Optional. A URL to remind you what app the OAuth token is for.
class

Client

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer mike@c9.io

Client can load any version of the [[github]] client API, with the requirement that a valid routes.json definition file is present in the api/[VERSION] directory and that the routes found in this file are implemented as well.

Upon instantiation of the Client class, the routes.json file is loaded from the API version specified in the configuration and, parsed and from it the routes for HTTP requests are extracted. For each HTTP endpoint to the HTTP server, a method is generated which accepts a Javascript Object with parameters and an optional callback to be invoked when the API request returns from the server or when the parameters could not be validated.

When an HTTP endpoint is processed and a method is generated as described above, Client also sets up parameter validation with the rules as defined in the routes.json. A full example that illustrates how this works is shown below:

Example

First, we look at a listing of a sample routes.json routes definition file:

{
    "defines": {
        "constants": {
            "name": "Github",
            "description": "A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API.",
            "protocol": "https",
            "host": "api.github.com",
            "port": 443,
            "dateFormat": "YYYY-MM-DDTHH:MM:SSZ",
            "requestFormat": "json"
        },
        "response-headers": [
            "X-RateLimit-Limit",
            "X-RateLimit-Remaining",
            "Link"
        ],
        "params": {
            "files": {
                "type": "Json",
                "required": true,
                "validation": "",
                "invalidmsg": "",
                "description": "Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'"
            },
            "user": {
                "type": "String",
                "required": true,
                "validation": "",
                "invalidmsg": "",
                "description": ""
            },
            "description": {
                "type": "String",
                "required": false,
                "validation": "",
                "invalidmsg": "",
                "description": ""
            },
            "page": {
                "type": "Number",
                "required": false,
                "validation": "^[0-9]+$",
                "invalidmsg": "",
                "description": "Page number of the results to fetch."
            },
            "per_page": {
                "type": "Number",
                "required": false,
                "validation": "^[0-9]+$",
                "invalidmsg": "",
                "description": "A custom page size up to 100. Default is 30."
            }
        }
    },

    "gists": {
        "get-from-user": {
            "url": ":user/gists",
            "method": "GET",
            "params": {
                "$user": null,
                "$page": null,
                "$per_page": null
            }
        },

        "create": {
            "url": "/gists",
            "method": "POST",
            "params": {
                "$description": null,
                "public": {
                    "type": "Boolean",
                    "required": true,
                    "validation": "",
                    "invalidmsg": "",
                    "description": ""
                },
                "$files": null
            }
        }
    }
 }

You probably noticed that the definition is quite verbose and the decision for its design was made to be verbose whilst still allowing for basic variable definitions and substitions for request parameters.

There are two sections; 'defines' and 'gists' in this example.

The defines section contains a list of constants that will be used by the Client to make requests to the right URL that hosts the API. The gists section defines the endpoints for calls to the API server, for gists specifically in this example, but the other API sections are defined in the exact same way. These definitions are parsed and methods are created that the client can call to make an HTTP request to the server. there is one endpoint defined: . In this example, the endpoint gists/get-from-user will be exposed as a member on the Client object and may be invoked with

client.getFromUser({
    "user": "bob"
}, function(err, ret) {
    // do something with the result here.
});

// or to fetch a specfic page:
client.getFromUser({
    "user": "bob",
    "page": 2,
    "per_page": 100
}, function(err, ret) {
    // do something with the result here.
});

All the parameters as specified in the Object that is passed to the function as first argument, will be validated according to the rules in the params block of the route definition. Thus, in the case of the user parameter, according to the definition in the params block, it's a variable that first needs to be looked up in the params block of the defines section (at the top of the JSON file). Params that start with a $ sign will be substituted with the param with the same name from the defines/params section. There we see that it is a required parameter (needs to hold a value). In other words, if the validation requirements are not met, an HTTP error is passed as first argument of the callback.

Implementation Notes: the method is NOT case sensitive, whereas url is. The url parameter also supports denoting parameters inside it as follows:

"get-from-user": {
    "url": ":user/gists",
    "method": "GET"
    ...
}
instance method

Client#authenticate

    • Client#authenticate(options)
      • null
    • options
      • Object
    • Object containing the authentication type and credentials

    • type
      • String
    • One of the following: basic or oauth

    • username
      • String
    • Github username

    • password
      • String
    • Password to your account

    • token
      • String
    • OAuth2 token

Set an authentication method to have access to protected resources.

Example
// basic
github.authenticate({
    type: "basic",
    username: "mikedeboertest",
    password: "test1324"
});

// or oauth
github.authenticate({
    type: "oauth",
    token: "e5a4a27487c26e571892846366de023349321a73"
});

// or oauth key/ secret
github.authenticate({
    type: "oauth",
    key: "clientID",
    secret: "clientSecret"
});
instance method

Client#getFirstPage

    • Client#getFirstPage(link, callback)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Get the first page, based on the contents of the Link header

instance method

Client#getLastPage

    • Client#getLastPage(link, callback)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Get the last page, based on the contents of the Link header

instance method

Client#getNextPage

    • Client#getNextPage(link, callback)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Get the next page, based on the contents of the Link header

instance method

Client#getPreviousPage

    • Client#getPreviousPage(link, callback)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Get the previous page, based on the contents of the Link header

instance method

Client#hasFirstPage

    • Client#hasFirstPage(link)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

Check if a request result contains a link to the first page

instance method

Client#hasLastPage

    • Client#hasLastPage(link)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

Check if a request result contains a link to the last page

instance method

Client#hasNextPage

    • Client#hasNextPage(link)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

Check if a request result contains a link to the next page

instance method

Client#hasPreviousPage

    • Client#hasPreviousPage(link)
      • null
    • link
      • mixed
    • response of a request or the contents of the Link header

Check if a request result contains a link to the previous page

instance method

Client#httpSend

    • Client#httpSend(msg, block, callback)
      • null
    • msg
      • Object
    • parameters to send as the request body

    • block
      • Object
    • parameter definition from the routes.json file that contains validation rules

    • callback
      • Function
    • function to be called when the request returns. If the the request returns with an error, the error is passed to the callback as its first argument (NodeJS-style).

Send an HTTP request to the server and pass the result to a callback.

instance method

Client#setupRoutes

    • Client#setupRoutes()
      • null

Configures the routes as defined in a routes.json file of an API version

Client#setupRoutes is invoked by the constructor, takes the contents of the JSON document that contains the definitions of all the available API routes and iterates over them.

It first recurses through each definition block until it reaches an API endpoint. It knows that an endpoint is found when the url and param definitions are found as a direct member of a definition block. Then the availability of an implementation by the API is checked; if it's not present, this means that a portion of the API as defined in the routes.json file is not implemented properly, thus an exception is thrown. After this check, a method is attached to the Client instance and becomes available for use. Inside this method, the parameter validation and typecasting is done, according to the definition of the parameters in the params block, upon invocation.

This mechanism ensures that the handlers ALWAYS receive normalized data that is of the correct format and type. JSON parameters are parsed, Strings are trimmed, Numbers and Floats are casted and checked for NaN after that.

Note: Query escaping for usage with SQL products is something that can be implemented additionally by adding an additional parameter type.

mixin

events

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

events#get

    • events#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromOrg

    • events#getFromOrg(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromRepo

    • events#getFromRepo(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromRepoIssues

    • events#getFromRepoIssues(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromRepoNetwork

    • events#getFromRepoNetwork(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromUser

    • events#getFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromUserOrg

    • events#getFromUserOrg(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • org (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getFromUserPublic

    • events#getFromUserPublic(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getReceived

    • events#getReceived(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

events#getReceivedPublic

    • events#getReceivedPublic(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
mixin

gists

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

gists#checkStar

    • gists#checkStar(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#create

    • gists#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • description (String): Optional.
  • public (Boolean): Required.
  • files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
instance method

gists#createComment

    • gists#createComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • gist_id (String): Required. Id (SHA1 hash) of the gist.
  • body (String): Required.
instance method

gists#delete

    • gists#delete(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#deleteComment

    • gists#deleteComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • gist_id (String): Required. Id (SHA1 hash) of the gist.
  • id (String): Required.
instance method

gists#deleteStar

    • gists#deleteStar(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#edit

    • gists#edit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • description (String): Optional.
  • files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
instance method

gists#editComment

    • gists#editComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • gist_id (String): Required. Id (SHA1 hash) of the gist.
  • id (String): Required.
  • body (String): Required.
instance method

gists#fork

    • gists#fork(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#get

    • gists#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#getAll

    • gists#getAll(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
instance method

gists#getComment

    • gists#getComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • gist_id (String): Required. Id (SHA1 hash) of the gist.
  • id (String): Required.
instance method

gists#getComments

    • gists#getComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • gist_id (String): Required. Id (SHA1 hash) of the gist.
instance method

gists#getFromUser

    • gists#getFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
instance method

gists#public

    • gists#public(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
instance method

gists#star

    • gists#star(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

gists#starred

    • gists#starred(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
mixin

gitdata

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

gitdata#createBlob

    • gitdata#createBlob(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • content (String): Required.
  • encoding (String): Required.
instance method

gitdata#createCommit

    • gitdata#createCommit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • message (String): Required. String of the commit message
  • tree (String): Required. String of the SHA of the tree object this commit points to
  • parents (Array): Required. Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
  • author (Json): Optional.
  • committer (Json): Optional.
instance method

gitdata#createReference

    • gitdata#createReference(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
  • sha (String): Required.
instance method

gitdata#createTag

    • gitdata#createTag(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • tag (String): Required. String of the tag
  • message (String): Required. String of the tag message
  • object (String): Required. String of the SHA of the git object this is tagging
  • type (String): Required. String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
  • tagger (Json): Required. JSON object that contains the following keys: name - String of the name of the author of the tag, email - String of the email of the author of the tag, date - Timestamp of when this object was tagged
instance method

gitdata#createTree

    • gitdata#createTree(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • tree (Json): Required. Array of Hash objects (of path, mode, type and sha) specifying a tree structure
  • base_tree (String): Optional. String of the SHA1 of the tree you want to update with new data
instance method

gitdata#deleteReference

    • gitdata#deleteReference(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
instance method

gitdata#getAllReferences

    • gitdata#getAllReferences(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

gitdata#getBlob

    • gitdata#getBlob(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

gitdata#getCommit

    • gitdata#getCommit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
instance method

gitdata#getReference

    • gitdata#getReference(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
instance method

gitdata#getTag

    • gitdata#getTag(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
instance method

gitdata#getTree

    • gitdata#getTree(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
  • recursive (Boolean): Optional.
instance method

gitdata#updateReference

    • gitdata#updateReference(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
  • sha (String): Required.
  • force (Boolean): Optional. Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.
mixin

gitignore

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

Instance methods

instance method

gitignore#template

    • gitignore#template(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • name (String): Required. The name of the .gitignore template to get
instance method

gitignore#templates

    • gitignore#templates(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
class

HttpError

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer mike@c9.io

Instance methods

instance method

HttpError#toJSON

    • HttpError#toJSON()
      • Object

Returns a JSON object representation of the error.

instance method

HttpError#toString

    • HttpError#toString()
      • String

Returns the stringified version of the error (i.e. the message).

mixin

issues

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

issues#create

    • issues#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • title (String): Required.
  • body (String): Optional.
  • assignee (String): Optional. Login for the user that this issue should be assigned to.
  • milestone (Number): Optional. Milestone to associate this issue with. Validation rule: ^[0-9]+$.
  • labels (Json): Required. Array of strings - Labels to associate with this issue.
instance method

issues#createComment

    • issues#createComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • body (String): Required.
instance method

issues#createLabel

    • issues#createLabel(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
  • color (String): Required. 6 character hex code, without a leading #.
instance method

issues#createMilestone

    • issues#createMilestone(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • title (String): Required.
  • state (String): Optional. Validation rule: ^(open|closed)$.
  • description (String): Optional.
  • due_on (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
instance method

issues#deleteComment

    • issues#deleteComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

issues#deleteLabel

    • issues#deleteLabel(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
instance method

issues#deleteMilestone

    • issues#deleteMilestone(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

issues#edit

    • issues#edit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • title (String): Optional.
  • body (String): Optional.
  • assignee (String): Optional. Login for the user that this issue should be assigned to.
  • milestone (Number): Optional. Milestone to associate this issue with. Validation rule: ^[0-9]+$.
  • labels (Json): Optional. Array of strings - Labels to associate with this issue.
  • state (String): Optional. open or closed Validation rule: ^(open|closed)$.
instance method

issues#editComment

    • issues#editComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
  • body (String): Required.
instance method

issues#getAll

    • issues#getAll(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • filter (String): Optional. Validation rule: ^(all|assigned|created|mentioned|subscribed)$.
  • state (String): Optional. open, closed, or all Validation rule: ^(open|closed|all)$.
  • labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high
  • sort (String): Optional. Validation rule: ^(created|updated|comments)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getAllMilestones

    • issues#getAllMilestones(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • state (String): Optional. Validation rule: ^(open|closed)$.
  • sort (String): Optional. due_date, completeness, default: due_date Validation rule: ^(due_date|completeness)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getComment

    • issues#getComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

issues#getComments

    • issues#getComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getEvent

    • issues#getEvent(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

issues#getEvents

    • issues#getEvents(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getLabel

    • issues#getLabel(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
instance method

issues#getLabels

    • issues#getLabels(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getMilestone

    • issues#getMilestone(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

issues#getRepoEvents

    • issues#getRepoEvents(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#getRepoIssue

    • issues#getRepoIssue(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

issues#repoComments

    • issues#repoComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sort (String): Optional. Validation rule: ^(created|updated)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#repoIssues

    • issues#repoIssues(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • milestone (String): Optional. Validation rule: ^([0-9]+|none|\*)$.
  • state (String): Optional. open, closed, or all Validation rule: ^(open|closed|all)$.
  • assignee (String): Optional. String User login, none for Issues with no assigned User. * for Issues with any assigned User.
  • mentioned (String): Optional. String User login.
  • labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high
  • sort (String): Optional. Validation rule: ^(created|updated|comments)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

issues#updateLabel

    • issues#updateLabel(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
  • color (String): Required. 6 character hex code, without a leading #.
instance method

issues#updateMilestone

    • issues#updateMilestone(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • title (String): Required.
  • state (String): Optional. Validation rule: ^(open|closed)$.
  • description (String): Optional.
  • due_on (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
mixin

markdown

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

Instance methods

instance method

markdown#render

    • markdown#render(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • text (String): Required. The Markdown text to render
  • mode (String): Optional. The rendering mode, markdown to render a document as plain Markdown, just like README files are rendered. gfm to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly. Validation rule: ^(markdown|gfm)$.
  • context (String): Optional. The repository context, only taken into account when rendering as gfm
mixin

misc

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

Instance methods

instance method

misc#emojis

    • misc#emojis(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
instance method

misc#meta

    • misc#meta(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
instance method

misc#rateLimit

    • misc#rateLimit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
mixin

orgs

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

orgs#addTeamMember

    • orgs#addTeamMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
instance method

orgs#addTeamRepo

    • orgs#addTeamRepo(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
  • repo (String): Required.
instance method

orgs#concealMembership

    • orgs#concealMembership(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • user (String): Required.
instance method

orgs#createTeam

    • orgs#createTeam(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • name (String): Required.
  • repo_names (Array): Optional. Array of strings
  • permission (String): Optional. pull - team members can pull, but not push or administer this repositories (Default), push - team members can pull and push, but not administer this repositores, admin - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$.
instance method

orgs#deleteTeam

    • orgs#deleteTeam(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

orgs#deleteTeamMember

    • orgs#deleteTeamMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
instance method

orgs#deleteTeamRepo

    • orgs#deleteTeamRepo(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
  • repo (String): Required.
instance method

orgs#get

    • orgs#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#getFromUser

    • orgs#getFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#getMember

    • orgs#getMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • user (String): Required.
instance method

orgs#getMembers

    • orgs#getMembers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#getPublicMember

    • orgs#getPublicMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • user (String): Required.
instance method

orgs#getPublicMembers

    • orgs#getPublicMembers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
instance method

orgs#getTeam

    • orgs#getTeam(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

orgs#getTeamMember

    • orgs#getTeamMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
instance method

orgs#getTeamMembers

    • orgs#getTeamMembers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#getTeamRepo

    • orgs#getTeamRepo(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • user (String): Required.
  • repo (String): Required.
instance method

orgs#getTeamRepos

    • orgs#getTeamRepos(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#getTeams

    • orgs#getTeams(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

orgs#publicizeMembership

    • orgs#publicizeMembership(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • user (String): Required.
instance method

orgs#removeMember

    • orgs#removeMember(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • user (String): Required.
instance method

orgs#update

    • orgs#update(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • billing_email (String): Optional. Billing email address. This address is not publicized.
  • company (String): Optional.
  • email (String): Optional. Publicly visible email address.
  • location (String): Optional.
  • name (String): Optional.
instance method

orgs#updateTeam

    • orgs#updateTeam(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • name (String): Required.
  • permission (String): Optional. pull - team members can pull, but not push or administer this repositories (Default), push - team members can pull and push, but not administer this repositores, admin - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$.
mixin

pullRequests

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

pullRequests#create

    • pullRequests#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • title (String): Required.
  • body (String): Optional.
  • base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
  • head (String): Required. The branch (or git ref) where your changes are implemented.
instance method

pullRequests#createComment

    • pullRequests#createComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • body (String): Required.
  • commit_id (String): Required. Sha of the commit to comment on.
  • path (String): Required. Relative path of the file to comment on.
  • position (Number): Required. Column index in the diff to comment on.
instance method

pullRequests#createCommentReply

    • pullRequests#createCommentReply(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • body (String): Required.
  • in_reply_to (Number): Required.
instance method

pullRequests#createFromIssue

    • pullRequests#createFromIssue(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • issue (Number): Required. Validation rule: ^[0-9]+$.
  • base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
  • head (String): Required. The branch (or git ref) where your changes are implemented.
instance method

pullRequests#deleteComment

    • pullRequests#deleteComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

pullRequests#get

    • pullRequests#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

pullRequests#getAll

    • pullRequests#getAll(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • state (String): Optional. open, closed, or all Validation rule: ^(open|closed|all)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
  • sort (String): Optional. Possible values are: created, updated, popularity, long-running, Default: created Validation rule: ^(created|updated|popularity|long-running)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
instance method

pullRequests#getComment

    • pullRequests#getComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
instance method

pullRequests#getComments

    • pullRequests#getComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

pullRequests#getCommits

    • pullRequests#getCommits(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

pullRequests#getFiles

    • pullRequests#getFiles(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

pullRequests#getMerged

    • pullRequests#getMerged(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

pullRequests#merge

    • pullRequests#merge(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • commit_message (String): Optional. The message that will be used for the merge commit
instance method

pullRequests#update

    • pullRequests#update(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • state (String): Optional. Validation rule: ^(open|closed)$.
  • title (String): Required.
  • body (String): Optional.
instance method

pullRequests#updateComment

    • pullRequests#updateComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • number (Number): Required. Validation rule: ^[0-9]+$.
  • body (String): Required.
mixin

releases

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

releases#createRelease

    • releases#createRelease(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • repo (String): Required.
  • tag_name (String): Required. String of the tag
  • target_commitish (String): Optional. Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
  • name (String): Optional.
  • body (String): Optional.
  • draft (Boolean): Optional. true to create a draft (unpublished) release, false to create a published one. Default: false
  • prerelease (Boolean): Optional. true to identify the release as a prerelease. false to identify the release as a full release. Default: false
instance method

releases#deleteAsset

    • releases#deleteAsset(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
instance method

releases#deleteRelease

    • releases#deleteRelease(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
instance method

releases#editAsset

    • releases#editAsset(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
  • name (String): Required.
  • label (String): Optional. An alternate short description of the asset. Used in place of the filename.
instance method

releases#editRelease

    • releases#editRelease(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
  • tag_name (String): Required. String of the tag
  • target_commitish (String): Optional. Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository�s default branch (usually master).
  • name (String): Optional.
  • body (String): Optional.
  • draft (Boolean): Optional. true to create a draft (unpublished) release, false to create a published one. Default: false
  • prerelease (Boolean): Optional. true to identify the release as a prerelease. false to identify the release as a full release. Default: false
instance method

releases#getAsset

    • releases#getAsset(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
instance method

releases#getRelease

    • releases#getRelease(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
instance method

releases#listAssets

    • releases#listAssets(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • id (Number): Required.
  • repo (String): Required.
instance method

releases#listReleases

    • releases#listReleases(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • owner (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
mixin

repos

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

repos#addCollaborator

    • repos#addCollaborator(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • collabuser (String): Required.
instance method

repos#compareCommits

    • repos#compareCommits(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
  • head (String): Required. The branch (or git ref) where your changes are implemented.
instance method

repos#create

    • repos#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • name (String): Required.
  • description (String): Optional.
  • homepage (String): Optional.
  • private (Boolean): Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
  • has_issues (Boolean): Optional. True to enable issues for this repository, false to disable them. Default is true.
  • has_wiki (Boolean): Optional. True to enable the wiki for this repository, false to disable it. Default is true.
  • has_downloads (Boolean): Optional. True to enable downloads for this repository, false to disable them. Default is true.
  • auto_init (Boolean): Optional. True to create an initial commit with empty README. Default is false
  • gitignore_template (String): Optional. Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.
instance method

repos#createCommitComment

    • repos#createCommitComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
  • body (String): Required.
  • commit_id (String): Required. Sha of the commit to comment on.
  • path (String): Optional. Relative path of the file to comment on.
  • position (Number): Optional. Line index in the diff to comment on.
  • line (Number): Optional. Line number in the file to comment on. Defaults to 1.
instance method

repos#createContent

    • repos#createContent(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • content (String): Optional.
  • message (String): Optional.
  • path (String): Optional. The content path.
  • ref (String): Optional. The String name of the Commit/Branch/Tag. Defaults to master.
instance method

repos#createFile

    • repos#createFile(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • path (String): Required. The content path.
  • message (String): Required. The commit message.
  • content (String): Required. The new file content, Base64 encoded.
  • branch (String): Optional. The branch name. If not provided, uses the repository’s default branch (usually master).
  • author (Json): Optional.
  • committer (Json): Optional.
instance method

repos#createFromOrg

    • repos#createFromOrg(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • name (String): Required.
  • description (String): Optional.
  • homepage (String): Optional.
  • private (Boolean): Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
  • has_issues (Boolean): Optional. True to enable issues for this repository, false to disable them. Default is true.
  • has_wiki (Boolean): Optional. True to enable the wiki for this repository, false to disable it. Default is true.
  • has_downloads (Boolean): Optional. True to enable downloads for this repository, false to disable them. Default is true.
  • auto_init (Boolean): Optional. True to create an initial commit with empty README. Default is false
  • gitignore_template (String): Optional. Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.
  • team_id (Number): Optional. The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization. Validation rule: ^[0-9]+$.
instance method

repos#createHook

    • repos#createHook(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
  • config (Json): Required. A Hash containing key/value pairs to provide settings for this hook. These settings vary between the services and are defined in the github-services repo. Booleans are stored internally as 1 for true, and 0 for false. Any JSON true/false values will be converted automatically.
  • events (Array): Optional. Determines what events the hook is triggered for. Default: ['push'].
  • active (Boolean): Optional. Determines whether the hook is actually triggered on pushes.
instance method

repos#createKey

    • repos#createKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • title (String): Required.
  • key (String): Required.
instance method

repos#delete

    • repos#delete(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

repos#deleteCommitComment

    • repos#deleteCommitComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#deleteDownload

    • repos#deleteDownload(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#deleteFile

    • repos#deleteFile(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • path (String): Required. The content path.
  • message (String): Required. The commit message.
  • sha (String): Required. The blob SHA of the file being removed.
  • branch (String): Optional. The branch name. If not provided, uses the repository’s default branch (usually master).
  • author (Json): Optional.
  • committer (Json): Optional.
instance method

repos#deleteHook

    • repos#deleteHook(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#deleteKey

    • repos#deleteKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#fork

    • repos#fork(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • organization (String): Optional. Organization login. The repository will be forked into this organization.
instance method

repos#get

    • repos#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

repos#getAll

    • repos#getAll(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • type (String): Optional. Possible values: all, owner, public, private, member. Default: all. Validation rule: ^(all|owner|public|private|member)$.
  • sort (String): Optional. Possible values: created, updated, pushed, full_name. Default: full_name. Validation rule: ^(created|updated|pushed|full_name)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getAllCommitComments

    • repos#getAllCommitComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getBranch

    • repos#getBranch(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • branch (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getBranches

    • repos#getBranches(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getCollaborator

    • repos#getCollaborator(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • collabuser (String): Required.
instance method

repos#getCollaborators

    • repos#getCollaborators(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getCommit

    • repos#getCommit(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
instance method

repos#getCommitComment

    • repos#getCommitComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#getCommitComments

    • repos#getCommitComments(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getCommits

    • repos#getCommits(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Optional. Sha or branch to start listing commits from.
  • path (String): Optional. Only commits containing this file path will be returned.
  • author (String): Optional. GitHub login or email address by which to filter by commit author.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
  • since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • until (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
instance method

repos#getContent

    • repos#getContent(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • path (String): Optional. The content path.
  • ref (String): Optional. The String name of the Commit/Branch/Tag. Defaults to master.
instance method

repos#getContributors

    • repos#getContributors(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • anon (Boolean): Optional. Set to 1 or true to include anonymous contributors in results.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getDownload

    • repos#getDownload(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#getDownloads

    • repos#getDownloads(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getForks

    • repos#getForks(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sort (String): Optional. Possible values: newest, oldest, watchers, default: newest. Validation rule: ^(newest|oldest|watchers)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getFromOrg

    • repos#getFromOrg(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • org (String): Required.
  • type (String): Optional. Possible values: all, public, member. Default: all. Validation rule: ^(all|public|member)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getFromUser

    • repos#getFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • type (String): Optional. Possible values: all, owner, member. Default: public. Validation rule: ^(all|owner|member)$.
  • sort (String): Optional. Possible values: created, updated, pushed, full_name. Default: full_name. Validation rule: ^(created|updated|pushed|full_name)$.
  • direction (String): Optional. Validation rule: ^(asc|desc)$.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getHook

    • repos#getHook(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#getHooks

    • repos#getHooks(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getKey

    • repos#getKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#getKeys

    • repos#getKeys(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getLanguages

    • repos#getLanguages(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getReadme

    • repos#getReadme(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • ref (String): Optional. The String name of the Commit/Branch/Tag. Defaults to master.
instance method

repos#getStargazers

    • repos#getStargazers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getStarred

    • repos#getStarred(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getStarredFromUser

    • repos#getStarredFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getStarring

    • repos#getStarring(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getTags

    • repos#getTags(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getTeams

    • repos#getTeams(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getWatched

    • repos#getWatched(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getWatchedFromUser

    • repos#getWatchedFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getWatchers

    • repos#getWatchers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#getWatching

    • repos#getWatching(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

repos#merge

    • repos#merge(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
  • head (String): Required. The branch (or git ref) where your changes are implemented.
  • commit_message (String): Optional. Commit message to use for the merge commit. If omitted, a default message will be used.
instance method

repos#removeCollaborator

    • repos#removeCollaborator(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • collabuser (String): Required.
instance method

repos#star

    • repos#star(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

repos#testHook

    • repos#testHook(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
instance method

repos#unStar

    • repos#unStar(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

repos#unWatch

    • repos#unWatch(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

repos#update

    • repos#update(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • name (String): Required.
  • description (String): Optional.
  • homepage (String): Optional.
  • private (Boolean): Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
  • has_issues (Boolean): Optional. True to enable issues for this repository, false to disable them. Default is true.
  • has_wiki (Boolean): Optional. True to enable the wiki for this repository, false to disable it. Default is true.
  • has_downloads (Boolean): Optional. True to enable downloads for this repository, false to disable them. Default is true.
  • default_branch (String): Optional. Updates the default branch for this repository.
instance method

repos#updateCommitComment

    • repos#updateCommitComment(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
  • body (String): Required.
instance method

repos#updateFile

    • repos#updateFile(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • path (String): Required. The content path.
  • message (String): Required. The commit message.
  • content (String): Required. The updated file content, Base64 encoded.
  • sha (String): Required. The blob SHA of the file being replaced.
  • branch (String): Optional. The branch name. If not provided, uses the repository’s default branch (usually master).
  • author (Json): Optional.
  • committer (Json): Optional.
instance method

repos#updateHook

    • repos#updateHook(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
  • name (String): Required.
  • config (Json): Required. A Hash containing key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the github-services repo. Booleans are stored internally as 1 for true, and 0 for false. Any JSON true/false values will be converted automatically.
  • events (Array): Optional. Determines what events the hook is triggered for. This replaces the entire array of events. Default: ['push'].
  • add_events (Array): Optional. Determines a list of events to be added to the list of events that the Hook triggers for.
  • remove_events (Array): Optional. Determines a list of events to be removed from the list of events that the Hook triggers for.
  • active (Boolean): Optional. Determines whether the hook is actually triggered on pushes.
instance method

repos#updateKey

    • repos#updateKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • id (String): Required.
  • title (String): Required.
  • key (String): Required.
instance method

repos#watch

    • repos#watch(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
instance method

search#email

    • search#email(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • email (String): Required. Email address
instance method

search#issues

    • search#issues(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • q (String): Required. Search Term
  • sort (String): Optional. comments, created, or updated Validation rule: ^(comments|created|updated)$.
  • order (String): Optional. asc or desc Validation rule: ^(asc|desc)$.
instance method

search#repos

    • search#repos(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • q (String): Required. Search Term
  • sort (String): Optional. stars, forks, or updated Validation rule: ^(stars|forks|updated)$.
  • order (String): Optional. asc or desc Validation rule: ^(asc|desc)$.
instance method

search#users

    • search#users(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • q (String): Required. Search Term
  • sort (String): Optional. followers, repositories, or joined Validation rule: ^(followers|repositories|joined)$.
  • order (String): Optional. asc or desc Validation rule: ^(asc|desc)$.
mixin

statuses

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

Instance methods

instance method

statuses#create

    • statuses#create(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
  • state (String): Required. State of the status - can be one of pending, success, error, or failure. Validation rule: ^(pending|success|error|failure)$.
  • target_url (String): Optional. Target url to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the ‘source’ of the Status.
  • description (String): Optional. Short description of the status.
instance method

statuses#get

    • statuses#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • repo (String): Required.
  • sha (String): Required.
mixin

user

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer info@mikedeboer.nl

instance method

user#addEmails

    • user#addEmails(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
instance method

user#createKey

    • user#createKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • title (String): Required.
  • key (String): Required.
instance method

user#deleteEmails

    • user#deleteEmails(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
instance method

user#deleteKey

    • user#deleteKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

user#followUser

    • user#followUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
instance method

user#get

    • user#get(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'. No other params, simply pass an empty Object literal {}
instance method

user#getEmails

    • user#getEmails(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getFollowers

    • user#getFollowers(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getFollowing

    • user#getFollowing(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getFollowingFromUser

    • user#getFollowingFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getFollowUser

    • user#getFollowUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getFrom

    • user#getFrom(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
instance method

user#getKey

    • user#getKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
instance method

user#getKeys

    • user#getKeys(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getKeysFromUser

    • user#getKeysFromUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getOrgs

    • user#getOrgs(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#getTeams

    • user#getTeams(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
  • per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
instance method

user#unFollowUser

    • user#unFollowUser(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • user (String): Required.
instance method

user#update

    • user#update(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • name (String): Optional.
  • email (String): Optional.
  • blog (String): Optional.
  • company (String): Optional.
  • location (String): Optional.
  • hireable (Boolean): Optional.
  • bio (String): Optional.
instance method

user#updateKey

    • user#updateKey(msg, callback)
      • null
    • msg
      • Object
    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function
    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
  • id (String): Required.
  • title (String): Required.
  • key (String): Required.
class

Util

Description

Copyright 2012 Cloud9 IDE, Inc.

This product includes software developed by Cloud9 IDE, Inc (http://c9.io).

Author: Mike de Boer mike@c9.io

instance method

Util#escapeRegExp

    • Util#escapeRegExp(str)
      • String
    • str
      • String
    • string to escape

Escapes characters inside a string that will an error when it is used as part of a regex upon instantiation like in new RegExp("[0-9" + str + "]")

instance method

Util#extend

    • Util#extend(dest, src, noOverwrite)
      • Object
    • dest
      • Object
    • destination object

    • src
      • Object
    • source object

    • noOverwrite
      • Boolean
    • set to true to overwrite values in src

Shallow copy of properties from the src object to the dest object. If the noOverwrite argument is set to to true, the value of a property in src will not be overwritten if it already exists.

instance method

Util#isFalse

    • Util#isFalse(c)
      • Boolean
    • c
      • mixed
    • value the variable to check. Possible values: false The function returns true. 'false' The function returns true. 'off' The function returns true. 0 The function returns true. '0' The function returns true.

Determines whether a string is false in the html attribute sense.

instance method

Util#isTrue

    • Util#isTrue(c)
      • Boolean
    • c
      • mixed
    • value the variable to check. Possible values: true The function returns true. 'true' The function returns true. 'on' The function returns true. 1 The function returns true. '1' The function returns true.

Determines whether a string is true in the html attribute sense.

instance method

Util#log

    • Util#log(arg1[, arg2][, type])
      • null
    • arg1
      • mixed
    • messages to be printed to the standard output

    • type
      • String
    • type denotation of the message. Possible values: 'info', 'error', 'fatal', 'exit'. Optional, defaults to 'info'.

Unified logging to the console; arguments passed to this function will put logged to the standard output of the current process and properly formatted. Any non-String object will be inspected by the NodeJS util#inspect utility function. Messages will be prefixed with its type (with corresponding font color), like so:

 [info] informational message
 [error] error message
 [fatal] fatal error message
 [exit] program exit message (not an error)

The type of message can be defined by passing it to this function as the last/ final argument. If the type can not be found, this last/ final argument will be regarded as yet another message.

instance method

Util#toCamelCase

    • Util#toCamelCase(str[, upper])
      • String
    • str
      • String
    • string to transform

    • upper
      • Boolean
    • set to true to transform to CamelCase

Transform a string that contains spaces or dashes to camelCase. If upper is set to true, the string will be transformed to CamelCase.

Example:

Util.toCamelCase("why U no-work"); // returns 'whyUNoWork'
Util.toCamelCase("I U no-work", true); // returns 'WhyUNoWork'