WidgetServiceClient class

Balíček:

@azure/template-dpg

Konstruktory

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

Metody

analyzeWidget(string, AnalyzeWidgetOptions)	Analýza widgetu Jedinou zárukou je, že tato metoda vrátí řetězec obsahující výsledky analýzy.
createWidget(number, ColorType, CreateWidgetOptions)	Vytvořte nový widget. ID widgetu se během vytváření nevyžaduje, protože je automaticky nastaveno serverem. Zadání ID způsobí chybu.
deleteWidget(string, DeleteWidgetOptions)	Odstranění widgetu podle ID
getWidget(string, GetWidgetOptions)	Získejte widget podle ID.
listWidgets(ListWidgetsOptions)	Zobrazí seznam všech widgetů v systému. Tato operace není stránkovaná a vrací jednoduché pole widgetů. Nepřijímá žádné možnosti ani parametry.
updateWidget(string, UpdateWidgetOptions)	Aktualizujte obsah widgetu. ID widgetu je vyžadováno ve vstupu, ale nelze ho změnit. Všechna ostatní pole jsou volitelná a v případě potřeby se aktualizují v rámci widgetu.

Podrobnosti konstruktoru

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)

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

Parametry

endpoint

string

credential

TokenCredential

options

WidgetServiceClientOptions

WidgetServiceClient(string, WidgetServiceClientOptions)

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

Parametry

endpoint

string

options

WidgetServiceClientOptions

Podrobnosti metody

analyzeWidget(string, AnalyzeWidgetOptions)

Analýza widgetu Jedinou zárukou je, že tato metoda vrátí řetězec obsahující výsledky analýzy.

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

Parametry

id

string

options

AnalyzeWidgetOptions

Návraty

Promise<AnalyzeResult>

createWidget(number, ColorType, CreateWidgetOptions)

Vytvořte nový widget.

ID widgetu se během vytváření nevyžaduje, protože je automaticky nastaveno serverem. Zadání ID způsobí chybu.

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

Parametry

weight

number

color

ColorType

options

CreateWidgetOptions

Návraty

Promise<Widget>

deleteWidget(string, DeleteWidgetOptions)

Odstranění widgetu podle ID

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

Parametry

id

string

options

DeleteWidgetOptions

Návraty

Promise<void>

getWidget(string, GetWidgetOptions)

Získejte widget podle ID.

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

Parametry

id

string

options

GetWidgetOptions

Návraty

Promise<Widget>

listWidgets(ListWidgetsOptions)

Zobrazí seznam všech widgetů v systému. Tato operace není stránkovaná a vrací jednoduché pole widgetů.

Nepřijímá žádné možnosti ani parametry.

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

Parametry

options

ListWidgetsOptions

Návraty

Promise<Widget[]>

updateWidget(string, UpdateWidgetOptions)

Aktualizujte obsah widgetu. ID widgetu je vyžadováno ve vstupu, ale nelze ho změnit. Všechna ostatní pole jsou volitelná a v případě potřeby se aktualizují v rámci widgetu.

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

Parametry

id

string

options

UpdateWidgetOptions

Návraty

Promise<Widget>