org.mule.modules

mule-module-github

config

Namespace	http://www.mulesoft.org/schema/mule/github
Schema Location	http://www.mulesoft.org/schema/mule/github/current/mule-github.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.2

Module Overview

Generic module

Summary

Configuration
<github:config> Configure an instance of this module

Message Processors
<github:add-collaborator> Adds a collaborator to the given repository
<github:add-comment> Creates a commit comment
<github:add-emails> Add one or more e-mail addresses to the currently authenticated user's account
<github:add-team-member> Add given user to team with given id
<github:add-team-repository> Add repository to team
<github:close-issue> Closes a GitHub issue
<github:create-comment> Create comment on specified issue id
<github:create-deploy-key> Returns a new deploy key
<github:create-gist-comment> Creates a comment on the specified gist id
<github:create-issue> Creates a GitHub issue
<github:create-key> Create key for currently authenticated user
<github:create-label> Creates a new label
<github:create-milestone> Creates a new milestone
<github:create-repository> Create a new repository
<github:create-repository-for-org> Create a new repository for the given organization
<github:create-resource> Creates a new download resource
<github:create-team> Create the given team
<github:delete-comment> Delete the issue comment with the given id
<github:delete-commit-comment> Deletes the given comment
<github:delete-deploy-key> Deletes a deploy key given the given id
<github:delete-download> Deletes a download given the provided id
<github:delete-gist> Deletes the given gist
<github:delete-gist-comment> Deletes the given comment
<github:delete-key> Delete key with given id
<github:delete-label> Deletes the given label
<github:delete-milestone> Deletes a given milestone
<github:delete-team> Delete the team with the given id
<github:edit-comment> Edits the body of the comment represented by the given comment id
<github:edit-commit-comment> Edits a given comment
<github:edit-deploy-key> Edits a given deploy key
<github:edit-gist-comment> Updates the given comment
<github:edit-key> Edit key for currently authenticated user
<github:edit-repository> Edit given repository.
<github:edit-team> Edit the given team.
<github:follow> Make the currently authenticated user follow the given user
<github:fork-gist> Forks the given gist
<github:fork-repository> Fork given repository into new repository under the currently authenticated user.
<github:fork-repository-for-org> Fork given repository into new repository.
<github:get-branches> Get branches in given repository
<github:get-collaborators> Returns the list of collaborators of the given repository
<github:get-comment> Returns a comment from commit with the given id
<github:get-comments> Get an issue's comments
<github:get-commit> Returns a commit with given SHA-1 from given repository
<github:get-commits> Returns a list of the commits for a given repository
<github:get-commits-by-sha> Returns all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.
<github:get-commmit-comments> Returns all comments on commit with given Sha
<github:get-contributors> Get contributors to repository
<github:get-current-user> Get the currently authenticated user
<github:get-deploy-key> Returns the key that corresponds to the given id
<github:get-deploy-keys> Returns all deploys keys associated with the given repository
<github:get-download> Returns a single download given the provided id
<github:get-emails> Get all e-mail addresses for the currently authenticated user
<github:get-followers> Returns a list of followers for given user, if no one is provided the current authenticated user will be used
<github:get-following> Returns a list users following the given user, if no one is provided the current authenticated user will be used
<github:get-forks> Get all the forks of the given repository
<github:get-gist> Returns the gist according to the given id
<github:get-gist-comment> Returns the comment according to the given id
<github:get-gist-comments> Returns a list of comments for the given gist
<github:get-gists> Returns a list of gists for the specified user
<github:get-issue> Get the issue represented by the given issueId
<github:get-issue-event> Get issue event for repository
<github:get-issues> Get a list of Issue objects that match the specified filter data
<github:get-issues-creted-after> Custom processor
<github:get-issues-since-number> Custom processor
<github:get-key> Get key with given id
<github:get-keys> Get all public keys for currently authenticated user
<github:get-label> Returns a single label
<github:get-labels> Returns a list of labels for the given repository and user
<github:get-languages> Get languages used in given repository
<github:get-milestone> Returns a single milestone
<github:get-milestones> Returns a list of milestones for the given repository
<github:get-org-repositories> Get organization repositories for the given organization
<github:get-repositories> Get repositories for the currently authenticated user
<github:get-repositories-for-user> Get repositories for the given user
<github:get-repository> Get repository
<github:get-starred-gist> Returns the starred gists for the currently authenticated user
<github:get-tags> Get tags in given repository
<github:get-team> Get team with given id
<github:get-team-members> Get members of team with given id
<github:get-team-repositories> Get all repositories for given team
<github:get-teams-for-org> Get all teams in the given organization
<github:get-user-by-login-name> Get user with given login name
<github:get-watched> Get repositories watched by the given user
<github:get-watchers> Get users watching given repository
<github:is-collaborator> Returns whether the user is a collaborator of the given repository
<github:is-following> Returns wether the authenticated user is following the given user
<github:is-starred> Returns whether the gist is starred or not
<github:is-team-member> Is the given user a member of the team with the given id
<github:is-watching> Is currently authenticated user watching given repository?
<github:remove-collaborator> Removes a collaborator from the given repository
<github:remove-emails> Removes one or more e-mail addresses to the currently authenticated user's account
<github:remove-team-member> Remove given user from team with given id
<github:remove-team-repository> Remove repository from team
<github:star-gist> Star the gist with the given id
<github:unfollow> Make the currently authenticated user unfollow the given user
<github:unstar-gist> Unstar the gist with the given id
<github:unwatch> Remove currently authenticated user as a watcher of the given repository
<github:update-current-user> Updates the currently authenticated user using the given attributes.
<github:watch> Add currently authenticated user as a watcher of the given repository

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:github="http://www.mulesoft.org/schema/mule/github"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/github
               http://www.mulesoft.org/schema/mule/github/current/mule-github.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	password		The password
