WebSocketAction

abstract def execute(): Unit

You can extract session data, request headers etc.

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def absUrl[T <: Action](implicit arg0: Manifest[T]): String

def absUrl[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String

def absUrl(params: (String, Any)*): String

lazy val absUrl: String

lazy val absUrlPrefix: String

lazy val absUrlPrefixWithoutScheme: String

def addConnectionClosedListener(listener: ⇒ Unit): Unit

def afterFilter(f: ⇒ Any): Unit

lazy val antiCsrfInput: Elem

lazy val antiCsrfMeta: Elem

def antiCsrfToken: String

def apply(handlerEnv: HandlerEnv): Unit

def aroundFilter(f: (() ⇒ Any) ⇒ Any): Unit

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

lazy val at: At

def atJson(key: String): String

def autosetLanguage(resourceLanguages: String*): Unit

If there's no suitable language, language is still the default "en".

def badRequestMessageInvalidInput(message: String): String

Applications may override this method to modify the default message: Validation error: + message

def badRequestMessageMissingParam(param: String): String

Applications may override this method to modify the default message: Missing param: + param

def badRequestMessageSessionExpired: String

Applications may override this method to modify the default message: Session expired. Please refresh your browser.

def basicAuth(realm: String)(authenticator: (String, String) ⇒ Boolean): Boolean

def beforeFilter(f: ⇒ Any): Unit

Adds a before filter.

lazy val bodyFileParams: FileUploadParams

File params in request body.

lazy val bodyTextParams: Params

Params in request body.

lazy val browserLanguages: Array[String]

def callAfterFilters(): Unit

Called by Dispatcher.

def callBeforeFilters(): Boolean

Called by Dispatcher.

def callExecuteWrappedInAroundFilters(): Unit

Called by Dispatcher

lazy val channel: Channel

def clone(): AnyRef

implicit val context: ActorContext

def convertTextParam[T](value: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

Applications may override this method to convert to more types.

implicit val currentAction: Action

This is convenient, for example, when you want to get the current action in view templates.

def dispatchWithFailsafe(skipCsrfCheck: Boolean): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executionContext: ExecutionContextExecutor

This is convenient, for example, when you use scala.concurrent.Future.

def finalize(): Unit

def flash(): String

Returns the current content in flash, and clears the flash.

def flash(msg: Any): Unit

def forwardTo(actionClass: Class[_ <: Action]): Unit

def forwardTo[T <: Action]()(implicit arg0: Manifest[T]): Unit

Example: forwardTo[AnotherActionClass]()

var forwarding: Boolean

Set to true by forwardTo.

def getActionClass[T <: Action](implicit arg0: Manifest[T]): Class[Action]

final def getClass(): Class[_]

var handlerEnv: HandlerEnv

def hashCode(): Int

lazy val isAjax: Boolean

def isDoneResponding: Boolean

final def isInstanceOf[T0]: Boolean

lazy val isSsl: Boolean

def js$(selector: String): String

def js$id(id: String): String

def js$name(name: String): String

def jsAddToView(js: Any): Unit

You can use this method to add dynamic JS snippets to a buffer, then use method jsForView to take out that buffer to embed the snippets to view template.

lazy val jsDefaults: Group

def jsEscape(string: Any): String

Do not use this to escape JSON, because they are different! For example JSON does not escape ' character, while JavaScript does.

lazy val jsForView: Serializable

See jsAddToView.

def jsRedirectTo[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): ChannelFuture

def jsRedirectTo(location: Any): ChannelFuture

See http://stackoverflow.com/questions/503093/how-can-i-make-a-redirect-page-in-jquery

def jsRenderFlash(): Unit

Like jsRenderFlash(msg), but uses the current flash.

def jsRenderFlash(msg: Any): Unit

For web 2.0 style application.

def jsRespond(fragments: Any*): ChannelFuture

def jsRespondFlash(msg: Any): Unit

For web 2.0 style application.

def language: String

Default language is "en".

def language_=(lang: String): Unit

Sets current language.

def layout: Any

lazy val log: Logger

Log name is inferred from name of the class extending this trait.

final def ne(arg0: AnyRef): Boolean

def newComponent[T <: Component]()(implicit arg0: Manifest[T]): T

final def notify(): Unit

final def notifyAll(): Unit

def onDoneResponding(): Unit

Called when the response or the last chunk (in case of chunked response) has been sent to the client.

def param[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T

def param[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T

def paramo[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]

def paramo[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]

def params[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]

def params[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]

lazy val pathParams: Params

Params embedded in the path.

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def publicUrl(directory: String, devPath: String, prodPath: String): String

Ex: publicUrl("jquery/2.2.4", "jquery.js", "jquery.min.js")

def publicUrl(devPath: String, prodPath: String): String

Ex: publicUrl("jquery.js", "jquery.min.js")

def publicUrl(path: String): String

Ex: publicUrl("jquery/2.2.4/jquery.js")

lazy val queryParams: Params

Params after the question mark of the URL.

def receive: PartialFunction[Any, Unit]

def redirectTo[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): ChannelFuture

Example: redirectTo[AnotherActionClass]()

def redirectTo(location: String, status: HttpResponseStatus = HttpResponseStatus.FOUND): ChannelFuture

Example: redirectTo("https://google.com/"); status will be 302 FOUND

def redirectToThis(params: (String, Any)*): ChannelFuture

Example: redirectToThis()

lazy val remoteIp: String

def renderEventSource(data: Any, event: String = "message"): String

def renderFragment[T <: Action](fragment: String)(implicit arg0: Manifest[T]): String

def renderFragment[T <: Action](fragment: String, options: Map[String, Any])(implicit arg0: Manifest[T]): String

def renderFragment(directory: Class[_ <: Action], fragment: String, options: Map[String, Any]): String

def renderFragment(directory: String, fragment: String): String

def renderFragment(directory: String, fragment: String, options: Map[String, Any]): String

def renderInlineView(inlineView: Any): String

def renderView[T <: Action]()(implicit arg0: Manifest[T]): String

def renderView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

def renderView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): String

def renderView[T <: Action](customLayout: () ⇒ Any, options: Map[String, Any])(implicit arg0: Manifest[T]): String

def renderView(customLayout: () ⇒ Any, location: Class[_ <: Action], options: Map[String, Any]): String

Renders the template associated with the location to "renderedView", then calls the layout function.

def renderView(location: String): String

def renderView(location: String, options: Map[String, Any]): String

def renderView(customLayout: () ⇒ Any, location: String): String

Renders the template associated with the location to "renderedView", then calls the layout function.

def renderView(customLayout: () ⇒ Any, location: String, options: Map[String, Any]): String

Renders the template associated with the location to "renderedView", then calls the layout function.

def renderViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): String

def renderViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

def renderViewNoLayout(location: Class[_ <: Action], options: Map[String, Any]): String

def renderViewNoLayout(location: String): String

def renderViewNoLayout(location: String, options: Map[String, Any]): String

var renderedView: Any

lazy val request: FullHttpRequest

lazy val requestContentJValue: JValue

The whole request body parsed as JSON4S JValue.

lazy val requestContentString: String

The whole request body as String.

lazy val requestCookies: Map[String, String]

Browsers will not send cookie attributes back to the server.

def respond(): ChannelFuture

def respond404Page(): Unit

def respond500Page(): Unit

def respondBinary(byteBuf: ByteBuf): ChannelFuture

If Content-Type header is not set, it is set to "application/octet-stream".

def respondBinary(bytes: Array[Byte]): ChannelFuture

If Content-Type header is not set, it is set to "application/octet-stream".

def respondDefault404Page(): ChannelFuture

def respondDefault500Page(): ChannelFuture

def respondEventSource(data: Any, event: String = "message"): ChannelFuture

To respond event source, call this method as many time as you want.

def respondFile(path: String): ChannelFuture

Sends a file using X-SendFile.

def respondHtml(any: Any): ChannelFuture

Content-Type header is set to "text/html".

def respondInlineView(inlineView: Any): ChannelFuture

Content-Type header is set to "text/html".

def respondJs(any: Any): ChannelFuture

Content-Type header is set to "application/javascript".

def respondJson(ref: AnyRef): ChannelFuture

Converts the given Scala object to JSON object, and responds it.

def respondJsonP(ref: AnyRef, function: String): ChannelFuture

Converts the given Scala object to JSON object, wraps it with the given JavaScript function name, and responds.

def respondJsonPText(text: Any, function: String): ChannelFuture

Wraps the text with the given JavaScript function name, and responds.

def respondJsonText(any: Any): ChannelFuture

Content-Type header is set to "application/json".

def respondLastChunk(trailingHeaders: HttpHeaders = EmptyHttpHeaders.INSTANCE): ChannelFuture

See setChunked.

def respondResource(path: String): ChannelFuture

Sends a file from public directory in one of the entry (may be a JAR file) in classpath.

def respondText(text: Any, fallbackContentType: String = null, convertXmlToXhtml: Boolean = true): ChannelFuture

def respondView[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture

def respondView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

def respondView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): ChannelFuture

def respondView[T <: Action](customLayout: () ⇒ Any, options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

def respondView(customLayout: () ⇒ Any, location: Class[_ <: Action], options: Map[String, Any]): ChannelFuture

def respondView(location: String): ChannelFuture

def respondView(location: String, options: Map[String, Any]): ChannelFuture

def respondView(customLayout: () ⇒ Any, location: String): ChannelFuture

def respondView(customLayout: () ⇒ Any, location: String, options: Map[String, Any]): ChannelFuture

def respondViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture

def respondViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

def respondViewNoLayout(location: Class[_ <: Action], options: Map[String, Any]): ChannelFuture

Content-Type header is set to "text/html".

def respondViewNoLayout(location: String): ChannelFuture

def respondViewNoLayout(location: String, options: Map[String, Any]): ChannelFuture

Content-Type header is set to "text/html".

def respondWebSocketBinary(byteBuf: ByteBuf): ChannelFuture

def respondWebSocketBinary(bytes: Array[Byte]): ChannelFuture

def respondWebSocketClose(): ChannelFuture

Connection is automatically closed.

def respondWebSocketJson(scalaObject: AnyRef): Unit

def respondWebSocketPing(): ChannelFuture

There's no respondWebSocketPong, because pong is automatically sent by Xitrum for you.

def respondWebSocketText(text: Any): ChannelFuture

def respondXml(any: Any): ChannelFuture

Content-Type header is set to "application/xml".

lazy val response: FullHttpResponse

lazy val responseCookies: ArrayBuffer[Cookie]

lazy val scheme: String

implicit final val self: ActorRef

final def sender(): ActorRef

lazy val serverName: String

lazy val serverPort: Int

lazy val session: Session

To reset session: session.clear()

def sessiono[T](key: String)(implicit d: DefaultsTo[T, String]): Option[T]

def setChunked(): Unit

To respond chunks (http://en.wikipedia.org/wiki/Chunked_transfer_encoding): 1.

def setClientCacheAggressively(): Unit

Tells the browser to cache static files for a long time.

def setCookieAndSessionIfTouchedOnRespond(): Unit

def setNoClientCache(): Unit

Prevents client cache.

def sockJsAbsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String

def sockJsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String

def supervisorStrategy: SupervisorStrategy

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

def t(singular: String): String

def tc(ctx: String, singular: String): String

def tcf(ctx: String, singular: String, args: Any*): String

def tcn(ctx: String, singular: String, plural: String, n: Long): String

def tcnf(ctx: String, singular: String, plural: String, n: Long, args: Any*): String

lazy val textParams: Params

The merge of all text params (queryParams, bodyParams, and pathParams), as contrast to file upload (bodyFileParams).

def tf(singular: String, args: Any*): String

implicit val timeout: FiniteDuration

This is convenient, for example, when you use scala.concurrent.Await.

def tn(singular: String, plural: String, n: Long): String

def tnf(singular: String, plural: String, n: Long, args: Any*): String

def toString(): String

def unhandled(message: Any): Unit

def url[T <: Action](implicit arg0: Manifest[T]): String

def url[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String

def url(params: (String, Any)*): String

lazy val url: String

lazy val urlParams: Params

The merge of queryParams and pathParams, things that appear in the request URL.

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def webJarsUrl(directory: String, devFile: String, prodFile: String): String

Ex: webJarsUrl("jquery/2.2.4", "jquery.js", "jquery.min.js")

def webJarsUrl(path: String): String

lazy val webSocketAbsRequestUrl: String

def webSocketAbsUrl[T <: WebSocketAction](implicit arg0: Manifest[T]): String

def webSocketAbsUrl[T <: WebSocketAction](params: (String, Any)*)(implicit arg0: Manifest[T]): String

def webSocketAbsUrl(params: (String, Any)*): String

lazy val webSocketAbsUrl: String

lazy val webSocketAbsUrlPrefix: String

lazy val webSocketScheme: String

lazy val xitrumCss: Elem