Class CharacterStyleController

The CharacterStyleController is responsible for all communication regarding character styles. Methods inside this controller can be called by window.SDK.characterStyle.{method-name}

Index

Methods

create duplicate getAll getById move remove rename update

Methods

create

create(): Promise<EditorResponse<string>>
This method creates a new character style

Returns Promise<EditorResponse<string>>
the id of new character style
- Defined in src/controllers/CharacterStyleController.ts:47

duplicate

duplicate(characterStyleId: string): Promise<EditorResponse<string>>
This method duplicates a character style by the id
Parameters
- characterStyleId: string
  the id of a specific character style
Returns Promise<EditorResponse<string>>
id of the duplicated character style
- Defined in src/controllers/CharacterStyleController.ts:80

getAll

getAll(): Promise<EditorResponse<CharacterStyle[]>>
This method returns the list of character styles

Returns Promise<EditorResponse<CharacterStyle[]>>
list of all character styles
- Defined in src/controllers/CharacterStyleController.ts:26

getById

getById(characterStyleId: string): Promise<EditorResponse<CharacterStyle>>
This method returns a character style by the id
Parameters
- characterStyleId: string
  the id of a specific character style
Returns Promise<EditorResponse<CharacterStyle>>
character style for given id
- Defined in src/controllers/CharacterStyleController.ts:36

move

move(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes positions of character styles
Parameters
- order: number
  the position of the character styles
- ids: string[]
  the list of character style ids
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/CharacterStyleController.ts:104

remove

remove(characterStyleId: string): Promise<EditorResponse<null>>
This method removes a character style by the id
Parameters
- characterStyleId: string
  the id of a specific character style
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/CharacterStyleController.ts:70

rename

rename(
characterStyleId: string,
characterStyleName: string,
): Promise<EditorResponse<null>>
This method renames a character style by the id
Parameters
- characterStyleId: string
  the id of a specific character style
- characterStyleName: string
  the new name of the character style
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/CharacterStyleController.ts:91

update

update(
characterStyleId: string,
characterStyle: CharacterStyleUpdate,
): Promise<EditorResponse<null>>
This method updates a character style by the id and provided properties
Parameters
- characterStyleId: string
  the id of a specific character style
- characterStyle: CharacterStyleUpdate
  the new character style properties
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/CharacterStyleController.ts:58