Class: CentralServerClient
frontend.CentralServerClient
CentralServerClient - CromwellCMS Central Server API Client CromwellCMS Central Server is official server at ... API used to check local CMS updates.
Table of contents#
Constructors#
Methods#
- checkCmsUpdate
- checkPluginUpdate
- checkThemeUpdate
- fetch
- get
- getAllCmsVersions
- getBaseUrl
- getCmsFullInfo
- getCmsInfo
- getFrontendDependenciesBindings
- getFrontendDependenciesList
- getPluginAllVersions
- getPluginFullInfo
- getPluginInfo
- getPluginList
- getThemeAllVersions
- getThemeFullInfo
- getThemeInfo
- getThemeList
- getVersionByPackage
- makeRequestToGitHub
- post
Constructors#
constructor#
• new CentralServerClient()
Methods#
checkCmsUpdate#
â–¸ checkCmsUpdate(version, beta?): Promise<undefined | TCCSVersion>
Parameters#
| Name | Type |
|---|---|
version | string |
beta? | boolean |
Returns#
Promise<undefined | TCCSVersion>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:118
checkPluginUpdate#
â–¸ checkPluginUpdate(name, version, beta?): Promise<undefined | TCCSVersion>
Parameters#
| Name | Type |
|---|---|
name | string |
version | string |
beta? | boolean |
Returns#
Promise<undefined | TCCSVersion>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:168
checkThemeUpdate#
â–¸ checkThemeUpdate(name, version, beta?): Promise<undefined | TCCSVersion>
Parameters#
| Name | Type |
|---|---|
name | string |
version | string |
beta? | boolean |
Returns#
Promise<undefined | TCCSVersion>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:198
fetch#
â–¸ fetch<T>(route, options?): Promise<undefined | T>
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
route | string |
options? | TRequestOptions |
Returns#
Promise<undefined | T>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:29
get#
â–¸ get<T>(route, options?): Promise<undefined | T>
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
route | string |
options? | TRequestOptions |
Returns#
Promise<undefined | T>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:61
getAllCmsVersions#
â–¸ getAllCmsVersions(): Promise<undefined | TCCSModuleShortInfo>
Returns#
Promise<undefined | TCCSModuleShortInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:122
getBaseUrl#
â–¸ getBaseUrl(): undefined | string
Returns#
undefined | string
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:12
getCmsFullInfo#
â–¸ getCmsFullInfo(): Promise<undefined | TCCSModuleInfo>
Returns#
Promise<undefined | TCCSModuleInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:110
getCmsInfo#
â–¸ getCmsInfo(): Promise<undefined | TCCSModuleShortInfo>
Returns#
Promise<undefined | TCCSModuleShortInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:106
getFrontendDependenciesBindings#
â–¸ getFrontendDependenciesBindings(): Promise<any>
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:126
getFrontendDependenciesList#
â–¸ getFrontendDependenciesList(version): Promise<any>
Parameters#
| Name | Type |
|---|---|
version | string |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:135
getPluginAllVersions#
â–¸ getPluginAllVersions(name): Promise<undefined | TCCSVersion[]>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSVersion[]>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:164
getPluginFullInfo#
â–¸ getPluginFullInfo(name): Promise<undefined | TCCSModuleInfo>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSModuleInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:160
getPluginInfo#
â–¸ getPluginInfo(name): Promise<undefined | TCCSModuleShortInfo>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSModuleShortInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:147
getPluginList#
â–¸ getPluginList(params?, filter?): Promise<undefined | TPagedList<TCCSModuleInfo>>
Parameters#
| Name | Type |
|---|---|
params? | TPagedParams<TCCSModuleInfo> |
filter? | Object |
filter.search? | string |
Returns#
Promise<undefined | TPagedList<TCCSModuleInfo>>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:151
getThemeAllVersions#
â–¸ getThemeAllVersions(name): Promise<undefined | TCCSVersion[]>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSVersion[]>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:194
getThemeFullInfo#
â–¸ getThemeFullInfo(name): Promise<undefined | TCCSModuleInfo>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSModuleInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:190
getThemeInfo#
â–¸ getThemeInfo(name): Promise<undefined | TCCSModuleShortInfo>
Parameters#
| Name | Type |
|---|---|
name | string |
Returns#
Promise<undefined | TCCSModuleShortInfo>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:177
getThemeList#
â–¸ getThemeList(params?, filter?): Promise<undefined | TPagedList<TCCSModuleInfo>>
Parameters#
| Name | Type |
|---|---|
params? | TPagedParams<TCCSModuleInfo> |
filter? | Object |
filter.search? | string |
Returns#
Promise<undefined | TPagedList<TCCSModuleInfo>>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:181
getVersionByPackage#
â–¸ getVersionByPackage(packageVersion): Promise<undefined | TCCSVersion>
Parameters#
| Name | Type |
|---|---|
packageVersion | string |
Returns#
Promise<undefined | TCCSVersion>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:114
makeRequestToGitHub#
â–¸ makeRequestToGitHub(url): Promise<any>
Parameters#
| Name | Type |
|---|---|
url | any |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CentralServerClient.ts:73
post#
â–¸ post<T>(route, input?, options?): Promise<undefined | T>
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
route | string |
input? | any |
options? | TRequestOptions |
Returns#
Promise<undefined | T>