Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

GetImagesOptions

Synopsis

struct GetImagesOptions : ItemSelectionOptions
{
    boolean useCache;
    boolean generate;
    boolean itemIds;
    boolean attributes;
    boolean? resolveURIs; // attribute
}
useCache

See also: ItemSelectionOptions

If true, and the basket does not yet have a default article image representing the current configuration, a global cache look-up will be done and, if a matching image is found there, it will be used.

The default value of this option is false.

generate

If true, and the basket does not yet have a default article image representing the current configuration, a global cache look-up will be performed1 and, if no matching image is found there, an attempt will be made to generate/render the image.

The default value of this option is false.

itemIds

If true, returned ImageInfo instances will contain the item ID of the corresponding basket or view item.

The default value of this option is false.

attributes

If true, the attributes used to generate the image, or specified when the image was imported, are returned as part of ImageInfo.

For historical reasons, the names of these attributes differ from the names of the options passed to operation getGeneratedImage. There are attributes that do not have a corresponding option, and options that are not stored as an attribute. Nevertheless, some of the attributes may be useful to the client.

The default value of this option is false.

resolveURIs

The default value is true. If false, ImageInfo.url returns a URI with scheme gen or imp instead of an HTTP(S) URL. These URIs can be passed to setImages to reuse an imported image for another item, or to the session service operation resolveURIs.