WidgetServiceClient class

Constructores

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

Métodos

analyzeWidget(string, AnalyzeWidgetOptions)

Analice un widget. La única garantía es que este método devolverá una cadena que contenga los resultados del análisis.

createWidget(number, ColorType, CreateWidgetOptions)

Cree un widget.

El identificador del widget no es necesario durante la creación, ya que el servidor lo establece automáticamente. Si se proporciona un identificador, se producirá un error.

deleteWidget(string, DeleteWidgetOptions)

Elimine un widget por identificador.

getWidget(string, GetWidgetOptions)

Obtener un widget por identificador.

listWidgets(ListWidgetsOptions)

Enumere todos los widgets del sistema. Esta operación no está paginada y devuelve una matriz simple de widgets.

No acepta opciones ni parámetros.

updateWidget(string, UpdateWidgetOptions)

Actualice el contenido del widget. El identificador del widget es necesario en la entrada, pero no se puede cambiar. Todos los demás campos son opcionales y se actualizarán dentro del widget si se proporciona.

Detalles del constructor

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

Detalles del método

analyzeWidget(string, AnalyzeWidgetOptions)

Analice un widget. La única garantía es que este método devolverá una cadena que contenga los resultados del análisis.

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

Parámetros

id

string

Devoluciones

Promise<AnalyzeResult>

createWidget(number, ColorType, CreateWidgetOptions)

Cree un widget.

El identificador del widget no es necesario durante la creación, ya que el servidor lo establece automáticamente. Si se proporciona un identificador, se producirá un error.

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

Parámetros

weight

number

color
ColorType

Devoluciones

Promise<Widget>

deleteWidget(string, DeleteWidgetOptions)

Elimine un widget por identificador.

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

Parámetros

id

string

Devoluciones

Promise<void>

getWidget(string, GetWidgetOptions)

Obtener un widget por identificador.

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

Parámetros

id

string

Devoluciones

Promise<Widget>

listWidgets(ListWidgetsOptions)

Enumere todos los widgets del sistema. Esta operación no está paginada y devuelve una matriz simple de widgets.

No acepta opciones ni parámetros.

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

Parámetros

Devoluciones

Promise<Widget[]>

updateWidget(string, UpdateWidgetOptions)

Actualice el contenido del widget. El identificador del widget es necesario en la entrada, pero no se puede cambiar. Todos los demás campos son opcionales y se actualizarán dentro del widget si se proporciona.

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

Parámetros

id

string

Devoluciones

Promise<Widget>