Type Alias BrandsAPI

type BrandsAPI = {
    activateBrand: typeof activateBrand;
    clearCache: typeof clearCache;
    createBrand: typeof createBrand;
    createBrandFile: typeof createBrandFile;
    deactivateBrand: typeof deactivateBrand;
    deleteBrand: typeof deleteBrand;
    deleteBrandFile: typeof deleteBrandFile;
    getActiveBrand: typeof getActiveBrand;
    getBrand: typeof getBrand;
    getBrandFile: typeof getBrandFile;
    getBrands: typeof getBrands;
    patchBrand: typeof patchBrand;
    updateBrandFile: typeof updateBrandFile;
}
Index

Properties

activateBrand clearCache createBrand createBrandFile deactivateBrand deleteBrand deleteBrandFile getActiveBrand getBrand getBrandFile getBrands patchBrand updateBrandFile

Properties

activateBrand: typeof activateBrand

Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.

The brand's unique identifier.

Param: body

an object with the body content

ActivateBrandHttpError

clearCache: typeof clearCache

Clears the cache for brands api requests.

createBrand: typeof createBrand

Creates a new brand.

Param: body

an object with the body content

CreateBrandHttpError

createBrandFile: typeof createBrandFile

Creates a brand file for the specified identifier.

The brand's unique identifier.

The unique identifier of a file within a brand.

Param: body

an object with the body content

CreateBrandFileHttpError

deactivateBrand: typeof deactivateBrand

Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.

The brand's unique identifier.

Param: body

an object with the body content

DeactivateBrandHttpError

deleteBrand: typeof deleteBrand

Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.

The brand's unique identifier.

DeleteBrandHttpError

deleteBrandFile: typeof deleteBrandFile

Deletes the specified brand file.

The brand's unique identifier.

The unique identifier of a file within a brand.

DeleteBrandFileHttpError

getActiveBrand: typeof getActiveBrand

Returns the current active brand. If using the Qlik default brand, no value is returned.

GetActiveBrandHttpError

getBrand: typeof getBrand

Returns a specific brand.

The brand's unique identifier.

GetBrandHttpError

getBrandFile: typeof getBrandFile

Downloads the specified brand file.

The brand's unique identifier.

The unique identifier of a file within a brand.

GetBrandFileHttpError

getBrands: typeof getBrands

Lists all brand entries for a tenant.

an object with query parameters

GetBrandsHttpError

patchBrand: typeof patchBrand

Patches a brand.

The brand's unique identifier.

Param: body

an object with the body content

PatchBrandHttpError

updateBrandFile: typeof updateBrandFile

Updates the specified brand file.

The brand's unique identifier.

The unique identifier of a file within a brand.

Param: body

an object with the body content

UpdateBrandFileHttpError

Settings

Member Visibility

On This Page

Properties