xs:string	user		The user name

Message Processors

<github:add-collaborator>

Adds a collaborator to the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
user	Optional. The user that's going to be added as a collaborator to the given repository, leave empty to use this#user	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:add-comment>

Creates a commit comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
body	Body of the commit comment	String	/	UTF-8
commitId	Sha of the commit to comment on	String	/	UTF-8
line	Line number in the file to comment on	int	/
path	Relative path of the file to comment on	String	/	UTF-8
position	Line index in the diff to comment on	int	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:add-emails>

Add one or more e-mail addresses to the currently authenticated user's account

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Default Value	Description	Java Type
<github:emails>		The email addresses to add	List<String>

API Information

Add email address(es)

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:add-team-member>

Add given user to team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The team id	int	/
user	The user name	String	/	UTF-8

API Information

Add a member

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:add-team-repository>

Add repository to team

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The team id	int	/
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

API Information

Add team repo

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:close-issue>

Closes a GitHub issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repository name	String	/	UTF-8
issueId	The issues's id	String	/	UTF-8

Returns

Return Type	Description
Issue	the newly created Issue

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-comment>

Create comment on specified issue id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
issueId	The issue id	String	/	UTF-8
comment	The text of the comment	String	/	UTF-8

Returns

Return Type	Description
Comment	the created Comment

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-deploy-key>

Returns a new deploy key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
title	The title of the key	String	/	UTF-8
key	Ssh key	String	/	UTF-8

Returns

Return Type	Description
Key	a new Key created based on the given parameters

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-gist-comment>

Creates a comment on the specified gist id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
gistId	Id of the gist	String	/	UTF-8
comment	Comment to create in the gist	String	/	UTF-8

Returns

Return Type	Description
Comment	a new Comment for the gist

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-issue>

Creates a GitHub issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repository name	String	/	UTF-8
title	The issues's title	String	/	UTF-8
body	The issuess's body	String	/	UTF-8
assignee	Optional. Optionally specify a asignee for the issue	String	/	UTF-8

Returns

Return Type	Description
Issue	the newly created Issue

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-key>

Create key for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
title	The title of the new key	String	/	UTF-8
key	The new key	String	/	UTF-8

Returns

Return Type	Description
Key	the created Key

API Information

