WidgetServiceClient class

Construtores

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
WidgetServiceClient(string, WidgetServiceClientOptions)

Métodos

analyzeWidget(string, AnalyzeWidgetOptions)

Analisar um widget. A única garantia é que esse método retornará uma cadeia de caracteres que contém os resultados da análise.

createWidget(number, ColorType, CreateWidgetOptions)

Crie um novo widget.

A ID do widget não é necessária durante a criação, pois é definida automaticamente pelo servidor. Fornecer uma ID resultará em um erro.

deleteWidget(string, DeleteWidgetOptions)

Exclua um widget por ID.

getWidget(string, GetWidgetOptions)

Obtenha um widget por ID.

listWidgets(ListWidgetsOptions)

Liste todos os widgets no sistema. Essa operação não é paginada e retorna uma matriz simples de widgets.

Ele não aceita nenhuma opção ou parâmetros.

updateWidget(string, UpdateWidgetOptions)

Atualize o conteúdo do widget. A ID do widget é necessária na entrada, mas não pode ser alterada. Todos os outros campos são opcionais e serão atualizados no widget, se fornecidos.

Detalhes do construtor

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)

Parâmetros

endpoint

string

credential
TokenCredential

WidgetServiceClient(string, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)

Parâmetros

endpoint

string

Detalhes do método

analyzeWidget(string, AnalyzeWidgetOptions)

Analisar um widget. A única garantia é que esse método retornará uma cadeia de caracteres que contém os resultados da análise.

function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>

Parâmetros

id

string

Retornos

Promise<AnalyzeResult>

createWidget(number, ColorType, CreateWidgetOptions)

Crie um novo widget.

A ID do widget não é necessária durante a criação, pois é definida automaticamente pelo servidor. Fornecer uma ID resultará em um erro.

function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>

Parâmetros

weight

number

color
ColorType

Retornos

Promise<Widget>

deleteWidget(string, DeleteWidgetOptions)

Exclua um widget por ID.

function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>

Parâmetros

id

string

Retornos

Promise<void>

getWidget(string, GetWidgetOptions)

Obtenha um widget por ID.

function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>

Parâmetros

id

string

Retornos

Promise<Widget>

listWidgets(ListWidgetsOptions)

Liste todos os widgets no sistema. Essa operação não é paginada e retorna uma matriz simples de widgets.

Ele não aceita nenhuma opção ou parâmetros.

function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>

Parâmetros

Retornos

Promise<Widget[]>

updateWidget(string, UpdateWidgetOptions)

Atualize o conteúdo do widget. A ID do widget é necessária na entrada, mas não pode ser alterada. Todos os outros campos são opcionais e serão atualizados no widget, se fornecidos.

function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>

Parâmetros

id

string

Retornos

Promise<Widget>