You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IDepositPhotosConfig Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure defining properties of the Depositphotos source.

example

clientConfig.json

{
  "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

Optional actionMode

actionMode: IActionModeParsed

apiKey

apiKey: string

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

Optional insertItemConfirmationEnabled

insertItemConfirmationEnabled: boolean

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

size

size: ImageSizeType

The size of images returned by the Depositphotos API.

Optional startingQuery

startingQuery: 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.

type

type: "DepositPhotos"

Optional userId

userId: string

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