class PullRequest

github :: PullRequest

A Github pull request.

Should be accessed from GithubAPI::get_pull.

PullRequest are basically Issues with more data. See https://developer.github.com/v3/pulls/.

Introduced properties

fun additions: nullable Int

github :: PullRequest :: additions

Added line count.
fun additions=(additions: nullable Int)

github :: PullRequest :: additions=

Added line count.
fun base: PullRef

github :: PullRequest :: base

Pull request base (can be a commit SHA or a branch name).
fun base=(base: PullRef)

github :: PullRequest :: base=

Pull request base (can be a commit SHA or a branch name).
fun changed_files: nullable Int

github :: PullRequest :: changed_files

Changed files count.
fun changed_files=(changed_files: nullable Int)

github :: PullRequest :: changed_files=

Changed files count.
fun commits: nullable Int

github :: PullRequest :: commits

Count of commits in this pull request.
fun commits=(commits: nullable Int)

github :: PullRequest :: commits=

Count of commits in this pull request.
init defaultinit(number: Int, id: nullable Int, title: String, user: nullable User, labels: nullable Array[Label], state: String, locked: nullable Bool, assignee: nullable User, milestone: nullable Milestone, comments: nullable Int, created_at: String, updated_at: nullable String, closed_at: nullable String, body: nullable String, closed_by: nullable User, merged_at: nullable String, merge_commit_sha: nullable String, review_comments: nullable Int, head: PullRef, base: PullRef, merged: nullable Bool, mergeable: nullable Bool, mergeable_state: nullable String, merged_by: nullable User, commits: nullable Int, additions: nullable Int, deletions: nullable Int, changed_files: nullable Int, patch_url: nullable String)

github :: PullRequest :: defaultinit

fun deletions: nullable Int

github :: PullRequest :: deletions

Deleted line count.
fun deletions=(deletions: nullable Int)

github :: PullRequest :: deletions=

Deleted line count.
fun head: PullRef

github :: PullRequest :: head

Pull request head (can be a commit SHA or a branch name).
fun head=(head: PullRef)

github :: PullRequest :: head=

Pull request head (can be a commit SHA or a branch name).
fun merge_commit_sha: nullable String

github :: PullRequest :: merge_commit_sha

Merge commit SHA.
fun merge_commit_sha=(merge_commit_sha: nullable String)

github :: PullRequest :: merge_commit_sha=

Merge commit SHA.
fun mergeable: nullable Bool

github :: PullRequest :: mergeable

Is this pull request mergeable?
fun mergeable=(mergeable: nullable Bool)

github :: PullRequest :: mergeable=

Is this pull request mergeable?
fun mergeable_state: nullable String

github :: PullRequest :: mergeable_state

Mergeable state of this pull request.
fun mergeable_state=(mergeable_state: nullable String)

github :: PullRequest :: mergeable_state=

Mergeable state of this pull request.
fun merged: nullable Bool

github :: PullRequest :: merged

Is this pull request merged?
fun merged=(merged: nullable Bool)

github :: PullRequest :: merged=

Is this pull request merged?
fun merged_at: nullable String

github :: PullRequest :: merged_at

Merge time as String (if any).
fun merged_at=(merged_at: nullable String)

github :: PullRequest :: merged_at=

Merge time as String (if any).
fun merged_by: nullable User

github :: PullRequest :: merged_by

User that merged this pull request (if any).
fun merged_by=(merged_by: nullable User)

github :: PullRequest :: merged_by=

User that merged this pull request (if any).
fun patch_url: nullable String

github :: PullRequest :: patch_url

URL to patch file
fun patch_url=(patch_url: nullable String)

github :: PullRequest :: patch_url=

URL to patch file
fun review_comments: nullable Int

github :: PullRequest :: review_comments

Count of comments made on the pull request diff.
fun review_comments=(review_comments: nullable Int)

github :: PullRequest :: review_comments=

Count of comments made on the pull request diff.

Redefined properties

redef type SELF: PullRequest

github $ PullRequest :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

github $ PullRequest :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

github $ PullRequest :: from_deserializer

Create an instance of this class from the deserializer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun additions: nullable Int

github :: PullRequest :: additions

Added line count.
fun additions=(additions: nullable Int)

github :: PullRequest :: additions=

Added line count.
fun assignee: nullable User

github :: Issue :: assignee

