Type alias Theme

Type declaration

• createTheme:function

  • createTheme(themeData: ThemeSkeleton, themeId?: string, realm?: string): Promise<ThemeSkeleton>

  • Update theme

    Parameters

    • themeData: ThemeSkeleton

      theme object
    • Optional themeId: string

      theme id
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

• createThemeExportTemplate:function

  • createThemeExportTemplate(): ThemeExportInterface

  • Create an empty theme export template

    Returns ThemeExportInterface

    an empty theme export template

• deleteTheme:function

  • deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>

  • Delete theme by id

    Parameters

    • themeId: string

      theme id
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a themes object

• deleteThemeByName:function

  • deleteThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>

  • Delete theme by name

    Parameters

    • themeName: string

      theme name
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a themes object

• deleteThemes:function

  • deleteThemes(realm?: string): Promise<ThemeSkeleton[]>

  • Delete all themes

    Parameters

    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton[]>

    a promise that resolves to an array of themes

• exportThemes:function

  • exportThemes(): Promise<ThemeExportInterface>

  • Export all themes. The response can be saved to file as is.

    Returns Promise<ThemeExportInterface>

    Promise resolving to a ThemeExportInterface object.

• getTheme:function

  • getTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>

  • Get theme by id

    Parameters

    • themeId: string

      theme id
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

    Deprecated

    since v2.0.0 use readTheme instead

    readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>
    Copy

• getThemeByName:function

  • getThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>

  • Get theme by name

    Parameters

    • themeName: string

      theme name
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

    Deprecated

    since v2.0.0 use readThemeByName instead

    readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>
    Copy

• getThemes:function

  • getThemes(): Promise<ThemeSkeleton[]>

  • Get all themes

    Returns Promise<ThemeSkeleton[]>

    a promise that resolves to an array of themes

    Deprecated

    since v2.0.0 use readThemes instead

    readThemes(): Promise<ThemeSkeleton[]>
    Copy

• importThemes:function

  • importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>

  • Import themes

    Parameters

    • importData: ThemeExportInterface

      import data

    Returns Promise<ThemeSkeleton[]>

    a promise resolving to an array of theme objects

• putTheme:function

  • putTheme(themeId: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>

  • Put theme by id

    Parameters

    • themeId: string

      theme id
    • themeData: ThemeSkeleton

      theme object
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

    Deprecated

    since v2.0.0 use updateTheme or createTheme instead

    updateTheme(themeId: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>
    createTheme(themeData: ThemeSkeleton, themeId?: string, realm?: string): Promise<ThemeSkeleton>
    Copy

• putThemeByName:function

  • putThemeByName(themeName: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>

  • Put theme by name

    Parameters

    • themeName: string

      theme name
    • themeData: ThemeSkeleton

      theme object
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

    Deprecated

    since v2.0.0 use updateThemeByName instead

    updateThemeByName(themeName: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>
    Copy

• putThemes:function

  • putThemes(themeMap: Record<string, ThemeSkeleton>): Promise<Record<string, ThemeSkeleton>>

  • Put all themes

    Parameters

    • themeMap: Record<string, ThemeSkeleton>

    Returns Promise<Record<string, ThemeSkeleton>>

    a promise that resolves to a themes object

    Deprecated

    since v2.0.0 use updateThemes instead

    updateThemes(themeMap: Map<string, ThemeSkeleton>): Promise<Map<string, ThemeSkeleton>>
    Copy

• readTheme:function

  • readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>

  • Read theme by id

    Parameters

    • themeId: string

      theme id
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

• readThemeByName:function

  • readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>

  • Read theme by name

    Parameters

    • themeName: string

      theme name
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

• readThemes:function

  • readThemes(): Promise<ThemeSkeleton[]>

  • Read all themes

    Returns Promise<ThemeSkeleton[]>

    a promise that resolves to an array of themes

• updateTheme:function

  • updateTheme(themeId: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>

  • Update theme

    Parameters

    • themeId: string

      theme id
    • themeData: ThemeSkeleton

      theme object
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

• updateThemeByName:function

  • updateThemeByName(themeName: string, themeData: ThemeSkeleton, realm?: string): Promise<ThemeSkeleton>

  • Update theme by name

    Parameters

    • themeName: string

      theme name
    • themeData: ThemeSkeleton

      theme object
    • Optional realm: string

      realm name

    Returns Promise<ThemeSkeleton>

    a promise that resolves to a theme object

• updateThemes:function

  • updateThemes(themeMap: Record<string, ThemeSkeleton>): Promise<Record<string, ThemeSkeleton>>

  • Update all themes

    Parameters

    • themeMap: Record<string, ThemeSkeleton>

    Returns Promise<Record<string, ThemeSkeleton>>

    a promise that resolves to a themes object