Type Alias ExtensionsAPI

type ExtensionsAPI = {
    clearCache: typeof clearCache;
    deleteExtension: typeof deleteExtension;
    downloadExtension: typeof downloadExtension;
    downloadFileFromExtension: typeof downloadFileFromExtension;
    getExtension: typeof getExtension;
    getExtensions: typeof getExtensions;
    patchExtension: typeof patchExtension;
    uploadExtension: typeof uploadExtension;
}
Index

Properties

clearCache deleteExtension downloadExtension downloadFileFromExtension getExtension getExtensions patchExtension uploadExtension

Properties

clearCache: typeof clearCache

Clears the cache for extensions api requests.

deleteExtension: typeof deleteExtension

Deletes a specific extension matching either extension ID or extension name.

Extension identifier or its qextFilename.

DeleteExtensionHttpError

downloadExtension: typeof downloadExtension

Downloads all files in the extension matching either extension ID or extension name as a .zip archive.

Extension identifier or its qextFilename.

DownloadExtensionHttpError

downloadFileFromExtension: typeof downloadFileFromExtension

Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.

Extension identifier or its qextFilename.

Path to the file location within the specified extension archive. Folders separated with forward slashes.

DownloadFileFromExtensionHttpError

getExtension: typeof getExtension

Returns a specific extension matching either extension ID or extension name.

Extension identifier or its qextFilename.

GetExtensionHttpError

getExtensions: typeof getExtensions

Lists all imported extensions in the tenant.

GetExtensionsHttpError

patchExtension: typeof patchExtension

Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.

Extension identifier or its qextFilename.

Param: body

an object with the body content

PatchExtensionHttpError

uploadExtension: typeof uploadExtension

Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.

Param: body

an object with the body content

UploadExtensionHttpError

Settings

Member Visibility

On This Page

Properties