org.talares.api

Talares

class Talares extends AnyRef

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Talares
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. val cache: Cache

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def executeQuery[T <: Item](query: Query)(implicit jsonReadable: JsonReadable[T], classTag: ClassTag[T], seqClassTag: ClassTag[Seq[T]]): Future[Seq[T]]

    Fetches a 'T' by a org.talares.api.queries.Query.

    Fetches a 'T' by a org.talares.api.queries.Query.

    First composes a org.talares.api.actors.messages.MediatorMessages.QueryRequest from the given org.talares.api.queries.Query and the configured web service location. Then passes this to the org.talares.api.actors.Mediator for further handling. It does this using the ask pattern.

    Once complete, the result of the ask is inspected. If the result contains a value or a Seq of the expected type 'T', a promise is completed successfully and it's future returned. Otherwise the promise is failed with a org.talares.api.exceptions.TalaresException, either directly from the Future's result, or by wrapping a unknown Throwable in a org.talares.api.exceptions.TalaresException.

    T

    the type of item that is expected in return

    query

    the org.talares.api.queries.Query to compose the org.talares.api.actors.messages.MediatorMessages.QueryRequest with

    jsonReadable

    the org.talares.api.datatypes.JsonReadable which can turn the Json representation of a 'T' into an instance of 'T'

    classTag

    the class tag of 'T' to be injected by the compiler

    returns

    a future of 'T'

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. def getBinary(publicationId: Int, binaryId: Int): Future[Binary]

    Get a org.talares.api.datatypes.items.Binary by it's publication ID and it's binary ID.

    Get a org.talares.api.datatypes.items.Binary by it's publication ID and it's binary ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Binary belongs to

    binaryId

    the binary ID of the desired org.talares.api.datatypes.items.Binary

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Binary

  12. def getBinaryContent(publicationId: Int, binaryId: Int, variantId: String): Future[BinaryContent]

    Get a org.talares.api.datatypes.items.BinaryContent by it's publication ID, it's binary ID and it's variant ID.

    Get a org.talares.api.datatypes.items.BinaryContent by it's publication ID, it's binary ID and it's variant ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.BinaryContent belongs to

    binaryId

    the binary ID of the desired org.talares.api.datatypes.items.BinaryContent

    variantId

    the variantId ID of the desired org.talares.api.datatypes.items.BinaryContent

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.BinaryContent

  13. def getBinaryVariant(publicationId: Int, binaryId: Int): Future[BinaryVariant]

    Get a org.talares.api.datatypes.items.BinaryVariant by it's publication ID and it's binary ID.

    Get a org.talares.api.datatypes.items.BinaryVariant by it's publication ID and it's binary ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.BinaryVariant belongs to

    binaryId

    the binary ID of the desired org.talares.api.datatypes.items.BinaryVariant

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.BinaryVariant

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def getComponent(publicationId: Int, itemId: Int): Future[Component]

    Get a org.talares.api.datatypes.items.Component by it's publication ID and it's item ID.

    Get a org.talares.api.datatypes.items.Component by it's publication ID and it's item ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Component belongs to

    itemId

    the item ID of the desired org.talares.api.datatypes.items.Component

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Component

  16. def getComponentPresentation(publicationId: Int, componentId: Int, templateId: Int): Future[ComponentPresentation]

    Get a org.talares.api.datatypes.items.ComponentPresentation by it's publication ID, it's component ID and it's template ID.

    Get a org.talares.api.datatypes.items.ComponentPresentation by it's publication ID, it's component ID and it's template ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.ComponentPresentation belongs to

    componentId

    the component ID of the desired org.talares.api.datatypes.items.ComponentPresentation

    templateId

    the template ID of the desired org.talares.api.datatypes.items.ComponentPresentation

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.ComponentPresentation

  17. def getCustomMeta(id: Int): Future[CustomMeta]

    Get a org.talares.api.datatypes.items.CustomMeta by it's ID.

    Get a org.talares.api.datatypes.items.CustomMeta by it's ID.

    id

    the ID of the desired org.talares.api.datatypes.items.CustomMeta

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.CustomMeta

  18. def getKeyword(publicationId: Int, id: Int, taxonomyId: Int): Future[Keyword]

    Get a org.talares.api.datatypes.items.Keyword by it's ID, it's publication ID and it's taxonomy ID.

    Get a org.talares.api.datatypes.items.Keyword by it's ID, it's publication ID and it's taxonomy ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Keyword belongs to

    id

    the ID of the desired org.talares.api.datatypes.items.Keyword

    taxonomyId

    the taxonomy ID of the desired org.talares.api.datatypes.items.Keyword

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Keyword

  19. def getPage(url: String): Future[Seq[Page]]

    Get a org.talares.api.datatypes.items.Page by it's URL.

    Get a org.talares.api.datatypes.items.Page by it's URL.

    url

    the URL of the org.talares.api.datatypes.items.Page within the Tridion CMS.

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Page

  20. def getPage(publicationId: Int, itemId: Int): Future[Page]

    Get a org.talares.api.datatypes.items.Page by it's publication ID and it's item ID.

    Get a org.talares.api.datatypes.items.Page by it's publication ID and it's item ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Page belongs to

    itemId

    the item ID of the desired org.talares.api.datatypes.items.Page

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Page

  21. def getPageContent(publicationId: Int, pageId: Int): Future[PageContent]

    Get a org.talares.api.datatypes.items.PageContent by it's publication ID and it's page ID.

    Get a org.talares.api.datatypes.items.PageContent by it's publication ID and it's page ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.PageContent belongs to

    pageId

    the page ID of the desired org.talares.api.datatypes.items.PageContent

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.PageContent

  22. def getPublication(id: Int): Future[Publication]

    Get a org.talares.api.datatypes.items.Publication by it's ID

    Get a org.talares.api.datatypes.items.Publication by it's ID

    id

    the ID of the desired org.talares.api.datatypes.items.Publication

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Publication

  23. def getSchema(publicationId: Int, schemaId: Int): Future[Schema]

    Get a org.talares.api.datatypes.items.Schema by it's publication ID and it's schema ID.

    Get a org.talares.api.datatypes.items.Schema by it's publication ID and it's schema ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Schema belongs to

    schemaId

    the schema ID of the desired org.talares.api.datatypes.items.Schema

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Schema

  24. def getStructureGroup(publicationId: Int, id: Int): Future[StructureGroup]

    Get a org.talares.api.datatypes.items.StructureGroup by it's ID and it's publication ID.

    Get a org.talares.api.datatypes.items.StructureGroup by it's ID and it's publication ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.StructureGroup belongs to

    id

    the ID of the desired org.talares.api.datatypes.items.StructureGroup

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.StructureGroup

  25. def getTemplate(publicationId: Int, itemId: Int): Future[Template]

    Get a org.talares.api.datatypes.items.Template by it's publication ID and it's item ID.

    Get a org.talares.api.datatypes.items.Template by it's publication ID and it's item ID.

    publicationId

    the ID of the publication the desired org.talares.api.datatypes.items.Template belongs to

    itemId

    the item ID of the desired org.talares.api.datatypes.items.Template

    returns

    a successful or failed Future of a org.talares.api.datatypes.items.Template

  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  28. lazy val mediator: ActorRef

    The org.talares.api.actors.Mediator for use within the library.

    The org.talares.api.actors.Mediator for use within the library. *

  29. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  32. val settings: Settings

    Reference to the configured settings *

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  34. def terminate(): Unit

    Terminates the library which implies shutting down the actor system.

    Terminates the library which implies shutting down the actor system. Should be used when the API will no longer be accesses and only then.

  35. implicit val timeout: Timeout

    Timeout used by Akka when leveraging the aks pattern *

  36. def toString(): String

    Definition Classes
    AnyRef → Any

  37. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  39. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped