RepositoryEnrichment

Instance Constructors

new RepositoryEnrichment(repo: Repositories)

repo
the given Repositories instance

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
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()
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()
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()
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()
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
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()
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()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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()
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()
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()
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()
val repo: Repositories

the given Repositories instance
def showFuture: Future[Repository]

Show repository information
Show repository information
returns
a promise of a Repository

Annotations
@inline()
def toString(): String

Definition Classes
Any
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()

Related Doc: package githubapinode

implicit final class RepositoryEnrichment extends AnyVal

Instance Constructors

new RepositoryEnrichment(repo: Repositories)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def branchFuture(oldBranchName: String, newBranchName: String): Future[Unit]

def branchFuture(newBranchName: String): Future[Unit]

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

def contributorsFuture: Future[Array[Contributor]]

def getClass(): Class[_ <: AnyVal]

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

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

final def isInstanceOf[T0]: Boolean

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

def listBranchesFuture: Future[Array[String]]

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

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

val repo: Repositories

def showFuture: Future[Repository]

def toString(): String

def writeFuture(branch: String, pathToFile: String, contents: String, commitMessage: String, options: RawOptions): Future[Unit]

Inherited from AnyVal

Inherited from Any

Ungrouped