api

Type Members

1. sealed case class Settings() extends Product with Serializable

   

   Convenience class holding all configuration values the library could need.

   Convenience class holding all configuration values the library could need.

   The settings are parsed from an .conf file present in the class path. Essential settings are checked for their presence and an IllegalArgumentException will be thrown if they are not.

   See also

   com.typesafe.config.ConfigFactory

2. class Talares extends AnyRef

   

   Class holding the main client facing API.

   Class holding the main client facing API.

   An instance of this class should be created to gain access to the API. A cache strategy should be decided upon and a corresponding instance of a subclass of org.talares.api.cache.Cache should be provided to the constructor of this class.

   Example:

   import org.talares.api.Talares
   import org.talares.api.datatypes.items.Page
   import scala.concurrent.Future
   
   val talares = Talares(cache)
   Future[Page] pageFuture = talares.getPage(1, 2)

   Since

   0.1.0

   See also

   org.talares.api.cache.Cache