Create a public key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-label>

Creates a new label

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
labelName	The name of the label	String	/	UTF-8
color	The color of the label, a 6 character hex code, without a leading #	String	/	UTF-8

Returns

Return Type	Description
Label	returns a new Label

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-milestone>

Creates a new milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
title	The title of the milestone	String	/	UTF-8
state	Optional. The state of the milestone, open or closed, by default is open	String	/	UTF-8
description	Optional. The description of the milestone	String	/	UTF-8
dueOn	Optional. When the milestone is due	Date	/

Returns

Return Type	Description
Milestone	a new milestone with the given parameters

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-repository>

Create a new repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
repositoryName		The name of the new repository	String	/	UTF-8
description		Optional. A description for the new repository	String	/	UTF-8
isPrivate	false	Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.	boolean	/
hasIssues	true	Optional. True to enable issues for this repository, false to disable them. Default is true.	boolean	/
hasWiki	true	Optional. True to enable the wiki for this repository, false to disable it. Default is true.	boolean	/
hasDownloads	true	Optional. True to enable downloads for this repository, false to disable them. Default is true.	boolean	/

Returns

Return Type	Description
Repository	the created Repository

API Information

Create

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-repository-for-org>

Create a new repository for the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization		The organization for the new repository	String	/	UTF-8
repositoryName		The name of the new repository	String	/	UTF-8
description		Optional. A description for the new repository	String	/	UTF-8
isPrivate	false	Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.	boolean	/
hasIssues	true	Optional. True to enable issues for this repository, false to disable them. Default is true.	boolean	/
hasWiki	true	Optional. True to enable the wiki for this repository, false to disable it. Default is true.	boolean	/
hasDownloads	true	Optional. True to enable downloads for this repository, false to disable them. Default is true.	boolean	/

Returns

Return Type	Description
Repository	the created Repository

API Information

Create

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-resource>

Creates a new download resource

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
resourceName	The name of the resource	String	/	UTF-8
size	Size of file in bytes.	long	/
description	Optional. An optional description	String	/	UTF-8
contentType	Optional. An optional content type	String	/	UTF-8

Returns

Return Type	Description
DownloadResource	a new DownloadResource resource

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:create-team>

Create the given team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization		The organization	String	/	UTF-8
teamName		The team name	String	/	UTF-8
teamPermission	PULL	Optional. The team's `TeamPermission`	TeamPermission	/

Child Elements

Name	Default Value	Description	Java Type
<github:repo-names>		Optional. The associated repository names	List<String>

Returns

Return Type	Description
Team	the created Team

API Information

Create team

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-comment>

Delete the issue comment with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
commentId	The id of the comment to delete	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-commit-comment>

Deletes the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
commentId	Id from the comment	long	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-deploy-key>

Deletes a deploy key given the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
id	The id of the deploy key	int	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-download>

Deletes a download given the provided id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
id	The id of the download	int	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-gist>

Deletes the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-gist-comment>

Deletes the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
commentId		Id of the comment	long	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-key>

Delete key with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The id of the key to delete	int	/

API Information

Delete a public key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-label>

Deletes the given label

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
label	The label id	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-milestone>

Deletes a given milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
number	Number of the milestone	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:delete-team>

Delete the team with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The id of the team to delete.	int	/

API Information

Delete team

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-comment>

Edits the body of the comment represented by the given comment id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
commentId	The comment id	Long	/
body	The new text of the comment	String	/	UTF-8

Returns

Return Type	Description
Comment	the created Comment

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-commit-comment>

Edits a given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
body	Body of the commit comment	String	/	UTF-8
commitId	Sha of the commit to comment on	String	/	UTF-8
line	Line number in the file to comment on	int	/
path	Relative path of the file to comment on	String	/	UTF-8
position	Line index in the diff to comment on	int	/

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-deploy-key>

Edits a given deploy key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
title	The title of the key	String	/	UTF-8
key	Ssh key	String	/	UTF-8

Returns

Return Type	Description
Key	the modified Key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-gist-comment>

