Trait

endpoints.xhr

BasicAuthentication

Related Doc: package xhr

Permalink

trait BasicAuthentication extends algebra.BasicAuthentication with EndpointsWithCustomErrors

Source
BasicAuthentication.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicAuthentication
  2. EndpointsWithCustomErrors
  3. StatusCodes
  4. Methods
  5. Urls
  6. BasicAuthentication
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class CallbackDocs extends Product with Serializable

    Permalink
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract type ClientErrors

    Permalink
    Definition Classes
    Errors
  4. abstract class Endpoint[A, B] extends AnyRef

    Permalink

    A function that takes the information needed to build a request and returns a task yielding the information carried by the response.

    A function that takes the information needed to build a request and returns a task yielding the information carried by the response.

    Definition Classes
    EndpointsWithCustomErrors
  5. case class EndpointDocs extends Product with Serializable

    Permalink
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    InvariantFunctorSyntax
  7. type Method = String

    Permalink
    Definition Classes
    Methods → Methods
  8. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax
  9. trait Path[A] extends Url[A]

    Permalink

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  10. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  11. trait QueryString[A] extends AnyRef

    Permalink

    Defines how to build a query string from an A

    Defines how to build a query string from an A

    Definition Classes
    Urls
  12. trait QueryStringParam[A] extends AnyRef

    Permalink

    Defines how to build a query string parameter value from an A

    Defines how to build a query string parameter value from an A

    Definition Classes
    Urls
  13. implicit class QueryStringSyntax[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  14. trait Request[A] extends AnyRef

    Permalink

    A function that takes the information A and returns an XMLHttpRequest with an optional request entity.

    A function that takes the information A and returns an XMLHttpRequest with an optional request entity. If provided, the request entity must be compatible with the send method of XMLHttpRequest.

    Definition Classes
    EndpointsWithCustomErrors
  15. type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]

    Permalink

    A function that, given information A and an XMLHttpRequest, returns a request entity.

    A function that, given information A and an XMLHttpRequest, returns a request entity. Also, as a side-effect, the function can set the corresponding Content-Type header on the given XMLHttpRequest.

    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]

    Permalink

    A function that takes the information A and the XMLHttpRequest and sets up some headers on it.

    A function that takes the information A and the XMLHttpRequest and sets up some headers on it.

    Definition Classes
    EndpointsWithCustomErrors → Requests
  17. type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]

    Permalink

    Attempts to decode an A from an XMLHttpRequest’s response

    Attempts to decode an A from an XMLHttpRequest’s response

    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. implicit class ResponseSyntax[A] extends AnyRef

    Permalink
    Definition Classes
    Responses
  20. abstract type Result[A]

    Permalink

    A value that eventually yields an A.

    A value that eventually yields an A.

    Typically, concrete representation of Result will have an instance of MonadError, so that we can perform requests (sequentially and in parallel) and recover errors.

    Definition Classes
    EndpointsWithCustomErrors
  21. trait Segment[A] extends AnyRef

    Permalink

    Defines how to build a path segment from an A

    Defines how to build a path segment from an A

    Definition Classes
    Urls
  22. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    SemigroupalSyntax
  23. abstract type ServerError

    Permalink
    Definition Classes
    Errors
  24. type StatusCode = Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  25. trait Url[A] extends AnyRef

    Permalink

    Builds an URL from an A

    Builds an URL from an A

    Definition Classes
    Urls

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]

    Permalink
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

    Permalink
    Definition Classes
    Errors
  3. abstract def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors

    Permalink
    Definition Classes
    Errors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]

    Permalink
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable

    Permalink
    Definition Classes
    Errors
  7. abstract def throwableToServerError(throwable: Throwable): ServerError

    Permalink
    Definition Classes
    Errors

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def Accepted: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: String

    Permalink
    Definition Classes
    Methods → Methods
  8. def Forbidden: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  9. def Get: String

    Permalink
    Definition Classes
    Methods → Methods
  10. def InternalServerError: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  11. def NoContent: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  12. def NotFound: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotImplemented: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  14. def OK: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  15. def Options: String

    Permalink
    Definition Classes
    Methods → Methods
  16. def Patch: String

    Permalink
    Definition Classes
    Methods → Methods
  17. def Post: String

    Permalink
    Definition Classes
    Methods → Methods
  18. def Put: String

    Permalink
    Definition Classes
    Methods → Methods
  19. def Unauthorized: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  20. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  21. def authenticatedEndpoint[U, E, R, H, UE, HCred, Out](method: Method, url: Url[U], response: Response[R], requestEntity: RequestEntity[E], requestHeaders: RequestHeaders[H], unauthenticatedDocs: Documentation, requestDocs: Documentation, endpointDocs: EndpointDocs)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerHCred: Tupler.Aux[H, Credentials, HCred], tuplerUEHCred: Tupler.Aux[UE, HCred, Out]): Endpoint[Out, Option[R]]

    Permalink
    Definition Classes
    BasicAuthentication
  22. final def badRequest(docs: Documentation): Response[ClientErrors]

    Permalink
    Definition Classes
    Responses
  23. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls
  24. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Permalink
    Definition Classes
    Urls → Urls
  25. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Responses
  26. lazy val clientErrorsResponse: Response[ClientErrors]

    Permalink
    Definition Classes
    Errors
  27. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Permalink
    Definition Classes
    Urls → Urls
  29. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests
  30. implicit def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls
  31. implicit def doubleSegment: Segment[Double]

    Permalink
    Definition Classes
    Urls
  32. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Permalink
    Definition Classes
    Urls
  33. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink

    Sets up no headers on the given XMLHttpRequest

    Sets up no headers on the given XMLHttpRequest

    Definition Classes
    EndpointsWithCustomErrors → Requests
  34. lazy val emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  35. def emptyResponse: ResponseEntity[Unit]

    Permalink

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  36. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  38. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests
  40. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. def header(name: String, docs: Documentation): RequestHeaders[String]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  43. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls
  44. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls
  45. final def internalServerError(docs: Documentation): Response[ServerError]

    Permalink
    Definition Classes
    Responses
  46. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  47. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls
  48. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls
  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  51. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  52. final def ok[A](entity: ResponseEntity[A], docs: Documentation): Response[A]

    Permalink
    Definition Classes
    Responses
  53. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  54. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls
  55. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls
  56. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls
  57. final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  58. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests
  59. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests
  60. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

    Permalink
    Definition Classes
    Urls → Urls
  61. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls
  62. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls
  63. def remainingSegments(name: String, docs: Documentation): Path[String]

    Permalink
    Definition Classes
    Urls → Urls
  64. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Permalink
    Definition Classes
    Urls → Urls
  65. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  66. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  67. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  68. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  69. def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None): Response[A]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Responses
  70. implicit lazy val responseInvFunctor: InvariantFunctor[Response]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Responses
  71. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

    Permalink
    Definition Classes
    Urls → Urls
  72. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls
  73. lazy val serverErrorResponse: Response[ServerError]

    Permalink
    Definition Classes
    Errors
  74. def staticPathSegment(segment: String): Path[Unit] with Serializable

    Permalink
    Definition Classes
    Urls → Urls
  75. def stringCodecResponse[A](implicit codec: Codec[String, A]): ResponseEntity[A]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors
  76. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls
  77. implicit lazy val stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  79. lazy val textRequest: RequestEntity[String]

    Permalink
    Definition Classes
    EndpointsWithCustomErrors → Requests
  80. def textResponse: ResponseEntity[String]

    Permalink

    Decodes a text entity

    Decodes a text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  81. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  82. def tryParseString[A](type: String)(parse: (String) ⇒ A): (String) ⇒ Validated[A]

    Permalink
    Definition Classes
    Urls
  83. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls
  84. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Permalink
    Definition Classes
    Urls → Urls
  85. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls
  86. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls
  87. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]

    Permalink
    Definition Classes
    Responses

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.BasicAuthentication

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped