Package com.inductiveautomation.ignition.common.images

Interface ImageRpc

public interface ImageRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ImageRpc.ImageData

Method Summary

Modifier and Type	Method	Description
void	copyImage(String destination, List<String> paths)
void	createImageFolder(String name, String parent)
List<ImageRpc.ImageData>	listImages(String folder)	Returns a list of ImageRpc.ImageData describing images in the given folder.
void	removeImages(List<String> paths)
void	renameImageFolder(String from, String destination)
void	uploadImage(String name, @Nullable String description, ImageFormat type, @Nullable String parent, int width, int height, int size, byte[] data)

Method Details

uploadImage

void uploadImage(String name,
 @Nullable
 @Nullable String description,
 ImageFormat type,
 @Nullable
 @Nullable String parent,
 int width,
 int height,
 int size,
 byte[] data)
          throws Exception

Throws:

Exception

listImages

List<ImageRpc.ImageData> listImages(String folder)

Returns a list of ImageRpc.ImageData describing images in the given folder.

removeImages

void removeImages(List<String> paths)
           throws Exception

Throws:

Exception

copyImage

void copyImage(String destination,
 List<String> paths)
        throws Exception

Throws:

Exception

renameImageFolder

void renameImageFolder(String from,
 String destination)
                throws Exception

Throws:

Exception

createImageFolder

void createImageFolder(String name,
 String parent)
                throws Exception

Throws:

Exception