Interface IAssetSources.IRemoteSourceConfig

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

Inheritance

IAssetSourceConfig<"RemoteSource">

IAssetSources.IRemoteSourceConfig

Package: @aurigma/design-editor-iframe

Remarks

Google Drive and Amazon S3 for more details about configuring the service.

Examples

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

Properties

allowedExtensions

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"].

Declaration

allowedExtensions?: string[];

Property Value

Type	Description
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"].

autoInsertUploadedFile

If true, the Image 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.

Declaration

autoInsertUploadedFile?: boolean;

Property Value

Type	Description
boolean	If true, the Image 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.

fileSortTypes

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

Declaration

fileSortTypes?: IRemoteSourceConfig.ISortType[];

Property Value

Type	Description
IRemoteSourceConfig.ISortType[]	The sort order of folders in the navigation tree of the Image Manager.

folderSortType

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

Declaration

folderSortType?: string;

Property Value

Type	Description
string	The sort order, according to which a list of images appears in the Image Manager's gallery.

overwrite

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.

Declaration

overwrite?: boolean;

Property Value

Type	Description
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.

requestParams

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 Image Manager: personal, shared, or all. For Amazon S3, you must pass the userId (a folder in S3 backet) and token.

Declaration

requestParams?: {
            [name: string]: string;
        };

Property Value

Type	Description
{ [name: string]: string; }	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 Image Manager: personal, shared, or all. For Amazon S3, you must pass the userId (a folder in S3 backet) and token.

rootFolder

Defines the appearance of the root folder.

Declaration

rootFolder?: IRemoteSourceConfig.IRootFolderConfig;

Property Value

Type	Description
IRootFolderConfig	Defines the appearance of the root folder.

rootId

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

Declaration

rootId?: string;

Property Value

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

subfolder

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

Declaration

subfolder?: string;

Property Value

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

uploadEnabled

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

Declaration

uploadEnabled?: boolean;

Property Value

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

url

The URL of the GoogleDriveWebService communicating with the remote source.

Declaration

url: string;

Property Value

Type	Description
string	The URL of the GoogleDriveWebService communicating with the remote source.