Global resources allow to retrieve global settings for the product.
The info resource allows to retrieve information about the Infigo storefront in general.
Returns the media item which represents the avatar image for the current customer (if any). The avatar image is managed via the customer account page and is always available in the special album which is hidden from the UI.
The callback function that will be called once the media item is retrieved. If no avatar image is available, the callback will be called with null.
Retrieve all background categories.
The callback function that will be called once the categories are retrieved.
Retrieve all background items within a category.
The background category or the id.
The callback function that will be called once the background items are retrieved.
Retrieve all configured clipart albums.
The callback function that will be called once the albums are retrieved.
Shortcut helper function to retrieve a clipart item directly in a single call by the names of the clipart album and the clipart item.
The name of the clipart album for the item to retrieve.
The name of the clipart item to retrieve.
The callback function that will be called once the clipart item is retrieved. If the item is not found, the callback will be called with null.
Retrieve all clipart items within an album.
The clipart album or the id.
The callback function that will be called once the clipart items are retrieved.
Create a new media album with the given name. The name must be unique per user and the process will fail if the name is already in use.
The new name of the media album.
The callback function that will be called once the album is created. The callback will be called with the newly created album object.
Deletes the media item with the given id. Note that not all media items can be deleted and the response should be checked.
The media item id to delete.
Optional callback: ((response) => void)Callback function that will be called once the media item is deleted.
Load all available fonts for the current setup.
The callback function that will be called once the fonts are retrieved.
Retrieve all layout categories, optionally filtered by a page tag. You can tag layouts to be available for specific pages only via the template configuration. Those prefiltered lists can be retrieved via this method.
The layout categories are returned via the callback function.
Optional tag: stringIf not specified all layout categories are returned. Otherwise it will be the ones linked ot that specified page tag
Retrieve the layout items within the category.
The layout category or the id.
The callback function that will be called once the layout items are retrieved.
Load all mask albums. Mask albums are used for image fields.
The callback function that will be called once the albums are retrieved.
Retrieve all available media albums the user has access to. There are hidden albums which are not shown in the UI. By default this method will not return those, but via an additional flag they can be included. There is always at least one hidden album for special media (e.g. Avatar images).
The callback function that will be called once the albums are retrieved.
Optional includeHidden: booleanOptional flag, if set to true, hidden albums will be included in the result. Default value is false.
Retrieve child media items for a given media item. This is used for multi page images (e.g. PDF files) when extracting all pages is enabled. Then the first page will be the default media item within the album, the subsequent pages will be child items.
The parent media item - aka the first page
Returns the child media items for the given parent media item. If this is only a single page document, the callback will be called with an empty array.
Retrieve all media items within a given album, optionally filtered by the given filter object.
The album object or id to retrieve the media items for.
The callback function that will be called once the media items are retrieved.
Optional filter: MediaItemFilterOptional filter object to filter the media items.
Load all placeholder categories. Placeholder categories are used for image fields to render an image if the field has no value. Currently a product can have only one placeholder category to be used within the UI.
The callback function that will be called once the categories are retrieved.
Load all placeholder items within a placeholder category.
The placeholder category or the id.
The callback function that will be called once the items are retrieved.
Returns the special album - a hidden album used for internal media items like avatar images.
The callback function that will be called once the album is retrieved.
Retrieve all spot color albums.
The callback function that will be called once the albums are retrieved.
Retrieve all spot color items within an album..
The spot color album or id.
The callback function that will be called once the spot colors are retrieved.
Uploads a media item directly. The item is fully specified in this call via:
The same upload restrictions apply as for the regular upload.
The album to upload the media item to.
The mime type of the file. E.g. 'image/gif', 'image/jpeg', 'image/png', 'application/pdf', etc.
The base 64 encoded data of the image to upload.
The filename of the image to upload.
The callback will be called once the upload is finished. The callback will be called with the newly created media item or null if it failed. It will also optionally contain a preflight info object.
Upload a media item. This triggers the upload dialog for a single upload. This will upload into the default album.
The editor supports the following file types:
[Unsupported]: the album parameter is currently not supported.
The callback will be called once the upload is finished. The callback will be called with the newly created media item or null if it failed. It will also optionally contain a preflight info object.
Optional mediaItem: UserMediaItemOptional preflightInfo: PreflightInfoUploads multiple media items. This triggers the upload dialog for multiple uploads. This will upload into the default album. Preflight info is not available for this method.
The same upload restrictions apply as for the regular upload.
The callback will be called once the upload is finished. The callback will be called with the newly created media items or an empty array.
This returns all media items in the currently selected album. If the user changes the current album, this method will return the new items.
The callback function that will be called once the media items are retrieved. Same output as MediaItems.
Generated using TypeDoc
This interface gives access to all resources assigned to this product template.