Retrieval

uk.gov.hmrc.auth.core.retrieve.Retrieval
trait Retrieval[A]

A typed class that models what will be returned from auth upon a successful authorisation call

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def propertyNames: Seq[String]

The properties to return from a successful authorise call. These have to be explicitly supported by the auth service being called

The properties to return from a successful authorise call. These have to be explicitly supported by the auth service being called

Attributes

Returns

A list of property names to return.

def reads: Reads[A]

The Reads that will be used upon the returned JSON

The Reads that will be used upon the returned JSON

Attributes

Returns

JSON Reads

Concrete methods

def and[B](other: Retrieval[B]): Retrieval[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

Value parameters

other

The Retrieval to be joined with this Retrieval

Attributes

Returns

A Retrieval[A ~ B] that contains this Retrieval and the one passed in