Type Alias Theme

type Theme = {
    createTheme(
        themeData: ThemeSkeleton,
        themeId?: string,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    createThemeExportTemplate(): ThemeExportInterface;
    deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
    deleteThemeByName(
        themeName: string,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    deleteThemes(realm?: string): Promise<ThemeSkeleton[]>;
    exportThemes(): Promise<ThemeExportInterface>;
    getTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
    getThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
    getThemes(): Promise<ThemeSkeleton[]>;
    importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>;
    putTheme(
        themeId: string,
        themeData: ThemeSkeleton,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    putThemeByName(
        themeName: string,
        themeData: ThemeSkeleton,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    putThemes(
        themeMap: Record<string, ThemeSkeleton>,
    ): Promise<Record<string, ThemeSkeleton>>;
    readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
    readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
    readThemes(): Promise<ThemeSkeleton[]>;
    updateTheme(
        themeId: string,
        themeData: ThemeSkeleton,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    updateThemeByName(
        themeName: string,
        themeData: ThemeSkeleton,
        realm?: string,
    ): Promise<ThemeSkeleton>;
    updateThemes(
        themeMap: Record<string, ThemeSkeleton>,
    ): Promise<Record<string, ThemeSkeleton>>;
}

Index

Methods

createTheme createThemeExportTemplate deleteTheme deleteThemeByName deleteThemes exportThemes importThemes readTheme readThemeByName readThemes updateTheme updateThemeByName updateThemes

Deprecated

getTheme getThemeByName getThemes putTheme putThemeByName putThemes

Methods

createTheme

createTheme(
    themeData: ThemeSkeleton,
    themeId?: string,
    realm?: string,
): Promise<ThemeSkeleton>
Update theme
Parameters
- themeData: ThemeSkeleton
  theme object
- OptionalthemeId: string
  theme id
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a theme object
- Defined in ops/ThemeOps.ts:68

createThemeExportTemplate

createThemeExportTemplate(): ThemeExportInterface
Create an empty theme export template

Returns ThemeExportInterface
an empty theme export template
- Defined in ops/ThemeOps.ts:35

deleteTheme

deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>
Delete theme by id
Parameters
- themeId: string
  theme id
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a themes object
- Defined in ops/ThemeOps.ts:118

deleteThemeByName

deleteThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>
Delete theme by name
Parameters
- themeName: string
  theme name
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a themes object
- Defined in ops/ThemeOps.ts:125

deleteThemes

deleteThemes(realm?: string): Promise<ThemeSkeleton[]>
Delete all themes
Parameters
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton[]>
a promise that resolves to an array of themes
- Defined in ops/ThemeOps.ts:131

exportThemes

exportThemes(): Promise<ThemeExportInterface>
Export all themes. The response can be saved to file as is.

Returns Promise<ThemeExportInterface>
Promise resolving to a ThemeExportInterface object.
- Defined in ops/ThemeOps.ts:60

importThemes

importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>
Import themes
Parameters
- importData: ThemeExportInterface
  import data
Returns Promise<ThemeSkeleton[]>
a promise resolving to an array of theme objects
- Defined in ops/ThemeOps.ts:111

readTheme

readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>
Read theme by id
Parameters
- themeId: string
  theme id
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a theme object
- Defined in ops/ThemeOps.ts:48

readThemeByName

readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>
Read theme by name
Parameters
- themeName: string
  theme name
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a theme object
- Defined in ops/ThemeOps.ts:55

readThemes

readThemes(): Promise<ThemeSkeleton[]>
Read all themes

Returns Promise<ThemeSkeleton[]>
a promise that resolves to an array of themes
- Defined in ops/ThemeOps.ts:41

updateTheme

updateTheme(
    themeId: string,
    themeData: ThemeSkeleton,
    realm?: string,
): Promise<ThemeSkeleton>
Update theme
Parameters
- themeId: string
  theme id
- themeData: ThemeSkeleton
  theme object
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a theme object
- Defined in ops/ThemeOps.ts:80

updateThemeByName

updateThemeByName(
    themeName: string,
    themeData: ThemeSkeleton,
    realm?: string,
): Promise<ThemeSkeleton>
Update theme by name
Parameters
- themeName: string
  theme name
- themeData: ThemeSkeleton
  theme object
- Optionalrealm: string
  realm name
Returns Promise<ThemeSkeleton>
a promise that resolves to a theme object
- Defined in ops/ThemeOps.ts:92

updateThemes

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
- Defined in ops/ThemeOps.ts:103

Deprecated

getTheme

getTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>
Get theme by id
Parameters
- themeId: string
  theme id
- Optionalrealm: 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>
```
- Defined in ops/ThemeOps.ts:157

getThemeByName

getThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>
Get theme by name
Parameters
- themeName: string
  theme name
- Optionalrealm: 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>
```
- Defined in ops/ThemeOps.ts:169

getThemes

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[]>
```
- Defined in ops/ThemeOps.ts:145

putTheme

putTheme(
    themeId: string,
    themeData: ThemeSkeleton,
    realm?: string,
): Promise<ThemeSkeleton>
Put theme by id
Parameters
- themeId: string
  theme id
- themeData: ThemeSkeleton
  theme object
- Optionalrealm: 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>
```
- Defined in ops/ThemeOps.ts:183

putThemeByName

putThemeByName(
    themeName: string,
    themeData: ThemeSkeleton,
    realm?: string,
): Promise<ThemeSkeleton>
Put theme by name
Parameters
- themeName: string
  theme name
- themeData: ThemeSkeleton
  theme object
- Optionalrealm: 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>
```
- Defined in ops/ThemeOps.ts:200

putThemes

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>>
```
- Defined in ops/ThemeOps.ts:216

Type Alias Theme

Index

Methods

Deprecated

Methods

createTheme

Parameters

Returns Promise<ThemeSkeleton>

createThemeExportTemplate

Returns ThemeExportInterface

deleteTheme

Parameters

Returns Promise<ThemeSkeleton>

deleteThemeByName

Parameters

Returns Promise<ThemeSkeleton>

deleteThemes

Parameters

Returns Promise<ThemeSkeleton[]>

exportThemes

Returns Promise<ThemeExportInterface>

importThemes

Parameters

Returns Promise<ThemeSkeleton[]>

readTheme

Parameters

Returns Promise<ThemeSkeleton>

readThemeByName

Parameters

Returns Promise<ThemeSkeleton>

readThemes

Returns Promise<ThemeSkeleton[]>

updateTheme

Parameters

Returns Promise<ThemeSkeleton>

updateThemeByName

Parameters

Returns Promise<ThemeSkeleton>

updateThemes

Parameters

Returns Promise<Record<string, ThemeSkeleton>>

Deprecated

getTheme

Parameters

Returns Promise<ThemeSkeleton>

Deprecated

getThemeByName

Parameters

Returns Promise<ThemeSkeleton>

Deprecated

getThemes

Returns Promise<ThemeSkeleton[]>

Deprecated

putTheme

Parameters

Returns Promise<ThemeSkeleton>

Deprecated

putThemeByName

Parameters

Returns Promise<ThemeSkeleton>

Deprecated

putThemes

Parameters

Returns Promise<Record<string, ThemeSkeleton>>

Deprecated

Settings

On This Page