Class ImageVariableController

Index

Constructors

Methods

setAllowQuery setAllowUpload setConnector setConnectorContext setMinUploadSize

Constructors

constructor

new ImageVariableController(editorAPI: EditorAPI): ImageVariableController
Parameters
- editorAPI: EditorAPI
Returns ImageVariableController
- Defined in sdk/src/next/controllers/VariableController.ts:80

Methods

setAllowQuery

setAllowQuery(id: string, allowQuery: boolean): Promise<EditorResponse<null>>
This method sets the allow query for an image variable
Parameters
- id: string
  the id of the variable
- allowQuery: boolean
  the allow query
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/next/controllers/VariableController.ts:90

setAllowUpload

setAllowUpload(id: string, allowUpload: boolean): Promise<EditorResponse<null>>
This method sets the allow upload for an image variable
Parameters
- id: string
  the id of the variable
- allowUpload: boolean
  the allow upload
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/next/controllers/VariableController.ts:101

setConnector

setConnector(
    id: string,
    registration:
        | Next.ConnectorUrlRegistration
        | Next.ConnectorGrafxRegistration
        | Next.ConnectorLocalRegistration,
): Promise<EditorResponse<string>>
This method sets the image variable connector. Setting a connector will automatically remove the assetId linked to the connector if present. If a connector was the source of the variable, it will be unregistered.
Parameters
- id: string
  The id of the image variable to update
- registration:
      | Next.ConnectorUrlRegistration
      | Next.ConnectorGrafxRegistration
      | Next.ConnectorLocalRegistration
  registration object containing all details about the connector
Returns Promise<EditorResponse<string>>
The new id of the connector
- Defined in sdk/src/next/controllers/VariableController.ts:128

setConnectorContext

setConnectorContext(
id: string,
context: Dictionary,
): Promise<EditorResponse<null>>
This method sets the connector context for an image variable
Parameters
- id: string
  the id of the variable
- context: Dictionary
  the context dictionary
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/next/controllers/VariableController.ts:145

setMinUploadSize

setMinUploadSize(
    id: string,
    minWidth: null | string,
    minHeight: null | string,
): Promise<EditorResponse<null>>
This method sets the minimum size (both width and height) for an image variable that will be uploaded
Parameters
- id: string
  the id of the variable
- minWidth: null | string
  the minimum width
- minHeight: null | string
  the minimum height
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/next/controllers/VariableController.ts:113