Class AppsClient

Constructors

constructor

new AppsClient(options: ClientOptions): AppsClient
Parameters
- options: ClientOptions
Returns AppsClient
- Defined in client.ts:106

Methods

asyncUpdateApp

asyncUpdateApp(
req: AsyncUpdateAppRequest,
options?: CallOptions,
): Promise<AsyncUpdateAppWaiter>
Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.
Parameters
- req: AsyncUpdateAppRequest
- Optionaloptions: CallOptions
Returns Promise<AsyncUpdateAppWaiter>
- Defined in client.ts:152

createApp

createApp(
req: CreateAppRequest,
options?: CallOptions,
): Promise<CreateAppWaiter>
Creates a new app.
Parameters
- req: CreateAppRequest
- Optionaloptions: CallOptions
Returns Promise<CreateAppWaiter>
- Defined in client.ts:206

createAppDeployment

createAppDeployment(
req: CreateAppDeploymentRequest,
options?: CallOptions,
): Promise<CreateAppDeploymentWaiter>
Creates an app deployment for the app with the supplied name.
Parameters
- req: CreateAppDeploymentRequest
- Optionaloptions: CallOptions
Returns Promise<CreateAppDeploymentWaiter>
- Defined in client.ts:248

createCustomTemplate

createCustomTemplate(
req: CreateCustomTemplateRequest,
options?: CallOptions,
): Promise<CustomTemplate>
Creates a custom template.
Parameters
- req: CreateCustomTemplateRequest
- Optionaloptions: CallOptions
Returns Promise<CustomTemplate>
- Defined in client.ts:265

createSpace

createSpace(
req: CreateSpaceRequest,
options?: CallOptions,
): Promise<CreateSpaceOperation>
Creates a new app space.
Parameters
- req: CreateSpaceRequest
- Optionaloptions: CallOptions
Returns Promise<CreateSpaceOperation>
- Defined in client.ts:325

deleteApp

deleteApp(req: DeleteAppRequest, options?: CallOptions): Promise<App>
Deletes an app.
Parameters
- req: DeleteAppRequest
- Optionaloptions: CallOptions
Returns Promise<App>
- Defined in client.ts:336

deleteAppThumbnail

deleteAppThumbnail(
req: DeleteAppThumbnailRequest,
options?: CallOptions,
): Promise<void>
Deletes the thumbnail for an app.
Parameters
- req: DeleteAppThumbnailRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:362

deleteCustomTemplate

deleteCustomTemplate(
req: DeleteCustomTemplateRequest,
options?: CallOptions,
): Promise<CustomTemplate>
Deletes the custom template with the specified name.
Parameters
- req: DeleteCustomTemplateRequest
- Optionaloptions: CallOptions
Returns Promise<CustomTemplate>
- Defined in client.ts:385

deleteSpace

deleteSpace(
req: DeleteSpaceRequest,
options?: CallOptions,
): Promise<DeleteSpaceOperation>
Deletes an app space.
Parameters
- req: DeleteSpaceRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteSpaceOperation>
- Defined in client.ts:443

getApp

getApp(req: GetAppRequest, options?: CallOptions): Promise<App>
Retrieves information for the app with the supplied name.
Parameters
- req: GetAppRequest
- Optionaloptions: CallOptions
Returns Promise<App>
- Defined in client.ts:454

getAppDeployment

getAppDeployment(
req: GetAppDeploymentRequest,
options?: CallOptions,
): Promise<AppDeployment>
Retrieves information for the app deployment with the supplied name and deployment id.
Parameters
- req: GetAppDeploymentRequest
- Optionaloptions: CallOptions
Returns Promise<AppDeployment>
- Defined in client.ts:480

getAppUpdate

getAppUpdate(
req: GetAppUpdateRequest,
options?: CallOptions,
): Promise<AppUpdate>
Gets the status of an app update.
Parameters
- req: GetAppUpdateRequest
- Optionaloptions: CallOptions
Returns Promise<AppUpdate>
- Defined in client.ts:509

getCustomTemplate

getCustomTemplate(
req: GetCustomTemplateRequest,
options?: CallOptions,
): Promise<CustomTemplate>
Gets the custom template with the specified name.
Parameters
- req: GetCustomTemplateRequest
- Optionaloptions: CallOptions
Returns Promise<CustomTemplate>
- Defined in client.ts:538

getSpace