Updates the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	Id of the comment	long	/
body	New body of the comment	String	/	UTF-8

Returns

Return Type	Description
Comment	returns the updated Comment

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-key>

Edit key for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyId	The id of the key to edit	int	/
title	Optional. A new title for the key	String	/	UTF-8
key	Optional. A new key	String	/	UTF-8

Returns

Return Type	Description
Key	edited Key

API Information

Update a public key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-repository>

Edit given repository. Only provide values for the attributes you need to change.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
description	Optional. A new description for the repository	String	/	UTF-8
isPrivate	Optional. True to turn it into a private repository, false to make it public. Private repositories require a paid GitHub account.	Boolean	/
hasIssues	Optional. True to enable issues for this repository, false to disable them.	Boolean	/
hasWiki	Optional. True to enable the wiki for this repository, false to disable it.	Boolean	/
hasDownloads	Optional. True to enable downloads for this repository, false to disable them.	Boolean	/

Returns

Return Type	Description
Repository	the edited Repository

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:edit-team>

Edit the given team. Only provide values for the attributes you want to update.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The id of the team to edit	int	/
teamName	Optional. The new name of the team	String	/	UTF-8
teamPermission	Optional. The new `TeamPermission` for the team	TeamPermission	/

Returns

Return Type	Description
Team	the edited Team

API Information

Edit team

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:follow>

Make the currently authenticated user follow the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		The user to follow	String	/	UTF-8

API Information

Follow a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:fork-gist>

Forks the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be forked	String	/	UTF-8

Returns

Return Type	Description
Gist	returns the forked gist

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:fork-repository>

Fork given repository into new repository under the currently authenticated user.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
Repository	forked repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:fork-repository-for-org>

Fork given repository into new repository.

The new repository will be under the given organization if non-null, else it will be under the currently authenticated user.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
organization	The organization where the new repository will be	String	/	UTF-8
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
Repository	forked repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-branches>

Get branches in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<RepositoryBranch>	list of branches

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-collaborators>

Returns the list of collaborators of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<User>	non-null but possibly empty list of User

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-comment>

Returns a comment from commit with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
commentId	Id from the comment	long	/

Returns

Return Type	Description
CommitComment	a CommitComment that corresponds to the given id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-comments>

Get an issue's comments

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
issueId	The id of the issue	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list of Comment

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-commit>

Returns a commit with given SHA-1 from given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
sha	Sha from comment	String	/	UTF-8

Returns

Return Type	Description
RepositoryCommit	a RepositoryCommit for the given Sha and repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-commits>

Returns a list of the commits for a given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<RepositoryCommit>	non-null but possibly empty list of RepositoryCommit

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-commits-by-sha>

Returns all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
sha	Optional. An optional Sha or branch to start listing commits from	String	/	UTF-8
path	Optional. Optional Only commits containing this file path will be returned	String	/	UTF-8

Returns

Return Type	Description
List<RepositoryCommit>	non-null but possibly empty list of RepositoryCommit

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-commmit-comments>

Returns all comments on commit with given Sha

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
sha	Sha or branch to start listing commits comments from	String	/	UTF-8

Returns

Return Type	Description
List<CommitComment>	non-null but possibly empty list of CommitComment

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-contributors>

Get contributors to repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository	String	/	UTF-8
repositoryName		The name of the repository	String	/	UTF-8
includeAnonymous	false	Optional. Whether to include anonymus contributors	boolean	/

Returns

Return Type	Description
List<Contributor>	list of contributors

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-current-user>

Get the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Returns

Return Type	Description
User	a User instance representing the current user

API Information

Get the authenticated user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-deploy-key>

Returns the key that corresponds to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
id	The id of the key	int	/

Returns

Return Type	Description
Key	the Key corresponding to the given id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-deploy-keys>

Returns all deploys keys associated with the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The repositoryName of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<Key>	non-null but possibly empty list of Key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-download>

Returns a single download given the provided id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
id	The id of the download	int	/

Returns

Return Type	Description
Download	the download corresponding to the given id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-emails>

Get all e-mail addresses for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Returns

