Package com.inductiveautomation.ignition.gateway.images

Interface ImageManager

public interface ImageManager

Method Summary

Modifier and Type	Method	Description
void	copyImage(String from, String dest)	Copies an image from one location to another.
void	deleteImage(String path)
Optional<ImageResource>	getImage(String path)
List<ImageResource>	getImages(String dir)	Returns a list of images at the given folder, without their BLOB data.
void	insertImage(String name, String desc, ImageFormat type, String dir, byte[] input, int width, int height, int size)
void	insertImageFolder(String name, String dir)	Inserts a new image folder.

Method Details

copyImage

void copyImage(String from,
 String dest)
        throws PushException

Copies an image from one location to another.

Parameters:

from - The path to the image to copy

dest - The path to the destination path to copy the image to

Throws:

PushException - If the image cannot be copied

deleteImage

void deleteImage(String path)
          throws PushException

Throws:

PushException

getImages

List<ImageResource> getImages(String dir)

Returns a list of images at the given folder, without their BLOB data.

insertImage

void insertImage(String name,
 String desc,
 ImageFormat type,
 String dir,
 byte[] input,
 int width,
 int height,
 int size)
          throws PushException

Throws:

PushException

getImage

Optional<ImageResource> getImage(String path)

insertImageFolder

void insertImageFolder(String name,
 String dir)
                throws PushException

Inserts a new image folder.

Parameters:

name - The name of the folder (not a path)

dir - The path of the parent folder, or null for the root folder.

Throws:

PushException