Interface IDepositPhotosConfig

A structure defining properties of the Depositphotos source.

Package: IframeApi

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

actionMode

Declaration

actionMode?: IActionMode

Property Value

Type	Description
IActionMode

apiKey

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

Declaration

apiKey: string

Property Value

Type	Description
string

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

size

The size of images returned by the Depositphotos API.

Declaration

size: IframeApi.Configuration.ImageSize.ImageSizeType

Property Value

Type	Description
ImageSizeType

type

Declaration

type: "DepositPhotos"

Property Value

Type	Description
"DepositPhotos"

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