WidgetServiceClient class
Constructeurs
| Widget |
|
| Widget |
Méthodes
| analyze |
Analyser un widget. La seule garantie est que cette méthode retourne une chaîne contenant les résultats de l’analyse. |
| create |
Créez un widget. L’ID du widget n’est pas requis lors de la création, car il est automatiquement défini par le serveur. La fourniture d’un ID entraîne une erreur. |
| delete |
Supprimez un widget par ID. |
| get |
Obtenir un widget par ID. |
| list |
Répertoriez tous les widgets du système. Cette opération n’est pas paginé et retourne un tableau simple de widgets. Elle n’accepte aucune option ni aucun paramètre. |
| update |
Mettez à jour le contenu du widget. L’ID du widget est requis dans l’entrée, mais ne peut pas être modifié. Tous les autres champs sont facultatifs et seront mis à jour dans le widget s’ils sont fournis. |
Détails du constructeur
WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)
Paramètres
- endpoint
-
string
- credential
- TokenCredential
- options
- WidgetServiceClientOptions
WidgetServiceClient(string, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)
Paramètres
- endpoint
-
string
- options
- WidgetServiceClientOptions
Détails de la méthode
analyzeWidget(string, AnalyzeWidgetOptions)
Analyser un widget. La seule garantie est que cette méthode retourne une chaîne contenant les résultats de l’analyse.
function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>
Paramètres
- id
-
string
- options
- AnalyzeWidgetOptions
Retours
Promise<AnalyzeResult>
createWidget(number, ColorType, CreateWidgetOptions)
Créez un widget.
L’ID du widget n’est pas requis lors de la création, car il est automatiquement défini par le serveur. La fourniture d’un ID entraîne une erreur.
function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>
Paramètres
- weight
-
number
- color
- ColorType
- options
- CreateWidgetOptions
Retours
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
Supprimez un widget par ID.
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>
Paramètres
- id
-
string
- options
- DeleteWidgetOptions
Retours
Promise<void>
getWidget(string, GetWidgetOptions)
Obtenir un widget par ID.
function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>
Paramètres
- id
-
string
- options
- GetWidgetOptions
Retours
Promise<Widget>
listWidgets(ListWidgetsOptions)
Répertoriez tous les widgets du système. Cette opération n’est pas paginé et retourne un tableau simple de widgets.
Elle n’accepte aucune option ni aucun paramètre.
function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>
Paramètres
- options
- ListWidgetsOptions
Retours
Promise<Widget[]>
updateWidget(string, UpdateWidgetOptions)
Mettez à jour le contenu du widget. L’ID du widget est requis dans l’entrée, mais ne peut pas être modifié. Tous les autres champs sont facultatifs et seront mis à jour dans le widget s’ils sont fournis.
function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>
Paramètres
- id
-
string
- options
- UpdateWidgetOptions
Retours
Promise<Widget>