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 remove removeMedia rename renameMedia set 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:140

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:263

get

get(): Promise<
    {
        data?: null
        | string;
        error?: null | string;
        parsedData: StudioBrandKit;
        status: number;
        success: boolean;
    },
>
Experimental
This method returns the local brandkit

Returns Promise<
    {
        data?: null
        | string;
        error?: null | string;
        parsedData: StudioBrandKit;
        status: number;
        success: boolean;
    },
>
brandkit with all assigned resources
- Defined in sdk/src/controllers/BrandKitController.ts:110

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:128

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:62

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:80

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:71

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:253

remove

remove(): Promise<void>
Experimental
This method removes a brand kit and all related resources assigned to it

Returns Promise<void>
- Defined in sdk/src/controllers/BrandKitController.ts:186

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:177

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:90

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:167

set

set(
    studioBrandKit: StudioBrandKit,
): Promise<
    {
        data?: null
        | string;
        error?: null | string;
        parsedData: BrandKitInternal;
        status: number;
        success: boolean;
    },
>
Experimental
This method updates a brand kit and all related resources assigned to it
Parameters
- studioBrandKit: StudioBrandKit
  the content of the brand kit
Returns Promise<
    {
        data?: null
        | string;
        error?: null | string;
        parsedData: BrandKitInternal;
        status: number;
        success: boolean;
    },
>
- Defined in sdk/src/controllers/BrandKitController.ts:232

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:101

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:154

Class BrandKitController

Index

Methods

Methods

addMedia

Parameters

Returns Promise<EditorResponse<string>>

enableAutoSync

Parameters

Returns Promise<EditorResponse<boolean>>

get

Returns Promise< { data?: null | string; error?: null | string; parsedData: StudioBrandKit; status: number; success: boolean; },>

getAllMedia

Returns Promise<EditorResponse<BrandKitMedia[]>>

getId

Returns Promise<EditorResponse<string>>

getName

Returns Promise<EditorResponse<string>>

getVersion

Returns Promise<EditorResponse<string>>

isAutoSync

Returns Promise<EditorResponse<boolean>>

remove

Returns Promise<void>

removeMedia

Parameters

Returns Promise<EditorResponse<null>>

rename

Parameters

Returns Promise<EditorResponse<null>>

renameMedia

Parameters

Returns Promise<EditorResponse<null>>

set

Parameters

Returns Promise< { data?: null | string; error?: null | string; parsedData: BrandKitInternal; status: number; success: boolean; },>

updateIdAndVersion

Parameters

Returns Promise<EditorResponse<null>>

updateMedia

Parameters

Returns Promise<EditorResponse<null>>

Settings

On This Page

Returns Promise<
{
data?: null
| string;
error?: null | string;
parsedData: StudioBrandKit;
status: number;
success: boolean;
},
>

Returns Promise<
{
data?: null
| string;
error?: null | string;
parsedData: BrandKitInternal;
status: number;
success: boolean;
},
>