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

IRemoteSourceConfig Module

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

A structure defining properties of the Google Drive and Amazon S3 sources.

example

clientConfig.json

{
  "assetSources": {
    "[source]Google Drive": {
      "type": "RemoteSource",
      "url": "https://example.com:3124/",
      "subfolder": "/animals/cats/",
      "fileSortTypes": [
        {
          "asc": "createdTime",
          "desc": "createdTime desc",
          "title": {
            "en": "Creation time",
            "de": "Erstellungszeit"
          }
        },
        {
          "asc": "starred",
          "desc": "starred desc",
          "title": {
            "en": "Starred",
            "de": "Markiert"
          }
        }
      ],
      "requestParams": {
        "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "corpora": "domain",
        "allowedItemOwnership": "all"
      }
    }
  }
}

Interfaces

Name	Description
IRootFolderConfig	A structure defining the appearance of the root folder.
ISortType	A structure defining options to sort assets.

Properties

Optional actionMode

actionMode: IActionModeParsed

Optional allowedExtensions

allowedExtensions: string []

An array of image types that the user is allowed for uploading to Amazon S3. The complete list of supported extentions is ["jpg", "jpeg", "png", "bmp", "gif", "tiff", "svg", "pdf", "ai", "psd"].

Optional autoInsertUploadedFile

autoInsertUploadedFile: boolean

If true, the Asset Manager closes as soon as it uploads a user image to Amazon S3. After that, this image is automatically inserted into the placeholder or image layer. The default value is false.

Optional fileSortTypes

fileSortTypes: ISortType []

The sort order of folders in the navigation tree of the Asset Manager.

Optional folderSortType

folderSortType: string

The sort order, according to which a list of images appears in the Asset Manager's gallery.

Optional overwrite

overwrite: boolean

Allows for overwriting images with existing names when uploading images to Amazon S3. If false, the name of the uploaded file is changed by adding _1, _2, etc. to it. The default value is false.

Optional requestParams

requestParams: object

Additional parameters of HTTP requests. For example, you need to pass the token and corpora properties for the Google Drive source in the case if you have a service account. The Google Drive source can also take allowedItemOwnership specifying what asset types should appear in the Asset Manager: personal, shared, or all. For Amazon S3, you must pass the userId (a folder in S3 backet) and token.

requestParams declaration

[name: string ]: string

Optional requestUploadUrl

requestUploadUrl: boolean

Optional rootFolder

rootFolder: IRootFolderConfig

Defines the appearance of the root folder.

Optional rootId

rootId: string

Restricts access to images by specifying a rootId. Alternatively, you can specify IRemoteSourceConfig.subfolder if the subfolder has a name.

Optional subfolder

subfolder: string

Restricts access to images by specifying a subfolder name. Alternatively, you can specify IRemoteSourceConfig.rootId if the subfolder has an ID.

type

type: "RemoteSource"

Optional uploadEnabled

uploadEnabled: boolean

If true, allows your users to upload their images to your Amazon S3 bucket. The default value is false.

url

url: string

The URL of the Google Drive web service communicating with the remote source. For more details about configuring the service, refer to the Google Drive and Amazon S3 topics.