Return Type	Description
List<String>	list of e-mail address

API Information

List email addresses for a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-followers>

Returns a list of followers for given user, if no one is provided the current authenticated user will be used

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which to get the followers, leave empty to use current user	String	/	UTF-8

Returns

Return Type	Description
List<User>	a collection of User that follow the current user

API Information

List followers of a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-following>

Returns a list users following the given user, if no one is provided the current authenticated user will be used

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which to get who is following, leave empty to use current user	String	/	UTF-8

Returns

Return Type	Description
List<User>	a collection of User the user is following

API Information

List users following another user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-forks>

Get all the forks of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<Repository>	non-null but possibly empty list of repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-gist>

Returns the gist according to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		Id of the wanted gist	String	/	UTF-8

Returns

Return Type	Description
Gist	returns the Gist according to the provided id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-gist-comment>

Returns the comment according to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
commentId		Id of the comment to be retrieved	long	/

Returns

Return Type	Description
Comment	a comment corresponding to the given id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-gist-comments>

Returns a list of comments for the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	a list with the comments of the given gist

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-gists>

Returns a list of gists for the specified user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Optional. User of the gists, leave empty to use this#user	String	/	UTF-8

Returns

Return Type	Description
List<Gist>	a list of gists for the specified user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-issue>

Get the issue represented by the given issueId

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
issueId	The id of the issue	String	/	UTF-8

Returns

Return Type	Description
Issue	a Issue

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-issue-event>

Get issue event for repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repostory name	String	/	UTF-8
eventId	The id of the event	long	/

Returns

Return Type	Description
IssueEvent	a IssueEvent

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-issues>

Get a list of Issue objects that match the specified filter data

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repository name	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<github:filter-data>		Optional. Data to filter issues, if non is specified all issues will be returned	Map<String, String>

Returns

Return Type	Description
List<Issue>	list of Issue

API Information

List issues for a repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-issues-creted-after>

Custom processor

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repository name	String	/	UTF-8
minutes	Minutes	int	/

Returns

Return Type	Description
List<Issue>	a list of Issue

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-issues-since-number>

Custom processor

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The repository name	String	/	UTF-8
fromIssueNumber	From issue number	int	/

Returns

Return Type	Description
List<Issue>	a list of Issue

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-key>

Get key with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The id of the key of obtain	int	/

Returns

Return Type	Description
Key	a Key instance

API Information

Get a single public key

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-keys>

Get all public keys for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Returns

Return Type	Description
List<Key>	non-null list of Key

API Information

List public keys for a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-label>

Returns a single label

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
label	The label id	String	/	UTF-8

Returns

Return Type	Description
Label	the label associated to the given id

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-labels>

Returns a list of labels for the given repository and user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<Label>	a list of labels for the given repository and user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-languages>

Get languages used in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
Map<String, Long>	map of language names mapped to line counts

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed\

<github:get-milestone>

Returns a single milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
number	Milestone number	String	/	UTF-8

Returns

Return Type	Description
Milestone	returns a single milestone

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-milestones>

Returns a list of milestones for the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	Optional. The owner of the repository, leave empty to use this#user	String	/	UTF-8
repository	The name of the repository	String	/	UTF-8
state	State of the milestone, open or closed	String	/	UTF-8

Returns

Return Type	Description
List<Milestone>	s list of Milestone for the given repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-org-repositories>

Get organization repositories for the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization		The organization for which to get the repositories for	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<github:filter-data>		Optional. Data to filter repos, if non is specified all repos will be returned	Map<String, String>

Returns

Return Type	Description
List<Repository>	list of Repository

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-repositories>

Get repositories for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Default Value	Description	Java Type
<github:filter-data>		Optional. Data to filter repos, if non is specified all repos will be returned	Map<String, String>

Returns

Return Type	Description
List<Repository>	list of Repository

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-repositories-for-user>

Get repositories for the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		The user for which to get the repositories for	String	/	UTF-8

Returns

Return Type	Description
List<Repository>	list of Repository

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-repository>

Get repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
Repository	repository

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-starred-gist>

