Responder

Value Members

1. final def !=(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

2. final def !=(arg0: Any): Boolean

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

5. final def ==(arg0: Any): Boolean

   Definition Classes

   Any

6. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7. def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

9. def equals(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

10. def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

11. def flash(): String

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

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

    Definition Classes

    Flash

12. def flash(msg: Any): Unit

    Definition Classes

    Flash

    See also

    jsFlash(msg).

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

    Definition Classes

    GetActionClassDefaultsToCurrentAction

14. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

15. def hashCode(): Int

    Definition Classes

    AnyRef → Any

16. lazy val isAjax: Boolean

    Definition Classes

    Js

17. def isDoneResponding: Boolean

18. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

19. def js$(selector: String): String

    Definition Classes

    Js

20. def js$id(id: String): String

    Definition Classes

    Js

21. def js$name(name: String): String

    Definition Classes

    Js

22. 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.

    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.

    Definition Classes

    Js

23. lazy val jsDefaults: Group

    Definition Classes

    Js

24. 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.

    Do not use this to escape JSON, because they are different! For example JSON does not escape ' character, while JavaScript does. To escape JSON, use xitrum.util.SeriDeseri.toJson(Seq(string)).

    org.apache.commons.lang3.StringEscapeUtils is used internally.

    Definition Classes

    Js

25. lazy val jsForView: Serializable

    See jsAddToView.

    See jsAddToView.

    Definition Classes

    Js

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

    Definition Classes

    Js

27. def jsRedirectTo(location: Any): ChannelFuture

    See http://stackoverflow.

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

    Definition Classes

    Js

28. def jsRenderFlash(): Unit

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

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

    Definition Classes

    Flash

29. def jsRenderFlash(msg: Any): Unit

    For web 2.

    For web 2.0 style application. Used in application layout to display the flash message right after a view is loaded.

    Definition Classes

    Flash

30. def jsRespond(fragments: Any*): ChannelFuture

    Definition Classes

    Js

31. def jsRespondFlash(msg: Any): Unit

    For web 2.

    For web 2.0 style application. Used in Ajax request handling to respond a message and have the browser render it to the flash area right away.

    Definition Classes

    Flash

32. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

33. final def notify(): Unit

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    Definition Classes

    AnyRef

35. def onDoneResponding(): Unit

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

36. def respond(): ChannelFuture

37. def respond404Page(): Unit

38. def respond500Page(): Unit

39. def respondBinary(byteBuf: ByteBuf): ChannelFuture

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

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

    byteBuf

    Will be released

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

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

41. def respondDefault404Page(): ChannelFuture

42. def respondDefault500Page(): ChannelFuture

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

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

    To respond event source, call this method as many time as you want. Event Source response is a special kind of chunked response, data must be UTF-8. See: - http://sockjs.github.com/sockjs-protocol/sockjs-protocol-0.3.3.html#section-94 - http://dev.w3.org/html5/eventsource/

    No need to call setChunked() before calling this method.

44. def respondFile(path: String): ChannelFuture

    Sends a file using X-SendFile.

    Sends a file using X-SendFile. If Content-Type header is not set, it is guessed from the file name.

    path

    absolute or relative to the current working directory

    In some cases, the current working directory is not always the root directory of the project (https://github.com/xitrum-framework/xitrum/issues/47), you may need to use xitrum.Config.root to calculate the correct absolute path from a relative path.

    To sanitize the path, use xitrum.util.PathSanitizer.

45. def respondHtml(any: Any): ChannelFuture

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

46. def respondInlineView(inlineView: Any): ChannelFuture

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

47. def respondJs(any: Any): ChannelFuture

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

48. def respondJson(ref: AnyRef): ChannelFuture

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

    Converts the given Scala object to JSON object, and responds it. If you just want to respond a text with "application/json" as content type, use respondJsonText(text).

    Content-Type header is set to "application/json". "text/json" would make the browser download instead of displaying the content. It makes debugging a pain.

49. 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.

    Converts the given Scala object to JSON object, wraps it with the given JavaScript function name, and responds. If you already have a JSON text, thus no conversion is needed, use respondJsonPText.

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

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

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

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

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

51. def respondJsonText(any: Any): ChannelFuture

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

52. def respondLastChunk(trailingHeaders: HttpHeaders = HttpHeaders.EMPTY_HEADERS): ChannelFuture

    See setChunked.

53. def respondResource(path: String): ChannelFuture

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

    Sends a file from public directory in one of the entry (may be a JAR file) in classpath. If Content-Type header is not set, it is guessed from the file name.

    path

    Relative to an entry in classpath, without leading "/"

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

    fallbackContentType

    Only used if Content-Type header has not been set. If not given and Content-Type header is not set, it is set to "application/xml" if text param is Node or NodeSeq, otherwise it is set to "text/plain".

    convertXmlToXhtml

    
    .toString by default returns
    
    which is rendered as 2
    tags on some browsers! Set to false if you really want XML, not XHTML. See http://www.scala-lang.org/node/492 and http://www.ne.jp/asahi/hishidama/home/tech/scala/xml.html

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

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

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

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

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

    options

    specific to the configured template engine

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

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

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

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

63. def respondXml(any: Any): ChannelFuture

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

64. def setChunked(): Unit

    To respond chunks (http://en.

    To respond chunks (http://en.wikipedia.org/wiki/Chunked_transfer_encoding): 1. Call setChunked() to mark that the response will be chunked 2. Call respondXXX as normal, but as many times as you want 3. Lastly, call respondLastChunk()

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

65. def setClientCacheAggressively(): Unit

66. def setNoClientCache(): Unit

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

    Definition Classes

    AnyRef

68. def toString(): String

    Definition Classes

    AnyRef → Any

69. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

71. final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

72. lazy val xitrumCss: Elem

    Definition Classes

    Flash