Class ImageService

A model for the managed image service.

Hierarchy

Constructors

constructor

Properties

ImageSelectionExplorer page uiManagedWorkflows uiShell

Methods

archiveImage navigateToImageDetails uploadImage

Constructors

constructor

  • Parameters

    • page: Page

      The playwright page object.

    • uiShell: UiShellModel

      A model representing the Mosaic UI shell including methods for navigation.

      Use this model to interact with:

      • The breadcrumbs bar (on any page)
      • The landing page
      • The settings hub page
    • uiManagedWorkflows: UiWorkflowsModel

      A model representing Mosaic UI workflows.

      Use this model to interact with workflows or modals of any managed service (Image, Video, Monetization, etc).

    Returns ImageService

Properties

Readonly ImageSelectionExplorer

ImageSelectionExplorer: typeof ImageSelectionExplorer = ImageSelectionExplorer

A reference to the ImageSelectionExplorer component model which can be used to select images in a modal. e.g.

await app.ui.form.modal
 .as(app.imageService.ImageSelectionExplorer)
 .selectImage('My image title');

Protected Readonly page

page: Page

The playwright page object.

Protected Readonly uiManagedWorkflows

uiManagedWorkflows: UiWorkflowsModel

A model representing Mosaic UI workflows.

Use this model to interact with workflows or modals of any managed service (Image, Video, Monetization, etc).

Protected Readonly uiShell

uiShell: UiShellModel

A model representing the Mosaic UI shell including methods for navigation.

Use this model to interact with:

  • The breadcrumbs bar (on any page)
  • The landing page
  • The settings hub page

Methods

archiveImage

  • This method archives an image by title. The management system must be loaded & signed in before using this method. If a single matching, non-archived image is not found then an exception will be raised.

    The following steps will be taken:

    • Navigate to the home breadcrumb then the 'Images' tile
    • Filter by title and click the image row action
    • Click 'Archive' and confirm
    • Wait for the image explorer station to load

    Parameters

    • args: {
          title: string;
      }
      • title: string

        A unique image title.

    Returns Promise<void>

navigateToImageDetails

  • This method navigates to an image details station by title. The management system must be loaded & signed in before using this method. If there is not exactly one matching image an exception will be raised.

    The following steps will be taken:

    • Navigate to the home breadcrumb then the 'Images' tile
    • Filter by title and click the image row action
    • Wait for the image details station to load

    Parameters

    • args: {
          title: string;
      }
      • title: string

        A unique image title.

    Returns Promise<void>

uploadImage

  • This method uploads an image file from the local file system. The management system must be loaded & signed in before using this method. A unique image title and a valid image type must be provided.

    The following steps will be taken:

    • Navigate to the home breadcrumb then the 'Images' tile
    • Click the 'Upload' action
    • Enter file and image type inputs then click 'Proceed'
    • Edit the image title
    • Click the 'refresh' breadcrumb and wait for the image details station to reload

    Parameters

    • properties: {
          imageType: string;
          sourceFile: string;
          title: string;
      }
      • imageType: string

        An existing image type (display value).

      • sourceFile: string

        Path to a local image file.

      • title: string

        A unique image title.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc