WidgetServiceClient class
Costruttori
| Widget |
|
| Widget |
Metodi
| analyze |
Analizzare un widget. L'unica garanzia è che questo metodo restituirà una stringa contenente i risultati dell'analisi. |
| create |
Creare un nuovo widget. L'ID del widget non è necessario durante la creazione, perché viene impostato automaticamente dal server. Se si specifica un ID, verrà generato un errore. |
| delete |
Eliminare un widget in base all'ID. |
| get |
Ottenere un widget in base all'ID. |
| list |
Elencare tutti i widget nel sistema. Questa operazione non è impaginata e restituisce una semplice matrice di widget. Non accetta opzioni o parametri. |
| update |
Aggiornare il contenuto del widget. L'ID del widget è obbligatorio nell'input, ma non può essere modificato. Tutti gli altri campi sono facoltativi e verranno aggiornati all'interno del widget, se specificato. |
Dettagli costruttore
WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)
Parametri
- endpoint
-
string
- credential
- TokenCredential
- options
- WidgetServiceClientOptions
WidgetServiceClient(string, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)
Parametri
- endpoint
-
string
- options
- WidgetServiceClientOptions
Dettagli metodo
analyzeWidget(string, AnalyzeWidgetOptions)
Analizzare un widget. L'unica garanzia è che questo metodo restituirà una stringa contenente i risultati dell'analisi.
function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>
Parametri
- id
-
string
- options
- AnalyzeWidgetOptions
Restituisce
Promise<AnalyzeResult>
createWidget(number, ColorType, CreateWidgetOptions)
Creare un nuovo widget.
L'ID del widget non è necessario durante la creazione, perché viene impostato automaticamente dal server. Se si specifica un ID, verrà generato un errore.
function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>
Parametri
- weight
-
number
- color
- ColorType
- options
- CreateWidgetOptions
Restituisce
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
Eliminare un widget in base all'ID.
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>
Parametri
- id
-
string
- options
- DeleteWidgetOptions
Restituisce
Promise<void>
getWidget(string, GetWidgetOptions)
Ottenere un widget in base all'ID.
function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>
Parametri
- id
-
string
- options
- GetWidgetOptions
Restituisce
Promise<Widget>
listWidgets(ListWidgetsOptions)
Elencare tutti i widget nel sistema. Questa operazione non è impaginata e restituisce una semplice matrice di widget.
Non accetta opzioni o parametri.
function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>
Parametri
- options
- ListWidgetsOptions
Restituisce
Promise<Widget[]>
updateWidget(string, UpdateWidgetOptions)
Aggiornare il contenuto del widget. L'ID del widget è obbligatorio nell'input, ma non può essere modificato. Tutti gli altri campi sono facoltativi e verranno aggiornati all'interno del widget, se specificato.
function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>
Parametri
- id
-
string
- options
- UpdateWidgetOptions
Restituisce
Promise<Widget>