class PullComment

github :: PullComment

Comments made on Github pull request diffs.

Should be accessed from GithubAPI::get_diff_comment.

See https://developer.github.com/v3/pulls/comments/.

Introduced properties

fun commit_id: String

github :: PullComment :: commit_id

Commit referenced by this comment.
fun commit_id=(commit_id: String)

github :: PullComment :: commit_id=

Commit referenced by this comment.
init defaultinit(id: Int, user: User, created_at: String, updated_at: nullable String, body: String, pull_request_url: String, diff_hunk: String, path: String, position: nullable Int, original_position: Int, commit_id: String, original_commit_id: String)

github :: PullComment :: defaultinit

fun diff_hunk: String

github :: PullComment :: diff_hunk

Diff hunk.
fun diff_hunk=(diff_hunk: String)

github :: PullComment :: diff_hunk=

Diff hunk.
fun original_commit_id=(original_commit_id: String)

github :: PullComment :: original_commit_id=

Original commit id.
fun original_position: Int

github :: PullComment :: original_position

Original position in the diff.
fun original_position=(original_position: Int)

github :: PullComment :: original_position=

Original position in the diff.
fun path: String

github :: PullComment :: path

Path of commented file.
fun path=(path: String)

github :: PullComment :: path=

Path of commented file.
fun position: nullable Int

github :: PullComment :: position

Position of the comment on the file.
fun position=(position: nullable Int)

github :: PullComment :: position=

Position of the comment on the file.
fun pull_number: Int

github :: PullComment :: pull_number

Pull request that contains self.
fun pull_request_url: String

github :: PullComment :: pull_request_url

Link to the pull request on API.
fun pull_request_url=(pull_request_url: String)

github :: PullComment :: pull_request_url=

Link to the pull request on API.

Redefined properties

redef type SELF: PullComment

github $ PullComment :: SELF

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

github $ PullComment :: core_serialize_to

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

github $ PullComment :: 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 body: String

github :: Comment :: body

Comment body text.
fun body=(body: String)

github :: Comment :: body=

Comment body text.
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 commit_id: String

github :: PullComment :: commit_id

Commit referenced by this comment.
fun commit_id=(commit_id: String)

github :: PullComment :: commit_id=

Commit referenced by this comment.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun created_at: String

github :: Comment :: created_at

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

github :: Comment :: created_at=

Creation time as String.
init defaultinit(id: Int, user: User, created_at: String, updated_at: nullable String, body: String)

github :: Comment :: defaultinit

init defaultinit(id: Int, user: User, created_at: String, updated_at: nullable String, body: String, pull_request_url: String, diff_hunk: String, path: String, position: nullable Int, original_position: Int, commit_id: String, original_commit_id: String)

github :: PullComment :: defaultinit

fun diff_hunk: String

github :: PullComment :: diff_hunk

Diff hunk.
fun diff_hunk=(diff_hunk: String)

github :: PullComment :: diff_hunk=

Diff hunk.
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 id: Int

github :: Comment :: id

Identifier of this comment.
fun id=(id: Int)

github :: Comment :: id=

Identifier of this comment.
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_ack: Bool

github :: Comment :: is_ack

Does the comment contain an acknowledgement (+1)
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.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

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

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun original_commit_id=(original_commit_id: String)

github :: PullComment :: original_commit_id=

Original commit id.
fun original_position: Int

github :: PullComment :: original_position

Original position in the diff.
fun original_position=(original_position: Int)

github :: PullComment :: original_position=

Original position in the diff.
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 path: String

github :: PullComment :: path

Path of commented file.
fun path=(path: String)

github :: PullComment :: path=

Path of commented file.
fun position: nullable Int

github :: PullComment :: position

Position of the comment on the file.
fun position=(position: nullable Int)

github :: PullComment :: position=

Position of the comment on the file.
fun pull_number: Int

github :: PullComment :: pull_number

Pull request that contains self.
fun pull_request_url: String

github :: PullComment :: pull_request_url

Link to the pull request on API.
fun pull_request_url=(pull_request_url: String)

github :: PullComment :: pull_request_url=

Link to the pull request on API.
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
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
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 :: Comment :: updated_at

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

github :: Comment :: updated_at=

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

github :: Comment :: user

User that made this comment.
fun user=(user: User)

github :: Comment :: user=

User that made this comment.
package_diagram github::PullComment PullComment github::Comment Comment github::PullComment->github::Comment serialization::Serializable Serializable github::Comment->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable

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

abstract class Comment

github :: Comment

A Github comment

Class definitions

github $ PullComment 
# Comments made on Github pull request diffs.
#
# Should be accessed from `GithubAPI::get_diff_comment`.
#
# See <https://developer.github.com/v3/pulls/comments/>.
class PullComment
	super Comment
	serialize

	# Pull request that contains `self`.
	fun pull_number: Int do return pull_request_url.split("/").last.to_i

	# Link to the pull request on API.
	var pull_request_url: String is writable

	# Diff hunk.
	var diff_hunk: String is writable

	# Path of commented file.
	var path: String is writable

	# Position of the comment on the file.
	var position: nullable Int is writable

	# Original position in the diff.
	var original_position: Int is writable

	# Commit referenced by this comment.
	var commit_id: String is writable

	# Original commit id.
	var original_commit_id: String is writable
end
lib/github/api.nit:930,1--962,3
Nit standard library. Version v0.8-3595-g3f58b4f.