GitData

Instance Constructors

new GitData()(implicit urls: GithubApiUrls, C: Capture[M], httpClientImpl: HttpRequestBuilderExtension[C, M])

Value Members

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def commit(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, sha: String): M[GHResponse[RefCommit]]

Get a Commit by sha
Get a Commit by sha
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
owner
of the repo
repo
name of the repo
sha
the sha of the commit
returns
a GHResponse with the Commit
def createBlob(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, content: String, encoding: Option[String] = None): M[GHResponse[RefInfo]]

Create a new Blob
Create a new Blob
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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".
returns
a GHResponse with RefObject
def createCommit(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, message: String, tree: String, parents: List[String] = Nil, author: Option[RefAuthor] = None): M[GHResponse[RefCommit]]

Create a new Commit
Create a new Commit
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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.
returns
a GHResponse with RefCommit
def createReference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String, sha: String): M[GHResponse[Ref]]

Create a Reference
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.
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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
returns
a GHResponse with the Ref
def createTag(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, tag: String, message: String, objectSha: String, objectType: String, tagger: Option[RefAuthor] = None): M[GHResponse[Tag]]

Create a Tag
Create a Tag
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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.
tagger
object containing information about the individual creating the tag.
returns
a GHResponse with Tag
def createTree(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, baseTree: Option[String], treeDataList: List[TreeData]): M[GHResponse[TreeResult]]

Create a new Tree
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.
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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.
returns
a GHResponse with TreeResult
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val httpClient: HttpClient[C, M]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String): M[GHResponse[NonEmptyList[Ref]]]

Get a Reference by name
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.
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
owner
of the repo
repo
name of the repo
ref
ref formatted as heads/branch
returns
a GHResponse with the Ref list
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def updateReference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String, sha: String, force: Option[Boolean] = None): M[GHResponse[Ref]]

Update a Reference
Update a Reference
accessToken
to identify the authenticated user
headers
optional user headers to include in the request
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
returns
a GHResponse with the Ref
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( ... )

Related Doc: package api

class GitData[C, M[_]] extends AnyRef

Instance Constructors

new GitData()(implicit urls: GithubApiUrls, C: Capture[M], httpClientImpl: HttpRequestBuilderExtension[C, M])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def commit(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, sha: String): M[GHResponse[RefCommit]]

def createBlob(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, content: String, encoding: Option[String] = None): M[GHResponse[RefInfo]]

def createCommit(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, message: String, tree: String, parents: List[String] = Nil, author: Option[RefAuthor] = None): M[GHResponse[RefCommit]]

def createReference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String, sha: String): M[GHResponse[Ref]]

def createTag(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, tag: String, message: String, objectSha: String, objectType: String, tagger: Option[RefAuthor] = None): M[GHResponse[Tag]]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val httpClient: HttpClient[C, M]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String): M[GHResponse[NonEmptyList[Ref]]]

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

def toString(): String

def updateReference(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String, sha: String, force: Option[Boolean] = None): M[GHResponse[Ref]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped