WidgetServiceClient class

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

Parametry

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

Parametry

Analizowanie widżetu. Jedyną gwarancją jest to, że ta metoda zwróci ciąg zawierający wyniki analizy.

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

Parametry

Zwraca

Utwórz nowy widżet.

Identyfikator widżetu nie jest wymagany podczas tworzenia, ponieważ jest on automatycznie ustawiany przez serwer. Podanie identyfikatora spowoduje wystąpienie błędu.

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

Parametry

Zwraca

Usuń widżet według identyfikatora.

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

Parametry

Zwraca

Pobierz widżet według identyfikatora.

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

Parametry

Zwraca

Wyświetl listę wszystkich widżetów w systemie. Ta operacja nie jest podzielony na strony i zwraca prostą tablicę widżetów.

Nie akceptuje żadnych opcji ani parametrów.

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

Parametry

Zwraca

Zaktualizuj zawartość widżetu. Identyfikator widżetu jest wymagany w danych wejściowych, ale nie można go zmienić. Wszystkie inne pola są opcjonalne i zostaną zaktualizowane w widżecie, jeśli zostanie podany.

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

Parametry

Zwraca