final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def asInstanceOf[T0]: T0

Definition Classes: Any

def clone(): AnyRef

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

def createBlob(owner: String, repo: String, content: String, encoding: Option[String], headers: Map[String, String]): F[GHResponse[RefInfo]]

Create a new Blob

owner: of the repo
repo: name of the repo
content: the new blob's content.
encoding: the encoding used for content. Currently, "utf-8" and "base64" are supported. Default: "utf-8".
headers: optional user headers to include in the request
returns: a GHResponse with RefObject

Definition Classes: GitDataInterpreter → GitData

def createCommit(owner: String, repo: String, message: String, tree: String, parents: List[String], author: Option[RefAuthor], headers: Map[String, String]): F[GHResponse[RefCommit]]

Create a new Commit

owner: of the repo
repo: name of the repo
message: the new commit's message.
tree: the SHA of the tree object this commit points to
parents: 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: object containing information about the author.
headers: optional user headers to include in the request
returns: a GHResponse with RefCommit

Definition Classes: GitDataInterpreter → GitData

def createReference(owner: String, repo: String, ref: String, sha: String, headers: Map[String, String]): F[GHResponse[Ref]]

Create a Reference

The ref in the URL must be formatted as heads/branch, not just branch. For example, the call to get the data for master branch will be heads/master.

owner: of the repo
repo: name of the repo
ref: The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
sha: the SHA1 value to set this reference to
headers: optional user headers to include in the request
returns: a GHResponse with the Ref

Definition Classes: GitDataInterpreter → GitData

def createTag(owner: String, repo: String, tag: String, message: String, objectSha: String, objectType: String, author: Option[RefAuthor], headers: Map[String, String]): F[GHResponse[Tag]]

Create a Tag

owner: of the repo
repo: name of the repo
tag: the tag.
message: the new tag message.
objectSha: the SHA of the git object this is tagging
objectType: the type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
author: object containing information about the individual creating the tag.
headers: optional user headers to include in the request
returns: a GHResponse with Tag

Definition Classes: GitDataInterpreter → GitData

def createTree(owner: String, repo: String, baseTree: Option[String], treeDataList: List[TreeData], headers: Map[String, String]): F[GHResponse[TreeResult]]

Create a new Tree

The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.

IMPORTANT: If you don't set the baseTree, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

owner

of the repo

repo

name of the repo

baseTree

the SHA1 of the tree you want to update with new data.

treeDataList

list (of path, mode, type, and sha/blob) specifying a tree structure:

path: The file referenced in the tree
mode: The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink
type string Either blob, tree, or commit
sha string The SHA1 checksum ID of the object in the tree
content string The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

headers

optional user headers to include in the request

returns

a GHResponse with TreeResult

Definition Classes: GitDataInterpreter → GitData

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

def getCommit(owner: String, repo: String, sha: String, headers: Map[String, String]): F[GHResponse[RefCommit]]

Get a Commit by sha

owner: of the repo
repo: name of the repo
sha: the sha of the commit
headers: optional user headers to include in the request
returns: a GHResponse with the Commit

Definition Classes: GitDataInterpreter → GitData

def getReference(owner: String, repo: String, ref: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[NonEmptyList[Ref]]]

Get a Reference by name

The ref in the URL must be formatted as heads/branch, not just branch. For example, the call to get the data for master branch will be heads/master.

If the ref doesn't exist in the repository, but existing refs start with ref they will be returned as an array. For example, a call to get the data for a branch named feature, which doesn't exist, would return head refs including featureA and featureB which do.

owner: of the repo
repo: name of the repo
ref: ref formatted as heads/branch
pagination: Limit and Offset for pagination
headers: optional user headers to include in the request
returns: a GHResponse with the Ref list

Definition Classes: GitDataInterpreter → GitData

def getTree(owner: String, repo: String, sha: String, recursive: Boolean, headers: Map[String, String]): F[GHResponse[TreeResult]]

Get a Tree by sha

owner: of the repo
repo: name of the repo
sha: the sha of the tree
recursive: flag whether to get the tree recursively
headers: optional user headers to include in the request
returns: a GHResponse with the Tree

Definition Classes: GitDataInterpreter → GitData

def hashCode(): Int

Definition Classes: AnyRef → Any
Annotations: @native()

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

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

Definition Classes: AnyRef

def toString(): String

Definition Classes: AnyRef → Any

def updateReference(owner: String, repo: String, ref: String, sha: String, force: Boolean, headers: Map[String, String]): F[GHResponse[Ref]]

Update a Reference

owner: of the repo
repo: name of the repo
ref: ref formatted as heads/branch
sha: the SHA1 value to set this reference to
force: Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work. Default: false
headers: optional user headers to include in the request
returns: a GHResponse with the Ref

Definition Classes: GitDataInterpreter → GitData

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

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

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

Packages

GitDataInterpreter

class GitDataInterpreter[F[_]] extends GitData[F]

Instance Constructors

Value Members

Inherited from GitData[F]

Inherited from AnyRef

Inherited from Any

Ungrouped