Value Members

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

   Definition Classes

   Any

2.  final def ##(): Int

   Definition Classes

   Any

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

   Definition Classes

   Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def branchFuture(oldBranchName: String, newBranchName: String): Future[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

   returns

   a promise of completion

   Annotations

   @inline()

6.  def branchFuture(newBranchName: String): Future[Unit]

   Create new branch for repo.

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

   newBranchName

   the new branch name

   returns

   a promise of completion

   Annotations

   @inline()

7.  def contentsFuture(branch: String, pathToDir: String): Future[Array[Content]]

   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

   returns

   a promise of the contents

   Annotations

   @inline()

8.  def contributorsFuture: Future[Array[Contributor]]

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

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

   returns

   a promise of the contributors

   Annotations

   @inline()

9.  def getClass(): Class[_ <: AnyVal]

   Definition Classes

   AnyVal → Any

10.  def getCommitFuture(branch: String, sha: String): Future[Commit]

    Get information about a particular commit.

    Get information about a particular commit.

    branch

    the branch name

    sha

    the SHA key

    returns

    a promise of the commit

    Annotations

    @inline()

11.  def getStatusesFuture(sha: String): Future[Array[CommitStatus]]

    Get list of statuses for a particular commit.

    Get list of statuses for a particular commit.

    sha

    the SHA key

    returns

    a promise of the array of commit statuses

    Annotations

    @inline()

12.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

13.  def isStarredFuture(owner: String, repository: String): Future[Boolean]

    Check if a repository is starred.

    Check if a repository is starred.

    owner

    the owner

    repository

    the repository

    returns

    the completion callback

    Annotations

    @inline()

14.  def listBranchesFuture: Future[Array[String]]

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

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

    returns

    a promise of the array of branches

    Annotations

    @inline()

15.  def readFuture(branch: String, pathToFile: String): Future[Any]

    Reads stored content

    Reads stored content

    branch

    the branch name

    pathToFile

    the path to the content

    returns

    a promise of the content

    Annotations

    @inline()

16.  def removeFuture(branch: String, pathToFile: String): Future[Unit]

    Remove a file.

    Remove a file.

    branch

    the branch name

    pathToFile

    the path to the content

    returns

    a promise of completion

    Annotations

    @inline()

17.  val repo: Repositories
18.  def showFuture: Future[Repository]

    Show repository information

    Show repository information

    returns

    a promise of a Repository

    Annotations

    @inline()

19.  def toString(): String

    Definition Classes

    Any

20.  def writeFuture(branch: String, pathToFile: String, contents: String, commitMessage: String, options: RawOptions): Future[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

    returns

    a promise of completion

    Annotations

    @inline()