Interface IAssetSources.IDepositPhotosConfig

A structure defining properties of the Depositphotos source.

Inheritance

IAssetSourceConfig<"DepositPhotos">

IAssetSources.IDepositPhotosConfig

Package: @aurigma/design-editor-iframe

Examples

{
"assetSources": {
    "[source]Deposit Photos": {
      "type": "DepositPhotos",
      "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "size": "XL",
      "insertItemConfirmationEnabled": false,
      "startingQuery": "cats"
    }
  },

  "widgets": {
    "Toolbox": {
      "buttons": [
        {
          "type": "AssetManager",
          "action": "Image",
          "translationKey": "Toolbox.IMAGE",
          "iconClass": "cc-icon-add-image"
        }
      ]
    },

    "AssetManager": {
      "tabs": [
        {
          "name": "Deposit Photos",
          "assetSourceInstance": "[source]Deposit Photos",
          "iconClassName": "cc-icon-deposit-photos"
        }
      ]
    }
  }
}

Properties

apiKey

The key required to use the Depositphotos API. To get this key, contact Depositphotos.

Declaration

apiKey: string;

Property Value

Type	Description
string	The key required to use the Depositphotos API. To get this key, contact Depositphotos.

insertItemConfirmationEnabled

Displays a dialog box informing your users that they will need to pay for images at checkout. The default value is true.

Declaration

insertItemConfirmationEnabled?: boolean;

Property Value

Type	Description
boolean	Displays a dialog box informing your users that they will need to pay for images at checkout. The default value is true.

size

The size of images returned by the Depositphotos API.

Declaration

size: ImageSize.ImageSizeType;

Property Value

Type	Description
ImageSizeType	The size of images returned by the Depositphotos API.

startingQuery

The search query that will be executed for the first opening of the Depositphotos tab. If not specified, images are loaded by the most popular query.

Declaration

startingQuery?: string;

Property Value

Type	Description
string	The search query that will be executed for the first opening of the Depositphotos tab. If not specified, images are loaded by the most popular query.

userId

Allows you to filter assets by a user identifier in Depositphotos. By default, such a filtering is not performed.

Declaration

userId?: string;

Property Value

Type	Description
string	Allows you to filter assets by a user identifier in Depositphotos. By default, such a filtering is not performed.