Assigned User (if any).
fun assignee=(assignee: nullable User)

github :: Issue :: assignee=

Assigned User (if any).
fun base: PullRef

github :: PullRequest :: base

Pull request base (can be a commit SHA or a branch name).
fun base=(base: PullRef)

github :: PullRequest :: base=

Pull request base (can be a commit SHA or a branch name).
fun body: nullable String

github :: Issue :: body

Full description of the issue.
fun body=(body: nullable String)

github :: Issue :: body=

Full description of the issue.
fun changed_files: nullable Int

github :: PullRequest :: changed_files

Changed files count.
fun changed_files=(changed_files: nullable Int)

github :: PullRequest :: changed_files=

Changed files count.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun closed_at: nullable String

github :: Issue :: closed_at

Close time as String (if any).
fun closed_at=(closed_at: nullable String)

github :: Issue :: closed_at=

Close time as String (if any).
fun closed_by: nullable User

github :: Issue :: closed_by

User that closed this issue (if any).
fun closed_by=(closed_by: nullable User)

github :: Issue :: closed_by=

User that closed this issue (if any).
fun comments: nullable Int

github :: Issue :: comments

Number of comments on this issue.
fun comments=(comments: nullable Int)

github :: Issue :: comments=

Number of comments on this issue.
fun commits: nullable Int

github :: PullRequest :: commits

Count of commits in this pull request.
fun commits=(commits: nullable Int)

github :: PullRequest :: commits=

Count of commits in this pull request.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun created_at: String

github :: Issue :: created_at

Creation time as String.
fun created_at=(created_at: String)

github :: Issue :: created_at=

Creation time as String.
init defaultinit(number: Int, id: nullable Int, title: String, user: nullable User, labels: nullable Array[Label], state: String, locked: nullable Bool, assignee: nullable User, milestone: nullable Milestone, comments: nullable Int, created_at: String, updated_at: nullable String, closed_at: nullable String, body: nullable String, closed_by: nullable User, merged_at: nullable String, merge_commit_sha: nullable String, review_comments: nullable Int, head: PullRef, base: PullRef, merged: nullable Bool, mergeable: nullable Bool, mergeable_state: nullable String, merged_by: nullable User, commits: nullable Int, additions: nullable Int, deletions: nullable Int, changed_files: nullable Int, patch_url: nullable String)

github :: PullRequest :: defaultinit

init defaultinit(number: Int, id: nullable Int, title: String, user: nullable User, labels: nullable Array[Label], state: String, locked: nullable Bool, assignee: nullable User, milestone: nullable Milestone, comments: nullable Int, created_at: String, updated_at: nullable String, closed_at: nullable String, body: nullable String, closed_by: nullable User)

github :: Issue :: defaultinit

fun deletions: nullable Int

github :: PullRequest :: deletions

Deleted line count.
fun deletions=(deletions: nullable Int)

github :: PullRequest :: deletions=

Deleted line count.
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun head: PullRef

github :: PullRequest :: head

Pull request head (can be a commit SHA or a branch name).
fun head=(head: PullRef)

github :: PullRequest :: head=

Pull request head (can be a commit SHA or a branch name).
fun id: nullable Int

github :: Issue :: id

Issue id.
fun id=(id: nullable Int)

github :: Issue :: id=

Issue id.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
fun is_pull_request: Bool

github :: Issue :: is_pull_request

Is this issue linked to a pull request?
fun is_pull_request=(is_pull_request: Bool)

github :: Issue :: is_pull_request=

Is this issue linked to a pull request?
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun labels: nullable Array[Label]

github :: Issue :: labels

List of labels on this issue associated to their names.
fun labels=(labels: nullable Array[Label])

github :: Issue :: labels=

List of labels on this issue associated to their names.
fun locked: nullable Bool

github :: Issue :: locked

Is the issue locked?
fun locked=(locked: nullable Bool)

github :: Issue :: locked=

Is the issue locked?
fun merge_commit_sha: nullable String

github :: PullRequest :: merge_commit_sha

Merge commit SHA.
fun merge_commit_sha=(merge_commit_sha: nullable String)

github :: PullRequest :: merge_commit_sha=

Merge commit SHA.
fun mergeable: nullable Bool

github :: PullRequest :: mergeable

Is this pull request mergeable?
fun mergeable=(mergeable: nullable Bool)

