Class BrandKitController

The BrandKitController is responsible for all communication regarding Brand Kits. Methods inside this controller can be called by window.SDK.brandKit.{method-name}

Index

Methods

addMedia enableAutoSync get getAllMedia getId getName getVersion isAutoSync removeMedia rename renameMedia set switchTheme sync updateIdAndVersion updateMedia

Methods

addMedia

addMedia(
    name: string,
    remoteConnectorId: string,
    assetId: string,
): Promise<EditorResponse<string>>
This method adds a media item to the brand kit
Parameters
- name: string
  The name of the media item
- remoteConnectorId: string
  The remote connector ID
- assetId: string
  The asset ID of the media item
Returns Promise<EditorResponse<string>>
- Defined in sdk/src/controllers/BrandKitController.ts:103

enableAutoSync

enableAutoSync(enableAutoSync: boolean): Promise<EditorResponse<boolean>>
This method enables or disables brand kit auto-sync
Parameters
- enableAutoSync: boolean
  boolean indicating auto-sync status
Returns Promise<EditorResponse<boolean>>
boolean indicating the result of the operation
- Defined in sdk/src/controllers/BrandKitController.ts:181

get

get(): Promise<EditorResponse<BrandKit>>
Experimental
This method returns the local brand kit

Returns Promise<EditorResponse<BrandKit>>
brand kit with all assigned resources
- Defined in sdk/src/controllers/BrandKitController.ts:82

getAllMedia

getAllMedia(): Promise<EditorResponse<BrandKitMedia[]>>
This method returns all media items in the brand kit

Returns Promise<EditorResponse<BrandKitMedia[]>>
list of media items in the brand kit
- Defined in sdk/src/controllers/BrandKitController.ts:91

getId

getId(): Promise<EditorResponse<string>>
This method returns the current brand kit id.

Returns Promise<EditorResponse<string>>
current brand kit id
- Defined in sdk/src/controllers/BrandKitController.ts:34

getName

getName(): Promise<EditorResponse<string>>
This method returns the current brand kit name.

Returns Promise<EditorResponse<string>>
current brand kit name
- Defined in sdk/src/controllers/BrandKitController.ts:52

getVersion

getVersion(): Promise<EditorResponse<string>>
This method returns the current brand kit version.

Returns Promise<EditorResponse<string>>
current brand kit version
- Defined in sdk/src/controllers/BrandKitController.ts:43

isAutoSync

isAutoSync(): Promise<EditorResponse<boolean>>
This method returns the value indicating whether the brand kit auto-sync is enabled or not It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.

Returns Promise<EditorResponse<boolean>>
boolean indicating sync status
- Defined in sdk/src/controllers/BrandKitController.ts:171

removeMedia

removeMedia(name: string): Promise<EditorResponse<null>>
This method removes a media item from the brand kit
Parameters
- name: string
  The name of the media item to remove
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:140

rename

rename(newName: string): Promise<EditorResponse<null>>
This method renames the brand kit.
Parameters
- newName: string
  The new name for the brand kit
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:62

renameMedia

renameMedia(name: string, newName: string): Promise<EditorResponse<null>>
This method renames an existing media item in the brand kit
Parameters
- name: string
  The name of the media item to rename
- newName: string
  The new name for the media item
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:130

set

set(apiBrandKit: APIBrandKit): Promise<EditorResponse<BrandKit>>
Experimental
This method replaces the full brand kit and all related resources assigned to it
Parameters
- apiBrandKit: APIBrandKit
  the brand kit from the environment api
Returns Promise<EditorResponse<BrandKit>>
the local brand kit
- Defined in sdk/src/controllers/BrandKitController.ts:150

switchTheme

switchTheme(themeName: string): Promise<EditorResponse<null>>
Switches the active brand kit theme.
Parameters
- themeName: string
  Theme name
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:191

sync

sync(apiBrandKit: APIBrandKit): Promise<EditorResponse<boolean>>
Experimental
This method syncs brand kit items and structure in place without replacing the existing brand kit
Parameters
- apiBrandKit: APIBrandKit
  the brand kit from the environment api
Returns Promise<EditorResponse<boolean>>
boolean indicating whether the brand kit changed after the sync attempt
- Defined in sdk/src/controllers/BrandKitController.ts:160

updateIdAndVersion

updateIdAndVersion(id: string, version: string): Promise<EditorResponse<null>>
This method updates both the brand kit id and version.
Parameters
- id: string
  The new brand kit id
- version: string
  The new brand kit version
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:73

updateMedia

updateMedia(
    name: string,
    remoteConnectorId: string,
    assetId: string,
): Promise<EditorResponse<null>>
This method updates an existing media item in the brand kit
Parameters
- name: string
  The name of the media item to update
- remoteConnectorId: string
  The new remote connector ID
- assetId: string
  The new asset ID
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/BrandKitController.ts:117