Class ThemeClient

Hierarchy

ThemeClient

Constructors

constructor

new ThemeClient(client: HttpClient): ThemeClient

- Defined in admin-api/src/clients/ThemeClient.ts:8
Parameters
- client: HttpClient
Returns ThemeClient

Properties

Private client

client: HttpClient

Methods

active

active(themeId: string): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:57
Active a theme.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<ThemeProperty>>
ThemeProperty

delete

delete(themeId: string, deleteSettings?: boolean): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:44
Delete theme by themeId.

Parameters
- themeId: string
  
  themeId
- Optional deleteSettings: boolean
  
  whether to delete the theme settings at the same time.
Returns Promise<Response<ThemeProperty>>
ThemeProperty

exists

exists(template: string): Promise<Response<boolean>>

- Defined in admin-api/src/clients/ThemeClient.ts:290
Check template exists

Parameters
- template: string
  
  template name
Returns Promise<Response<boolean>>
boolean

fetchTheme

fetchTheme(uri: string): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:303
Fetch theme by uri

Parameters
- uri: string
  
  uri
Returns Promise<Response<ThemeProperty>>
void

get

get(themeId: string): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:30
Get theme property by themeId.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<ThemeProperty>>
ThemeProperty

getActivatedTemplateContent

getActivatedTemplateContent(filepath: string): Promise<Response<string>>

- Defined in admin-api/src/clients/ThemeClient.ts:145
Get activated template content by filepath.

Parameters
- filepath: string
  
  filepath
Returns Promise<Response<string>>
template content

getActivatedTheme

getActivatedTheme(): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:253
Get activated theme property.

Returns Promise<Response<ThemeProperty>>
ThemeProperty

getTemplateContent

getTemplateContent(themeId: string, filepath: string): Promise<Response<string>>

- Defined in admin-api/src/clients/ThemeClient.ts:159
Get template content by themeId and filepath.

Parameters
- themeId: string
  
  themeId
- filepath: string
  
  filepath
Returns Promise<Response<string>>
template content

list

list(): Promise<Response<ThemeProperty[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:17
List all themes.

Returns Promise<Response<ThemeProperty[]>>
array of ThemeProperty

listActivatedConfigurations

listActivatedConfigurations(): Promise<Response<Group[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:94
List activated theme configurations.

Returns Promise<Response<Group[]>>
array of configuration group.

listActivatedFiles

listActivatedFiles(): Promise<Response<ThemeFile[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:132
List activated theme files.

Returns Promise<Response<ThemeFile[]>>
array of ThemeFile

listActivatedSettings

listActivatedSettings(): Promise<Response<Record<string, unknown>>>

- Defined in admin-api/src/clients/ThemeClient.ts:203
List activated theme settings.

Returns Promise<Response<Record<string, unknown>>>
Record<string, unknown>

listConfigurationGroups

listConfigurationGroups(themeId: string): Promise<Response<string[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:69
Fetches theme configuration group names by theme id

Parameters
- themeId: string
  
  theme id
Returns Promise<Response<string[]>>

listConfigurations

listConfigurations(themeId: string): Promise<Response<Group[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:107
List theme configurations by themeId.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<Group[]>>
array of configuration group.

listConfigurationsByGroup

listConfigurationsByGroup(themeId: string, group: string): Promise<Response<Item[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:82
Fetches theme configuration group by theme id and group name

Parameters
- themeId: string
  
  theme id
- group: string
  
  group name
Returns Promise<Response<Item[]>>

listCustomPostTemplates

listCustomPostTemplates(): Promise<Response<string[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:265
List activated theme custom post templates.

Returns Promise<Response<string[]>>
array of template name.

listCustomSheetTemplates

listCustomSheetTemplates(): Promise<Response<string[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:277
List activated theme custom sheet templates.

Returns Promise<Response<string[]>>
array of template name.

listFiles

listFiles(themeId: string): Promise<Response<ThemeFile[]>>

- Defined in admin-api/src/clients/ThemeClient.ts:120
List theme files by themeId.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<ThemeFile[]>>
array of ThemeFile

listSettings

listSettings(themeId: string): Promise<Response<Record<string, unknown>>>

- Defined in admin-api/src/clients/ThemeClient.ts:191
List theme settings by themeId.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<Record<string, unknown>>>
Record<string, unknown>

listSettingsByGroup

listSettingsByGroup(themeId: string, group: string): Promise<Response<Record<string, unknown>>>

- Defined in admin-api/src/clients/ThemeClient.ts:216
Lists theme settings by theme id and group name

Parameters
- themeId: string
  
  theme id
- group: string
  
  group name
Returns Promise<Response<Record<string, unknown>>>

reload

reload(): Promise<Response<void>>

- Defined in admin-api/src/clients/ThemeClient.ts:341
Refresh theme list cache.

Returns Promise<Response<void>>
void

saveActivatedSettings

saveActivatedSettings(settings: Record<string, unknown>): Promise<void>

- Defined in admin-api/src/clients/ThemeClient.ts:241
Save activated theme settings.

Parameters
- settings: Record<string, unknown>
  
  settings
Returns Promise<void>

saveSettings

saveSettings(themeId: string, settings: Record<string, unknown>): Promise<void>

- Defined in admin-api/src/clients/ThemeClient.ts:229
Save settings by themeId.

Parameters
- themeId: string
  
  themeId
- settings: Record<string, unknown>
  
  settings
Returns Promise<void>

updateActivatedTemplateContent

updateActivatedTemplateContent(params: { content?: string; path?: string }): Promise<Response<void>>

- Defined in admin-api/src/clients/ThemeClient.ts:329
Update activated theme template content.

Parameters
- params: { content?: string; path?: string }
  
  path, content
  - Optional content?: string
  - Optional path?: string
Returns Promise<Response<void>>
void

updateByUpload

updateByUpload(data: unknown, options: UploadOptions, themeId: string): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:372
Update theme by upload.

Parameters
- data: unknown
  
  data
- options: UploadOptions
  
  upload options
- themeId: string
  
  themeId
Returns Promise<Response<ThemeProperty>>
ThemeProperty

updateTemplateContent

updateTemplateContent(themeId: string, params: { content?: string; path?: string }): Promise<void>

- Defined in admin-api/src/clients/ThemeClient.ts:172
Update theme template content by themeId.

Parameters
- themeId: string
  
  themeId
- params: { content?: string; path?: string }
  
  path, content
  - Optional content?: string
  - Optional path?: string
Returns Promise<void>

updateThemeByFetching

updateThemeByFetching(themeId: string): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:316
update theme by fetch.

Parameters
- themeId: string
  
  themeId
Returns Promise<Response<ThemeProperty>>
void

upload

upload(data: unknown, options: UploadOptions): Promise<Response<ThemeProperty>>

- Defined in admin-api/src/clients/ThemeClient.ts:355
Upload a theme.

Parameters
- data: unknown
  
  data
- options: UploadOptions
  
  Upload options
Returns Promise<Response<ThemeProperty>>
ThemeProperty

Generated using TypeDoc