github :: PullRequest :: mergeable=

Is this pull request mergeable?
fun mergeable_state: nullable String

github :: PullRequest :: mergeable_state

Mergeable state of this pull request.
fun mergeable_state=(mergeable_state: nullable String)

github :: PullRequest :: mergeable_state=

Mergeable state of this pull request.
fun merged: nullable Bool

github :: PullRequest :: merged

Is this pull request merged?
fun merged=(merged: nullable Bool)

github :: PullRequest :: merged=

Is this pull request merged?
fun merged_at: nullable String

github :: PullRequest :: merged_at

Merge time as String (if any).
fun merged_at=(merged_at: nullable String)

github :: PullRequest :: merged_at=

Merge time as String (if any).
fun merged_by: nullable User

github :: PullRequest :: merged_by

User that merged this pull request (if any).
fun merged_by=(merged_by: nullable User)

github :: PullRequest :: merged_by=

User that merged this pull request (if any).
fun milestone: nullable Milestone

github :: Issue :: milestone

Milestone (if any).
fun milestone=(milestone: nullable Milestone)

github :: Issue :: milestone=

Milestone (if any).
protected fun mongo_id=(mongo_id: String)

github :: Issue :: mongo_id=

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
fun number: Int

github :: Issue :: number

Issue Github ID.
fun number=(number: Int)

github :: Issue :: number=

Issue Github ID.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun patch_url: nullable String

github :: PullRequest :: patch_url

URL to patch file
fun patch_url=(patch_url: nullable String)

github :: PullRequest :: patch_url=

URL to patch file
fun repo: nullable Repo

github :: RepoEntity :: repo

fun repo=(repo: nullable Repo)

github :: RepoEntity :: repo=

fun review_comments: nullable Int

github :: PullRequest :: review_comments

Count of comments made on the pull request diff.
fun review_comments=(review_comments: nullable Int)

github :: PullRequest :: review_comments=

Count of comments made on the pull request diff.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
fun state: String

github :: Issue :: state

State of the issue on Github.
fun state=(state: String)

github :: Issue :: state=

State of the issue on Github.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun title: String

github :: Issue :: title

Issue title.
fun title=(title: String)

github :: Issue :: title=

Issue title.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun updated_at: nullable String

github :: Issue :: updated_at

Last update time as String (if any).
fun updated_at=(updated_at: nullable String)

github :: Issue :: updated_at=

Last update time as String (if any).
fun user: nullable User

github :: Issue :: user

User that created this issue.
fun user=(user: nullable User)

github :: Issue :: user=

User that created this issue.
package_diagram github::PullRequest PullRequest github::Issue Issue github::PullRequest->github::Issue github::RepoEntity RepoEntity github::Issue->github::RepoEntity ...github::RepoEntity ... ...github::RepoEntity->github::RepoEntity

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

class Issue

github :: Issue

A Github issue.

Class definitions

github $ PullRequest 
# A Github pull request.
#
# Should be accessed from `GithubAPI::get_pull`.
#
# PullRequest are basically Issues with more data.
# See <https://developer.github.com/v3/pulls/>.
class PullRequest
	super Issue
	serialize

	# Merge time as String (if any).
	var merged_at: nullable String is writable

	# Merge commit SHA.
	var merge_commit_sha: nullable String is writable

	# Count of comments made on the pull request diff.
	var review_comments: nullable Int is writable

	# Pull request head (can be a commit SHA or a branch name).
	var head: PullRef is writable

	# Pull request base (can be a commit SHA or a branch name).
	var base: PullRef is writable

	# Is this pull request merged?
	var merged: nullable Bool is writable

	# Is this pull request mergeable?
	var mergeable: nullable Bool is writable

	# Mergeable state of this pull request.
	#
	# See <https://developer.github.com/v3/pulls/#list-pull-requests>.
	var mergeable_state: nullable String is writable

	# User that merged this pull request (if any).
	var merged_by: nullable User is writable

	# Count of commits in this pull request.
	var commits: nullable Int is writable

	# Added line count.
	var additions: nullable Int is writable

	# Deleted line count.
	var deletions: nullable Int is writable

	# Changed files count.
	var changed_files: nullable Int is writable

	# URL to patch file
	var patch_url: nullable String is writable
end
lib/github/api.nit:682,1--735,3
Nit standard library. Version v0.8-3595-g3f58b4f.