case class OptionalRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[Option[A]] with Product with Serializable
A Retrieval that will return only a single, optional property on successful authorisation
- propertyName
The name of the property to return from auth on success. Must be a supported property in auth.
- valueReads
The JSON Reads to apply to the returned JSON property in case it is present
- Alphabetic
- By Inheritance
- OptionalRetrieval
- Serializable
- Product
- Equals
- Retrieval
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new OptionalRetrieval(propertyName: String, valueReads: Reads[A])
- propertyName
The name of the property to return from auth on success. Must be a supported property in auth.
- valueReads
The JSON Reads to apply to the returned JSON property in case it is present
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def and[B](other: Retrieval[B]): Retrieval[~[Option[A], B]]
Allows simpler and more concise code for the lib user at the call site when authorising
Allows simpler and more concise code for the lib user at the call site when authorising
- other
The Retrieval to be joined with this Retrieval
- returns
A Retrieval[A ~ B] that contains this Retrieval and the one passed in
- Definition Classes
- Retrieval
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val propertyName: String
- val propertyNames: Seq[String]
The properties to return from a successful authorise call.
The properties to return from a successful authorise call. These have to be explicitly supported by the auth service being called
- returns
A list of property names to return.
- Definition Classes
- OptionalRetrieval → Retrieval
- val reads: Reads[Option[A]]
The Reads that will be used upon the returned JSON
The Reads that will be used upon the returned JSON
- returns
JSON Reads
- Definition Classes
- OptionalRetrieval → Retrieval
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val valueReads: Reads[A]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()