Returns the starred gists for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Returns

Return Type	Description
List<Gist>	list of starred Gist for currently authenticated user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-tags>

Get tags in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<RepositoryTag>	list of tags

API Information

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-team>

Get team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The id of the team	int	/

Returns

Return Type	Description
Team	a Team instance

API Information

Get team

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-team-members>

Get members of team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The team id	int	/

Returns

Return Type	Description
List<User>	team members

API Information

List members

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-team-repositories>

Get all repositories for given team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id		The team id	int	/

Returns

Return Type	Description
List<Repository>	non-null list of repositories

API Information

List team repos

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-teams-for-org>

Get all teams in the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization		The organization for which te get the teams associated with	String	/	UTF-8

Returns

Return Type	Description
List<Team>	list of Team

API Information

List teams

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-user-by-login-name>

Get user with given login name

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
loginName		The login name of the user to look up	String	/	UTF-8

Returns

Return Type	Description
User	a User instance

API Information

Get a single user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-watched>

Get repositories watched by the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which the get the watched repositories, leave empty to use this#user	String	/	UTF-8

Returns

Return Type	Description
List<Repository>	non-null but possibly empty list of Repository

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:get-watchers>

Get users watching given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
List<User>	non-null but possibly empty list of User

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:is-collaborator>

Returns whether the user is a collaborator of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
user	Optional. The user to consult if it's a collaborator or not, leave empty to use this#user	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the user is a collaborator, false otherwise

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:is-following>

Returns wether the authenticated user is following the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		The user to check	String	/	UTF-8

Returns

Return Type	Description
boolean	wether the authenticated user is following the given user

API Information

Check if you are following a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:is-starred>

Returns whether the gist is starred or not

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist	String	/	UTF-8

Returns

Return Type	Description
boolean	returns true if the gist is starred, false otherwise

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:is-team-member>

Is the given user a member of the team with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The team id	int	/
user	The user name	String	/	UTF-8

Returns

Return Type	Description
boolean	true if member, false if not member

API Information

Get if a user is a public member

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:is-watching>

Is currently authenticated user watching given repository?

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Returns

Return Type	Description
boolean	true if watch, false otherwise

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:remove-collaborator>

Removes a collaborator from the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8
user	Optional. The user that's going to be removed as a collaborator from the given repository, leave empty to use this#user	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:remove-emails>

Removes one or more e-mail addresses to the currently authenticated user's account

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Default Value	Description	Java Type
<github:emails>		The email addresses to add	List<String>

API Information

Delete email address(es)

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:remove-team-member>

Remove given user from team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The team id	int	/
user	The user name	String	/	UTF-8

API Information

Remove a member

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:remove-team-repository>

Remove repository from team

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
id	The team id	int	/
owner	The owner of the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

API Information

Remove team repo

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:star-gist>

XML Sample

INCLUDE_ERROR

Star the gist with the given id

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be starred	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:unfollow>

Make the currently authenticated user unfollow the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		The user to unfollow	String	/	UTF-8

API Information

Unfollow a user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:unstar-gist>

XML Sample

INCLUDE_ERROR

Unstar the gist with the given id

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be unstarred	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:unwatch>

Remove currently authenticated user as a watcher of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:update-current-user>

Updates the currently authenticated user using the given attributes. Only provide values for the attributes you want to change.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userName	Optional. A the name for the current user	String	/	UTF-8
email	Optional. A publicly visibile email address for the current user	String	/	UTF-8
blog	Optional. A blog for the current user	String	/	UTF-8
company	Optional. A company for the current user	String	/	UTF-8
location	Optional. A location for the current user	String	/	UTF-8
hireable	Optional. Whether the current user is hireable	Boolean	/

Returns

Return Type	Description
User	a User instance representing the current user

API Information

Update the authenticated user

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed

<github:watch>

Add currently authenticated user as a watcher of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
owner	The name of the user that owns the repository	String	/	UTF-8
repositoryName	The name of the repository	String	/	UTF-8

Exception Payloads

Payload Class	Description
IOException	when the connection to the client failed