Repositories

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def branch(newBranchName: String, callback: GitHubCallback0): Unit

   

   Create new branch (from master) for repo.

   Create new branch (from master) for repo.

   newBranchName

   the new branch name

   callback

   the callback

6. def branch(oldBranchName: String, newBranchName: String, callback: GitHubCallback0): Unit

   

   Create new branch for repo.

   Create new branch for repo. You can omit oldBranchName to default to "master".

   oldBranchName

   the old branch name

   newBranchName

   the new branch name

   callback

   the callback

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def contents(branch: String, pathToDir: String, callback: GitHubCallback1[Array[Content]]): Unit

   

   Get contents at a particular path in a particular branch.

   Get contents at a particular path in a particular branch.

   branch

   the desired branch (e.g. "master")

   pathToDir

   the "path to" directory

   callback

   the callback

9. def contributors(callback: GitHubCallback1[Array[Contributor]]): Unit

   

   Get contributors list with additions, deletions, and commit counts.

   Get contributors list with additions, deletions, and commit counts.

   callback

   the callback containing either an error or the array of contributors

10. def createPullRequest(pull: Pull, callback: GitHubCallback1[PullRequest]): Unit

    

    Create Pull Request.

    Create Pull Request.

    pull

    the Pull

    callback

    the callback

11. def createRef(refSpec: RefSpec, callback: GitHubCallback0): Unit

    

    Create a new reference.

    Create a new reference.

    refSpec

    the RefSpec

    callback

    the callback containing an error if one occurred

12. def deleteRef(ref: String, callback: GitHubCallback0): Unit

    

    Delete a reference.

    Delete a reference.

    ref

    the given reference name (e.g. "heads/gh-pages")

    callback

    the callback containing an error if one occurred

    Example:

    1. repo.deleteRef('heads/gh-pages', function(err) {})

13. def deleteRepo(callback: GitHubCallback1[Resource]): Unit

    

    Delete a repository

    Delete a repository

    callback

    the callback

14. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

15. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

16. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

17. def fork(callback: GitHubCallback0): Unit

    

    Fork repository.

    Fork repository. This operation runs asynchronously. You may want to poll for repo.contents until the forked repo is ready.

    callback

    the callback

18. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

19. def getCommit(branch: String, sha: String, callback: GitHubCallback1[Commit]): Unit

    

    Get information about a particular commit.

    Get information about a particular commit.

    branch

    the branch name (e.g. "master")

    sha

    the SHA key

    callback

    the callback containing either an error or the commit

20. def getSha(branch: String, pathToFile: String, callback: GitHubCallback1[SHA]): Unit

    
    branch

    the branch name (e.g. "master")

    pathToFile

    the path to the file

    callback

    the callback containing either an error or the SHA

21. def getStatuses(sha: String, callback: GitHubCallback1[Array[CommitStatus]]): Unit

    

    Get list of statuses for a particular commit.

    Get list of statuses for a particular commit.

    sha

    the SHA key

    callback

    the callback containing either an error or the array of commit statuses

22. def getTree(branch: String, callback: GitHubCallback1[Tree]): Unit

    

    Exploring files of a repository is easy too by accessing the top level tree object.

    Exploring files of a repository is easy too by accessing the top level tree object.

    branch

    the branch name (e.g. "master")

    callback

    the callback containing either an error or the tree

    Example:

    1. repo.getTree('master', function(err, tree) {})

23. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

24. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

25. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

26. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

27. def isStarred(owner: String, repository: String, callback: GitHubCallback1[Boolean]): Unit

    

    Check if a repository is starred.

    Check if a repository is starred.

    owner

    the owner

    repository

    the repository

    callback

    the completion callback

28. def listBranches(callback: GitHubCallback1[Array[String]]): Unit

    

    Retrieve all available branches (aka heads) of a repository.

    Retrieve all available branches (aka heads) of a repository.

    callback

    the callback

29. def listForks(callback: GitHubCallback1[Array[Fork]]): Unit

    

    List forks.

    List forks.

    callback

    the callback

30. def listPulls(state: String, callback: GitHubCallback1[Array[PullRequest]]): Unit

    

    List Pull Requests.

    List Pull Requests.

    state

    the state of the Pull Request ('open', 'closed' or 'all')

    callback

    the callback

31. def move(branch: String, pathToFile: String, pathToNewFile: String, callback: GitHubCallback0): Unit

    

    Move a file from A to B.

    Move a file from A to B.

    branch

    the branch name

    pathToFile

    the path to the file to be moved

    pathToNewFile

    the new path to the file

    callback

    the completion callback

32. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

35. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

36. def read(branch: String, pathToFile: String, callback: GitHubCallback1[Any]): Unit

    

    Reads stored content

    Reads stored content

    branch

    the branch name

    pathToFile

    the path to the content

    callback

    the callback

37. def remove(branch: String, pathToFile: String, callback: GitHubCallback0): Unit

    

    Remove a file.

    Remove a file.

    branch

    the branch name

    pathToFile

    the path to the content

    callback

    the completion callback

38. def show(callback: Function2[GithubError, Repository, Any]): Unit

    

    Show repository information

    Show repository information

    callback

    the callback

39. def star(owner: String, repository: String, callback: GitHubCallback0): Unit

    

    Star a repository.

    Star a repository.

    owner

    the owner

    repository

    the repository name

    callback

    the completion callback

40. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

41. def toLocaleString(): String

    

    Definition Classes

    Object

42. def toString(): String

    

    Definition Classes

    AnyRef → Any

43. def unstar(owner: String, repository: String, callback: GitHubCallback0): Unit

    

    Unstar a repository.

    Unstar a repository.

    owner

    the owner

    repository

    the repository name

    callback

    the completion callback

44. def valueOf(): Any

    

    Definition Classes

    Object

45. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

46. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

47. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

48. def write(branch: String, pathToFile: String, contents: String, commitMessage: String, options: RawOptions, callback: GitHubCallback0): Unit

    

    Store content at a certain path.

    Store content at a certain path. If the file specified in the path exists, the content is updated. If the file doesn't exist, it's created on the fly. You can also provide an optional object literal, (options in the example below) containing information about the author and the committer.

    branch

    the branch name

    pathToFile

    the path to the content

    contents

    the user content

    commitMessage

    the commit message

    options

    the optional settings

    callback

    the callback