Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 2.12 KB

Images.md

File metadata and controls

33 lines (17 loc) · 2.12 KB
Raw

Images

The following methods are available on ApiClient instances to manage images. Unless otherwise specified, all received and returned model classes are within the ...\Models\Images namespace.

  • getImages

    getImages(): list<Image>

    Load all images within the account. (API docs)

  • getImage

    getImage(string|Image $image, ?ApiClient::IMAGE_FORMAT_* $format = null, ?ApiClient::IMAGE_SIZE_* $size = null): Image

    Load a specific image, optionally with a predefined format and size. See the API docs for details on formats and sizes. (Image API docs; Format API docs: background, choice-image, image)

  • getImageSource

    getImageSource(string|Image $image, ?ApiClient::IMAGE_FORMAT_* $format = null, ?ApiClient::IMAGE_SIZE_* $size = null): string

    Load the raw source for a specific image, optionally with a predefined format and size. See the API docs for details on formats and sizes. (Image API docs; Format API docs: background, choice-image, image)

  • createImage

    createImage(string $fileName, string $base64Source, string $url): array

    Create a new image. The return format is indeterminate – see the API docs. (API docs)

  • deleteImage

    deleteImage(string $fileName, string $base64Source, string $url): array

    Delete an existing image. (API docs)