getSpace(req: GetSpaceRequest, options?: CallOptions): Promise<Space>
Retrieves information for the app space with the supplied name.
Parameters
- req: GetSpaceRequest
- Optionaloptions: CallOptions
Returns Promise<Space>
- Defined in client.ts:567

listAppDeployments

listAppDeployments(
req: ListAppDeploymentsRequest,
options?: CallOptions,
): Promise<ListAppDeploymentsResponse>
Lists all app deployments for the app with the supplied name.
Parameters
- req: ListAppDeploymentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAppDeploymentsResponse>
- Defined in client.ts:622

listAppDeploymentsIter

listAppDeploymentsIter(
req: ListAppDeploymentsRequest,
options?: CallOptions,
): AsyncGenerator<AppDeployment>
Parameters
- req: ListAppDeploymentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<AppDeployment>
- Defined in client.ts:659

listApps

listApps(req: ListAppsRequest, options?: CallOptions): Promise<ListAppsResponse>
Lists all apps in the workspace.
Parameters
- req: ListAppsRequest
- Optionaloptions: CallOptions
Returns Promise<ListAppsResponse>
- Defined in client.ts:677

listAppsIter

listAppsIter(req: ListAppsRequest, options?: CallOptions): AsyncGenerator<App>
Parameters
- req: ListAppsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<App>
- Defined in client.ts:717

listCustomTemplates

listCustomTemplates(
req: ListCustomTemplatesRequest,
options?: CallOptions,
): Promise<ListCustomTemplatesResponse>
Lists all custom templates in the workspace.
Parameters
- req: ListCustomTemplatesRequest
- Optionaloptions: CallOptions
Returns Promise<ListCustomTemplatesResponse>
- Defined in client.ts:735

listCustomTemplatesIter

listCustomTemplatesIter(
req: ListCustomTemplatesRequest,
options?: CallOptions,
): AsyncGenerator<CustomTemplate>
Parameters
- req: ListCustomTemplatesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<CustomTemplate>
- Defined in client.ts:775

listSpaces

listSpaces(
req: ListSpacesRequest,
options?: CallOptions,
): Promise<ListSpacesResponse>
Lists all app spaces in the workspace.
Parameters
- req: ListSpacesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSpacesResponse>
- Defined in client.ts:793

listSpacesIter

listSpacesIter(
req: ListSpacesRequest,
options?: CallOptions,
): AsyncGenerator<Space>
Parameters
- req: ListSpacesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Space>
- Defined in client.ts:830

startApp

startApp(req: StartAppRequest, options?: CallOptions): Promise<StartAppWaiter>
Start the last active deployment of the app in the workspace.
Parameters
- req: StartAppRequest
- Optionaloptions: CallOptions
Returns Promise<StartAppWaiter>
- Defined in client.ts:878

stopApp

stopApp(req: StopAppRequest, options?: CallOptions): Promise<StopAppWaiter>
Stops the active deployment of the app in the workspace.
Parameters
- req: StopAppRequest
- Optionaloptions: CallOptions
Returns Promise<StopAppWaiter>
- Defined in client.ts:920

updateApp

updateApp(req: UpdateAppRequest, options?: CallOptions): Promise<App>
Updates the app with the supplied name.
Parameters
- req: UpdateAppRequest
- Optionaloptions: CallOptions
Returns Promise<App>
- Defined in client.ts:932

updateAppThumbnail

updateAppThumbnail(
req: UpdateAppThumbnailRequest,
options?: CallOptions,
): Promise<AppThumbnail>
Updates the thumbnail for an app.
Parameters
- req: UpdateAppThumbnailRequest
- Optionaloptions: CallOptions
Returns Promise<AppThumbnail>
- Defined in client.ts:959

updateCustomTemplate

updateCustomTemplate(
req: UpdateCustomTemplateRequest,
options?: CallOptions,
): Promise<CustomTemplate>
Updates the custom template with the specified name. Note that the template name cannot be updated.
Parameters
- req: UpdateCustomTemplateRequest
- Optionaloptions: CallOptions
Returns Promise<CustomTemplate>
- Defined in client.ts:989

updateSpace

updateSpace(
req: UpdateSpaceRequest,
options?: CallOptions,
): Promise<UpdateSpaceOperation>
Updates an app space. The update process is asynchronous and the status of the update can be checked with the GetSpaceOperation method.
Parameters
- req: UpdateSpaceRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateSpaceOperation>
- Defined in client.ts:1061