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}

Hierarchy

CharacterStyleController

Index

Methods

create duplicate getAll getById move remove rename update

Methods

create

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

Returns
the id of new character style

Returns Promise<EditorResponse<string>>
- Defined in src/controllers/CharacterStyleController.ts:47

duplicate

duplicate(characterStyleId: string): Promise<EditorResponse<string>>
This method duplicates a character style by the id

Returns
id of the duplicated character style
Parameters
- characterStyleId: string
  
  the id of a specific character style
Returns Promise<EditorResponse<string>>
- Defined in src/controllers/CharacterStyleController.ts:80

getAll

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

Returns
list of all character styles

Returns Promise<EditorResponse<CharacterStyle[]>>
- Defined in src/controllers/CharacterStyleController.ts:26

getById

getById(characterStyleId: string): Promise<EditorResponse<CharacterStyle>>
This method returns a character style by the id

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

move

move(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes positions of character styles

Returns
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

Returns
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

Returns
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

Returns
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

Generated using TypeDoc