WidgetsOperations interface

Interface representing a Widgets operations.

Properties

createOrUpdateWidget

Creates or updates a Widget asynchronously.

deleteWidget

Delete a Widget asynchronously.

getWidget

Fetch a Widget by name.

getWidgetOperationStatus

Gets status of a Widget operation.

listWidgets

List Widget resources

Property Details

createOrUpdateWidget

Creates or updates a Widget asynchronously.

createOrUpdateWidget: (widgetName: string, resource: WidgetSuite, options?: WidgetsCreateOrUpdateWidgetOptionalParams) => PollerLike<OperationState<WidgetSuite>, WidgetSuite>

Property Value

(widgetName: string, resource: WidgetSuite, options?: WidgetsCreateOrUpdateWidgetOptionalParams) => PollerLike<OperationState<WidgetSuite>, WidgetSuite>

deleteWidget

Delete a Widget asynchronously.

deleteWidget: (widgetName: string, options?: WidgetsDeleteWidgetOptionalParams) => PollerLike<OperationState<WidgetSuite>, WidgetSuite>

Property Value

(widgetName: string, options?: WidgetsDeleteWidgetOptionalParams) => PollerLike<OperationState<WidgetSuite>, WidgetSuite>

getWidget

Fetch a Widget by name.

getWidget: (widgetName: string, options?: WidgetsGetWidgetOptionalParams) => Promise<WidgetSuite>

Property Value

(widgetName: string, options?: WidgetsGetWidgetOptionalParams) => Promise<WidgetSuite>

getWidgetOperationStatus

Gets status of a Widget operation.

getWidgetOperationStatus: (widgetName: string, operationId: string, options?: WidgetsGetWidgetOperationStatusOptionalParams) => Promise<ResourceOperationStatusWidgetSuiteWidgetSuiteError>

Property Value

(widgetName: string, operationId: string, options?: WidgetsGetWidgetOperationStatusOptionalParams) => Promise<ResourceOperationStatusWidgetSuiteWidgetSuiteError>

listWidgets

List Widget resources

listWidgets: (options?: WidgetsListWidgetsOptionalParams) => PagedAsyncIterableIterator<WidgetSuite, WidgetSuite[], PageSettings>

Property Value

(options?: WidgetsListWidgetsOptionalParams) => PagedAsyncIterableIterator<WidgetSuite, WidgetSuite[], PageSettings>