play.api.rest

api

Related Doc: package rest

object api extends RootRouter

Linear Supertypes
RootRouter, URLMatchers, core.Router.Routes, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. api
  2. RootRouter
  3. URLMatchers
  4. Routes
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class Endpoint extends AnyRef

    Definition Classes
    URLMatchers

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def /(name: String): NestedEndpoint

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

    Definition Classes
    AnyRef → Any

  5. object DELETE extends Endpoint

    Definition Classes
    URLMatchers

  6. object GET extends Endpoint

    Definition Classes
    URLMatchers

  7. object HEAD extends Endpoint

    Definition Classes
    URLMatchers

  8. object Id

    Extracts resource identification from the path beginning

    Extracts resource identification from the path beginning

    Definition Classes
    URLMatchers

  9. object LIST

    Definition Classes
    URLMatchers

  10. object Namespace

    Verifies if the requests matches any of known resources

    Verifies if the requests matches any of known resources

    Definition Classes
    URLMatchers

  11. object NestedResource

    Verifies if the requests matches any of known resources

    Verifies if the requests matches any of known resources

    Definition Classes
    URLMatchers

  12. object OPTIONS extends Endpoint

    Definition Classes
    URLMatchers

  13. object PATCH extends Endpoint

    Definition Classes
    URLMatchers

  14. object POST

    Definition Classes
    URLMatchers

  15. object PUT extends Endpoint

    Definition Classes
    URLMatchers

  16. object Path

    Extracts path from the request

    Extracts path from the request

    Definition Classes
    URLMatchers

  17. object PathEnd

    Verifies that the request points to nothing

    Verifies that the request points to nothing

    Definition Classes
    URLMatchers

  18. object Prefix

    Verifies router prefix if matches expectation

    Verifies router prefix if matches expectation

    Definition Classes
    URLMatchers

  19. object Resource

    Checks the requests ends at given resource id

    Checks the requests ends at given resource id

    Definition Classes
    URLMatchers

  20. var _prefix: String

    Attributes
    protected
    Definition Classes
    RootRouter

  21. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  22. def attach(resource: String, router: ResourceRouter[_, Handler]): Unit

    Definition Classes
    RootRouter

  23. def badRequest(error: String): Action[AnyContent]

    Definition Classes
    Routes

  24. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16], pa17: Param[A17], pa18: Param[A18], pa19: Param[A19], pa20: Param[A20], pa21: Param[A21])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) ⇒ Handler): Handler

    Definition Classes
    Routes

  25. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16], pa17: Param[A17], pa18: Param[A18], pa19: Param[A19], pa20: Param[A20])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) ⇒ Handler): Handler

    Definition Classes
    Routes

  26. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16], pa17: Param[A17], pa18: Param[A18], pa19: Param[A19])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) ⇒ Handler): Handler

    Definition Classes
    Routes

  27. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16], pa17: Param[A17], pa18: Param[A18])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) ⇒ Handler): Handler

    Definition Classes
    Routes

  28. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16], pa17: Param[A17])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) ⇒ Handler): Handler

    Definition Classes
    Routes

  29. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15], pa16: Param[A16])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) ⇒ Handler): Handler

    Definition Classes
    Routes

  30. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14], pa15: Param[A15])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) ⇒ Handler): Handler

    Definition Classes
    Routes

  31. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13], pa14: Param[A14])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) ⇒ Handler): Handler

    Definition Classes
    Routes

  32. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12], pa13: Param[A13])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) ⇒ Handler): Handler

    Definition Classes
    Routes

  33. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11], pa12: Param[A12])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) ⇒ Handler): Handler

    Definition Classes
    Routes

  34. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10], pa11: Param[A11])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) ⇒ Handler): Handler

    Definition Classes
    Routes

  35. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9], pa10: Param[A10])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) ⇒ Handler): Handler

    Definition Classes
    Routes

  36. def call[A1, A2, A3, A4, A5, A6, A7, A8, A9](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8], pa9: Param[A9])(generator: (A1, A2, A3, A4, A5, A6, A7, A8, A9) ⇒ Handler): Handler

    Definition Classes
    Routes

  37. def call[A1, A2, A3, A4, A5, A6, A7, A8](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7], pa8: Param[A8])(generator: (A1, A2, A3, A4, A5, A6, A7, A8) ⇒ Handler): Handler

    Definition Classes
    Routes

  38. def call[A1, A2, A3, A4, A5, A6, A7](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6], pa7: Param[A7])(generator: (A1, A2, A3, A4, A5, A6, A7) ⇒ Handler): Handler

    Definition Classes
    Routes

  39. def call[A1, A2, A3, A4, A5, A6](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5], pa6: Param[A6])(generator: (A1, A2, A3, A4, A5, A6) ⇒ Handler): Handler

    Definition Classes
    Routes

  40. def call[A1, A2, A3, A4, A5](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4], pa5: Param[A5])(generator: (A1, A2, A3, A4, A5) ⇒ Handler): Handler

    Definition Classes
    Routes

  41. def call[A1, A2, A3, A4](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3], pa4: Param[A4])(generator: (A1, A2, A3, A4) ⇒ Handler): Handler

    Definition Classes
    Routes

  42. def call[A1, A2, A3](pa1: Param[A1], pa2: Param[A2], pa3: Param[A3])(generator: (A1, A2, A3) ⇒ Handler): Handler

    Definition Classes
    Routes

  43. def call[A1, A2](pa1: Param[A1], pa2: Param[A2])(generator: (A1, A2) ⇒ Handler): Handler

    Definition Classes
    Routes

  44. def call[P](pa: Param[P])(generator: (P) ⇒ Handler): Handler

    Definition Classes
    Routes

  45. def call(generator: ⇒ Handler): Handler

    Definition Classes
    Routes

  46. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. def createInvoker[T](fakeCall: ⇒ T, handlerDef: HandlerDef)(implicit hif: HandlerInvokerFactory[T]): HandlerInvoker[T]

    Definition Classes
    Routes

  48. def documentation: Seq[(String, String, String)]

    Definition Classes
    RootRouter → Routes

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

    Definition Classes
    AnyRef

  50. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  51. def fakeValue[A]: A

    Definition Classes
    Routes

  52. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  54. def handlerFor(request: RequestHeader): Option[Handler]

    Definition Classes
    Routes

  55. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  56. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  57. def isResource(resource: String, request: RequestHeader): Boolean

    Attributes
    protected
    Definition Classes
    RootRouter → URLMatchers

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

    Definition Classes
    AnyRef

  59. final def notify(): Unit

    Definition Classes
    AnyRef

  60. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  61. object on

    Extracts the method from the request

    Extracts the method from the request

    Definition Classes
    URLMatchers

  62. def prefix: String

    Definition Classes
    RootRouter → URLMatchers → Routes

  63. val routes: PartialFunction[RequestHeader, Handler]

    Definition Classes
    RootRouter → Routes

  64. def setPrefix(prefix: String): Unit

    Definition Classes
    RootRouter → Routes

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

    Definition Classes
    AnyRef

  66. def toString(): String

    Definition Classes
    AnyRef → Any

  67. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RootRouter

Inherited from URLMatchers

Inherited from core.Router.Routes

Inherited from AnyRef

Inherited from Any

Ungrouped