WidgetServiceClient class
Construtores
| Widget |
|
| Widget |
Métodos
| analyze |
Analisar um widget. A única garantia é que esse método retornará uma cadeia de caracteres que contém os resultados da análise. |
| create |
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. |
| delete |
Exclua um widget por ID. |
| get |
Obtenha um widget por ID. |
| list |
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. |
| update |
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
- options
- WidgetServiceClientOptions
WidgetServiceClient(string, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)
Parâmetros
- endpoint
-
string
- options
- WidgetServiceClientOptions
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
- options
- AnalyzeWidgetOptions
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
- options
- CreateWidgetOptions
Retornos
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
Exclua um widget por ID.
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>
Parâmetros
- id
-
string
- options
- DeleteWidgetOptions
Retornos
Promise<void>
getWidget(string, GetWidgetOptions)
Obtenha um widget por ID.
function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>
Parâmetros
- id
-
string
- options
- GetWidgetOptions
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
- options
- ListWidgetsOptions
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
- options
- UpdateWidgetOptions
Retornos
Promise<Widget>