Interface Inx_Api_DesignTemplate_DesignCollection

Description

An Inx_Api_DesignTemplate_DesignCollection represents a set of templates which are stored in an itc file.

An Inx_Api_DesignTemplate_DesignCollection represents a set of templates which are stored in an itc file. Templates can be used to create complex multipart mailings which are based on a common structure defined by the template. Templates simplify the creation of such mailings by using a specialized editor which aids in the structuring of the mailing. The following design collection data can be retrieved:

  • Collection name: the technical name of the design collection.
  • Display name: the display name of the design collection.
  • Collection vendor: the name of the design collection vendor.
  • Vendor URL: the uniform resource locator (URL) of the vendor (i.e. the vendors web site).
  • Collection version: the version of the design collection.
  • Last modification date: the date when the design collection was imported (the last time).
  • Contained templates: the templates contained by the design collection.

Note: All data provided by Inx_Api_DesignTemplate_DesignCollection is read only!

For an example on how to import and use design collections, see the Inx_Api_DesignTemplate_DesignCollectionManager documentation.

Located in /Api/DesignTemplate/DesignCollection.php (line 34)

Inx_Api_BusinessObject
   |
   --Inx_Api_DesignTemplate_DesignCollection
Method Summary
string getDisplayName ()
string getName ()
an getTemplates ()
string getVendor ()
string getVendorURL ()
string getVersion ()
Methods
getDisplayName (line 49)

Returns the display name of the design collection.

Returns the display name of the design collection.

  • return: the display name of the design collection.
  • since: API 1.9.0
  • access: public
string getDisplayName ()
getLastModificationDate (line 78)

Returns the date when the design collection was imported (the last time).

Returns the date when the design collection was imported (the last time).

  • return: the date of the last modification of the design collection. The date will be returned as ISO 8601 formatted datetime string.
  • access: public
string getLastModificationDate ()
getName (line 41)

Returns the technical name of the design collection.

Returns the technical name of the design collection.

  • return: the technical name of the design collection.
  • access: public
string getName ()
getTemplates (line 85)

Returns all templates contained by this design collection.

Returns all templates contained by this design collection.

  • return: array of all Inx_Api_DesignTemplate_Templates contained by this design collection.
  • access: public
an getTemplates ()
getVendor (line 56)

Returns the name of the design collection vendor.

Returns the name of the design collection vendor.

  • return: the name of the design collection vendor.
  • access: public
string getVendor ()
getVendorURL (line 63)

Returns the uniform resource locator (URL) of the vendor (i.

Returns the uniform resource locator (URL) of the vendor (i.e. the vendors web site).

  • return: the URL of the design collection vendor.
  • access: public
string getVendorURL ()
getVersion (line 70)

Returns the version of the design collection.

Returns the version of the design collection.

  • return: the version of the design collection.
  • access: public
string getVersion ()

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()

Documentation generated on Thu, 17 Sep 2015 14:27:24 +0200 by phpDocumentor 1.3.2