org.talares.api.datatypes

items

package items

Since

0.1.0

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

Type Members

  1. case class Binary(metadata: Metadata, publicationId: Int, binaryId: Int, type: String, binaryVariants: DeferredSeq[BinaryVariant]) extends Item with Product with Serializable

    A Scala representation of a Binary content type.

    A Scala representation of a Binary content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Binaries(BinaryId=123,PublicationId=1)",
        "type": "Tridion.ContentDelivery.Binary"
      },
      "BinaryId": 123,
      "PublicationId": 1,
      "Type": "application/vnd.ms-fontobject",
      "BinaryVariants": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Binaries(BinaryId=123,PublicationId=1)/BinaryVariants"
        }
      }
    }
    Since

    0.1.0

  2. case class BinaryContent(metadata: Metadata, publicationId: Int, binaryId: Int, variantId: String) extends Item with Product with Serializable

    A Scala representation of a BinaryContent content type.

    A Scala representation of a BinaryContent content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Binaries(BinaryId=123,PublicationId=1)",
        "type": "Tridion.ContentDelivery.BinaryContent"
      },
      "BinaryId": 123,
      "PublicationId": 1,
      "VariantId": "123"
    }
    Since

    0.1.0

  3. case class BinaryVariant(metadata: Metadata, publicationId: Int, binaryId: Int, type: String, URLPath: String, isComponent: Boolean, path: String, variantId: String, description: Option[String], binary: Deferred[Binary]) extends Item with Product with Serializable

    A Scala representation of a BinaryVariant content type.

    A Scala representation of a BinaryVariant content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/BinaryVariants(BinaryId=123,PublicationId=1,VariantId='default')",
        "type": "Tridion.ContentDelivery.BinaryVariant"
      },
      "URLPath": "/dir/image.jpg",
      "BinaryId": 123,
      "Description": null,
      "IsComponent": true,
      "Path": "/dir/image.jpg",
      "PublicationId": 1,
      "Type": "image/jpeg",
      "VariantId": "default",
      "Binary": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/BinaryVariants(BinaryId=123,PublicationId=1,VariantId='default')/Binary"
        }
      }
    }
    Since

    0.1.0

  4. case class Component(metadata: Metadata, publicationId: Int, itemId: Int, title: Option[String], author: Option[String], creationDate: Option[DateTime], initialPublishDate: Option[DateTime], lastPublishDate: Option[DateTime], modificationDate: Option[DateTime], majorVersion: Option[Int], minorVersion: Option[Int], owningPublication: Option[Int], multimedia: Option[Boolean], schemaId: Int, schema: Deferred[Schema], componentPresentations: DeferredSeq[ComponentPresentation], keywords: DeferredSeq[Keyword], customMetas: DeferredSeq[CustomMeta]) extends Taxonomised with Product with Serializable

    A Scala representation of a Component content type.

    A Scala representation of a Component content type.

    Example Json:

     {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Components(ItemId=123,PublicationId=1)",
        "type": "Tridion.ContentDelivery.Component"
      },
      "Author": "User",
      "CreationDate": "/Date(1362655474000+60)/",
      "InitialPublishDate": "/Date(1374139562000+120)/",
      "Multimedia": false,
      "ItemId": 123,
      "LastPublishDate": "/Date(1374139562113+120)/",
      "MajorVersion": 1,
      "MinorVersion": 2,
      "ModificationDate": "/Date(1374139455000+120)/",
      "OwningPublication": 1,
      "PublicationId": 1,
      "SchemaId": 123,
      "Title": "component title",
      "Schema": {
        "__deferred": {
           "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Components(ItemId=123,PublicationId=1)/Schema"
        }
      },
      "ComponentPresentations": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Components(ItemId=123,PublicationId=1)/ComponentPresentations"
        }
      },
      "Keywords": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Components(ItemId=123,PublicationId=1)/Keywords"
        }
      },
      "CustomMetas": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Components(ItemId=123,PublicationId=1)/CustomMetas"
        }
      }
    }
    Since

    0.1.0

  5. case class ComponentPresentation(metadata: Metadata, publicationId: Int, componentId: Int, templateId: Int, outputFormat: String, presentationContent: String, component: Deferred[Component], template: Deferred[Template], pages: DeferredSeq[Page]) extends Item with Product with Serializable

    A Scala representation of a ComponentPresentation content type.

    A Scala representation of a ComponentPresentation content type.

    Example Json:

     {
       "__metadata": {
         "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)",
         "type": "Tridion.ContentDelivery.ComponentPresentation"
       },
       "ComponentId": 123,
       "OutputFormat": "HTML Fragment",
       "PresentationContent": "
    = Some content =
    ",
       "PublicationId": 1,
       "TemplateId": 123,
       "Component": {
        "__deferred": {
             "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Component"
         }
       },
       "Template": {
         "__deferred": {
           "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Template"
         }
       },
       "Pages": {
         "__deferred": {
            "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/ComponentPresentations(PublicationId=1,ComponentId=123,TemplateId=1234)/Pages"
         }
       }
     }
    Since

    0.1.0

  6. trait ComponentPresentationsHolder extends PublishedItem

    Items of this type hold a collection of ComponentPresentation's.

    Items of this type hold a collection of ComponentPresentation's.

    Since

    0.1.0

  7. case class CustomMeta(metadata: Metadata, publicationId: Int, itemId: Int, id: Int, itemType: Int, keyName: String, dateValue: Option[DateTime], floatValue: Option[Float], stringValue: Option[String], component: Deferred[Component], page: Deferred[Page], keyword: Deferred[Keyword]) extends Item with Product with Serializable

    A Scala representation of a CustomMeta content type.

    A Scala representation of a CustomMeta content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/CustomMetas(Id=12345)",
        "type": "Tridion.ContentDelivery.CustomMeta"
      },
      "DateValue": null,
      "FloatValue": null,
      "Id": 123,
      "ItemId": 123,
      "ItemType": 1,
      "KeyName": "key",
      "PublicationId": 1,
      "StringValue": "A String",
      "Component": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/CustomMetas(Id=12345)/Component"
        }
      },
      "Page": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/CustomMetas(Id=12345)/Page"
        }
      },
      "Keyword": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/CustomMetas(Id=12345)/Keyword"
        }
      }
    }
    Since

    0.1.0

  8. trait Item extends AnyRef

    The common trait for all concrete content type's.

    The common trait for all concrete content type's.

    Since

    0.1.0

  9. case class Keyword(metadata: Metadata, id: Int, publicationId: Int, taxonomyId: Int, title: String, description: Option[String], hasChildren: Boolean, isAbstract: Boolean, navigable: Boolean, key: Option[String], depth: Int, itemType: Int, totalRelatedItems: Option[Int], components: DeferredSeq[Component], pages: DeferredSeq[Page], customMetas: DeferredSeq[CustomMeta], children: DeferredSeq[Keyword], parent: Deferred[Keyword]) extends Item with Product with Serializable

    A Scala representation of a Keyword content type.

    A Scala representation of a Keyword content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(PublicationId=1,Id=2)",
        "type": "Tridion.ContentDelivery.Keyword"
      },
      "Id": 123,
      "PublicationId": 1,
      "TaxonomyId": 123,
      "Title": "A title",
      "Description": "A description",
      "HasChildren": false,
      "Abstract": false,
      "Navigable": false,
      "Key": "A key",
      "Depth": 0,
      "ItemType": 1,
      "TotalRelatedItems": 1,
      "Components": {
        "__deferred": {
            "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(Id=2,PublicationId=1)/Components"
        }
      },
      "Pages": {
        "__deferred": {
            "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(Id=2,PublicationId=1)/Pages"
        }
      },
      "CustomMetas": {
        "__deferred": {
            "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(Id=2,PublicationId=1)/CustomMetas"
        }
      },
      "Children": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(Id=2,PublicationId=1)/Children"
        }
      },
      "Parent": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Keywords(Id=2,PublicationId=1)/Parent"
        }
      }
    }
    Since

    0.1.0

  10. case class Page(metadata: Metadata, publicationId: Int, itemId: Int, templateId: Option[Int], title: Option[String], author: Option[String], creationDate: Option[DateTime], initialPublishDate: Option[DateTime], lastPublishDate: Option[DateTime], modificationDate: Option[DateTime], majorVersion: Option[Int], minorVersion: Option[Int], owningPublication: Option[Int], pagePath: Option[String], url: Option[String], pageContent: Deferred[PageContent], structureGroup: Deferred[StructureGroup], componentPresentations: DeferredSeq[ComponentPresentation], keywords: DeferredSeq[Keyword], customMetas: DeferredSeq[CustomMeta]) extends Taxonomised with Product with Serializable

    A Scala representation of a Page content type.

    A Scala representation of a Page content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)",
        "type": "Tridion.ContentDelivery.Page"
      },
      "Author": null,
      "CreationDate": "/Date(1362655241000+60)/",
      "InitialPublishDate": "/Date(1371220702600+120)/",
      "ItemId": 123,
      "LastPublishDate": "/Date(1371793702520+120)/",
      "MajorVersion": 1,
      "MinorVersion": 2,
      "ModificationDate": "/Date(1363341350000+60)/",
      "OwningPublication": 1,
      "PagePath": "/path/file.doc",
      "PublicationId": 1,
      "TemplateId": 123,
      "Title": "A File",
      "Url": "/path/file.doc",
      "PageContent": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)/PageContent"
        }
      },
      "StructureGroup": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)/StructureGroup"
        }
      },
      "ComponentPresentations": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)/ComponentPresentations"
        }
      },
      "Keywords": {
       "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)/Keywords"
        }
      },
      "CustomMetas": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Pages(ItemId=123,PublicationId=1)/CustomMetas"
        }
      }
    }
    Since

    0.1.0

  11. case class PageContent(metadata: Metadata, publicationId: Int, pageId: Int, charset: Option[String], content: Option[String], page: Deferred[Page]) extends Item with Product with Serializable

    A Scala representation of a PageContent content type.

    A Scala representation of a PageContent content type.

    Example Json:

     {
       "__metadata": {
         "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/PageContents(PageId=123,PublicationId=1)",
         "type": "Tridion.ContentDelivery.PageContent"
       },
       "CharSet": "UTF8",
       "Content": "
    = Some content =
    ",
       "PageId": 123,
       "PublicationId": 1,
       "Page": {
         "__deferred": {
           "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/PageContents(PageId=123,PublicationId=1)/Page"
         }
       }
     }
    Since

    0.1.0

  12. case class Publication(metadata: Metadata, id: Int, key: Option[String], multimediaPath: Option[String], multimediaUrl: Option[String], publicationPath: Option[String], publicationUrl: Option[String], title: Option[String], schemas: DeferredSeq[Schema], componentPresentations: DeferredSeq[ComponentPresentation], keywords: DeferredSeq[Keyword], binaries: DeferredSeq[Binary], binaryVariants: DeferredSeq[BinaryVariant], components: DeferredSeq[Component], customMetas: DeferredSeq[CustomMeta], pages: DeferredSeq[Page], pageContents: DeferredSeq[PageContent], structureGroups: DeferredSeq[StructureGroup], templates: DeferredSeq[Template]) extends Item with Product with Serializable

    A Scala representation of a Publication content type.

    A Scala representation of a Publication content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)",
        "type": "Tridion.ContentDelivery.Publication"
      },
      "Id": 1,
      "Key": "A key",
      "MultimediaPath": "\\Multimedia",
      "MultimediaUrl": "/Multimedia",
      "PublicationPath": "\\",
      "PublicationUrl": "/",
      "Title": "A title",
      "Schemas": {
        "__deferred": {
             "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Schemas"
        }
      },
      "ComponentPresentations": {
       "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/ComponentPresentations"
        }
      },
      "Keywords": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Keywords"
        }
      },
      "Binaries": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Binaries"
         }
      },
      "BinaryVariants": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/BinaryVariants"
        }
      },
      "Components": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Components"
        }
      },
      "CustomMetas": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/CustomMetas"
        }
      },
      "Pages": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Pages"
        }
      },
      "PageContents": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/PageContents"
        }
      },
      "StructureGroups": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/StructureGroups"
        }
      },
      "Templates": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Publications(1)/Templates"
        }
      }
    }
    Since

    0.1.0

  13. trait PublishedItem extends Item

    Items of this type represent versioned pieces of content.

    Items of this type represent versioned pieces of content.

    Since

    0.1.0

  14. case class Schema(metadata: Metadata, publicationId: Int, schemaId: Int, title: String, components: DeferredSeq[Component]) extends Item with Product with Serializable

    A Scala representation of a Schema content type.

    A Scala representation of a Schema content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Schemas(SchemaId=123,PublicationId=1)",
        "type": "Tridion.ContentDelivery.Schema"
      },
      "PublicationId": 1,
      "SchemaId": 123,
      "Title": "A title",
      "Components": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Schemas(SchemaId=123,PublicationId=1)/Components"
        }
      }
    }
    Since

    0.1.0

  15. case class StructureGroup(metadata: Metadata, publicationId: Int, id: Int, title: String, depth: Int, directory: Option[String], pages: DeferredSeq[Page], parent: Deferred[StructureGroup], children: DeferredSeq[StructureGroup]) extends Item with Product with Serializable

    A Scala representation of a StructureGroup content type.

    A Scala representation of a StructureGroup content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(PublicationId=1,Id=2)",
        "type": "Tridion.ContentDelivery.StructureGroup"
      },
      "Depth": 0,
      "Directory": null,
      "Id": 123,
      "PublicationId": 1,
      "Title": "A title",
      "Pages": {
        "__deferred": {
            "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Pages"
        }
      },
      "Children": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Children"
        }
      },
      "Parent": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/StructureGroups(Id=2,PublicationId=1)/Parent"
        }
      }
    }
    Since

    0.1.0

  16. trait Taxonomised extends ComponentPresentationsHolder

    Item's of this type can be tagged using keywords or custom meta data.

    Item's of this type can be tagged using keywords or custom meta data.

    Since

    0.1.0

  17. case class Template(metadata: Metadata, publicationId: Int, itemId: Int, title: Option[String], author: Option[String], creationDate: Option[DateTime], initialPublishDate: Option[DateTime], lastPublishDate: Option[DateTime], modificationDate: Option[DateTime], majorVersion: Option[Int], minorVersion: Option[Int], owningPublication: Option[Int], outputFormat: String, templatePriority: Int, componentPresentations: DeferredSeq[ComponentPresentation]) extends ComponentPresentationsHolder with Product with Serializable

    A Scala representation of a Template content type.

    A Scala representation of a Template content type.

    Example Json:

    {
      "__metadata": {
        "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Templates(PublicationId=1,ItemId=123)",
        "type": "Tridion.ContentDelivery.Template"
      },
      "Author": "User",
      "CreationDate": "/Date(1399546761343+120)/",
      "InitialPublishDate": "/Date(1399546761343+120)/",
      "ItemId": 123,
      "LastPublishDate": "/Date(1399546761343+120)/",
      "MajorVersion": 1,
      "MinorVersion": 2,
      "ModificationDate": "/Date(1399546761343+120)/",
      "OutputFormat": "HTML Fragment",
      "OwningPublication": 0,
      "PublicationId": 1,
      "TemplatePriority": 200,
      "Title": "A title",
      "ComponentPresentations": {
        "__deferred": {
          "uri": "http://127.0.0.1:8080/cd_webservice/odata.svc/Templates(PublicationId=1,ItemId=123)/ComponentPresentations"
        }
      }
    }
    Since

    0.1.0

Value Members

  1. object Binary extends Serializable

  2. object BinaryContent extends Serializable

  3. object BinaryVariant extends Serializable

  4. object Component extends Serializable

  5. object ComponentPresentation extends Serializable

  6. object CustomMeta extends Serializable

  7. implicit object EdmDateTimeReads extends Reads[DateTime]

  8. object Keyword extends Serializable

  9. object Page extends Serializable

  10. object PageContent extends Serializable

  11. object Publication extends Serializable

  12. object Schema extends Serializable

  13. object StructureGroup extends Serializable

  14. object Template extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped