< Back
 

# Packages

-  package root
  Definition Classes
    root
-  package uk
  Definition Classes
    root
-  package gov
  Definition Classes
    uk
-  package hmrc
  Definition Classes
    gov
-  package mdtpauthorisation
  Definition Classes
    hmrc
-  package client
  Definition Classes
    mdtpauthorisation
-  package predicates
  Definition Classes
    client
-  package retrievals
  Definition Classes
    client
- CompositeRetrieval
- EmptyRetrieval
- OptionalRetrieval
- Retrieval
- Retrievals
- SimpleRetrieval
- ~
-  package syntax
  Definition Classes
    client

p

uk.gov.hmrc.mdtpauthorisation.client

# retrievals 

#### package retrievals

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  case class CompositeRetrieval[A, B](retrievalA: Retrieval[A], retrievalB: Retrieval[B]) extends Retrieval[~[A, B]] with Product with Serializable

   A Retrieval for two properties on successful authorisation

2.  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

   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

3.  trait Retrieval[A] extends AnyRef

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

4.  trait Retrievals extends AnyRef
5.  case class SimpleRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[A] with Product with Serializable

   A Retrieval that will return only a single property on successful authorisation

   A Retrieval that will return only a single 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

6.  case class ~[+A, +B](a: A, b: B) extends Product with Serializable

   Some type-trickery to allow composing of multiple retrievals at the call site

### Value Members

1.  object EmptyRetrieval extends Retrieval[Unit]

   Simple modelling of a Retrieval that returns nothing (would be a simple authorise-only call)

2.  object Retrievals extends Retrievals

### Ungrouped