abstract class APIFeedBack

nitc :: APIFeedBack

Base handler for feedback features.

Introduced properties

fun get_session_login(req: HttpRequest): nullable String

nitc :: APIFeedBack :: get_session_login

Get the login of the session user or null if no session
fun get_session_user(req: HttpRequest): nullable User

nitc :: APIFeedBack :: get_session_user

Get the user logged in or null if no session

Redefined properties

redef type SELF: APIFeedBack

nitc $ APIFeedBack :: SELF

Type of this instance, automatically specialized in every class

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 BODY: Serializable

popcorn :: Handler :: BODY

Kind of objects returned by deserialize_body
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
private var _body_type: String

popcorn :: Handler :: _body_type

private var _config: NitwebConfig

nitc :: APIHandler :: _config

App config.
private var _validator: nullable DocumentValidator

popcorn :: Handler :: _validator

Validator used to check body input
fun all(req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: all

Handler to all kind of HTTP request methods.
private fun body_type: String

popcorn :: Handler :: body_type

private fun body_type=(body_type: String)

popcorn :: Handler :: body_type=

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 config: NitwebConfig

nitc :: APIHandler :: config

App config.
protected fun config=(config: NitwebConfig)

nitc :: APIHandler :: config=

App config.
fun delete(req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: delete

DELETE handler.
fun deserialize_body(req: HttpRequest, res: HttpResponse): nullable BODY

popcorn :: Handler :: deserialize_body

Deserialize the request body
fun find_mentity(full_name: nullable String): nullable MEntity

nitc :: APIHandler :: find_mentity

Find the MEntity withfull_name`.
fun get(req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: get

GET handler.
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_session_login(req: HttpRequest): nullable String

nitc :: APIFeedBack :: get_session_login

Get the login of the session user or null if no session
fun get_session_user(req: HttpRequest): nullable User

nitc :: APIFeedBack :: get_session_user

Get the user logged in or null if no session
private fun handle(route: AppRoute, uri: String, req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: handle

Call all(req, res) if route matches uri.
fun hash: Int

core :: Object :: hash

The hash code of the object.
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".
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 mentity_from_uri(req: HttpRequest, res: HttpResponse): nullable MEntity

nitc :: APIHandler :: mentity_from_uri

Try to load the mentity from uri with /:id.
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
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 paginate(results: JsonArray, count: Int, page: nullable Int, limit: nullable Int): JsonObject

nitc :: APIHandler :: paginate

Paginate a json array
fun post(req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: post

POST handler.
fun put(req: HttpRequest, res: HttpResponse)

popcorn :: Handler :: put

PUT handler.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun validate_body(req: HttpRequest, res: HttpResponse): nullable String

popcorn :: Handler :: validate_body

Validate body input with validator
fun validator: nullable DocumentValidator

popcorn :: Handler :: validator

Validator used to check body input
protected fun validator=(validator: nullable DocumentValidator)

popcorn :: Handler :: validator=

Validator used to check body input
package_diagram nitc::APIFeedBack APIFeedBack nitc::APIHandler APIHandler nitc::APIFeedBack->nitc::APIHandler popcorn::Handler Handler nitc::APIHandler->popcorn::Handler ...popcorn::Handler ... ...popcorn::Handler->popcorn::Handler nitc::APIStarsMost APIStarsMost nitc::APIStarsMost->nitc::APIFeedBack nitc::APIStarsBest APIStarsBest nitc::APIStarsBest->nitc::APIFeedBack nitc::APIStarsWorst APIStarsWorst nitc::APIStarsWorst->nitc::APIFeedBack nitc::APIStarsUsers APIStarsUsers nitc::APIStarsUsers->nitc::APIFeedBack nitc::APIUserStars APIUserStars nitc::APIUserStars->nitc::APIFeedBack nitc::APIStars APIStars nitc::APIStars->nitc::APIFeedBack nitc::APIStarsDimension APIStarsDimension nitc::APIStarsDimension->nitc::APIFeedBack

Ancestors

abstract class Handler

popcorn :: Handler

Class handler for a route.
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class APIHandler

nitc :: APIHandler

Specific handler for the nitweb API.

Children

class APIStars

nitc :: APIStars

Stars attributed to mentities
class APIStarsBest

nitc :: APIStarsBest

Best rated entities
class APIStarsDimension

nitc :: APIStarsDimension

Stars attributed to mentities by dimension
class APIStarsMost

nitc :: APIStarsMost

Most rated entities
class APIStarsUsers

nitc :: APIStarsUsers

Best rated entities
class APIStarsWorst

nitc :: APIStarsWorst

Best rated entities
class APIUserStars

nitc :: APIUserStars

Stars attributed to mentities by user

Class definitions

nitc $ APIFeedBack 
# Base handler for feedback features.
abstract class APIFeedBack
	super APIHandler

	# Get the user logged in or null if no session
	fun get_session_user(req: HttpRequest): nullable User do
		var session = req.session
		if session == null then return null
		return session.user
	end

	# Get the login of the session user or null if no session
	fun get_session_login(req: HttpRequest): nullable String do
		var user = get_session_user(req)
		if user == null then return null
		return user.login
	end
end
src/doc/api/api_feedback.nit:44,1--61,3
Nit tools. Version .