Class InsertWidget

InsertWidget

Compilateur pour les objets InsertWidget. Les développeurs peuvent insérer un widget dans une fiche en transmettant un InsertWidget à ModifyCard.

Uniquement disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

Exemple d'utilisation : 

const newWidget = CardService.newDecoratedText().setText('New Widget');

const insertWidget = AddOnsResponseService.newInsertWidget()
                                          .insertAboveWidget('sample_id')
                                          .setWidget(newWidget);

const modifyCard = AddOnsResponseService.newModifyCard().setInsertWidget(insertWidget);

Méthodes

MéthodeType renvoyéBrève description
insertAboveWidget(widgetId)InsertWidgetDéfinit l'ID du widget. Le nouveau widget est inséré au-dessus du widget portant l'ID spécifié.
insertBelowWidget(widgetId)InsertWidgetDéfinit l'ID du widget. Le nouveau widget est inséré sous le widget portant l'ID indiqué.
setWidget(widget)InsertWidgetDéfinit le Widget à insérer.

Documentation détaillée

insertAboveWidget(widgetId)

Définit l'ID du widget. Le nouveau widget est inséré au-dessus du widget portant l'ID spécifié. Une erreur est générée si l'ID du widget est introuvable.

Paramètres

NomTypeDescription
widgetIdStringID du widget à insérer au-dessus.

Renvois

InsertWidget : objet du widget d'insertion, pour l'association en chaîne.

insertBelowWidget(widgetId)

Définit l'ID du widget. Le nouveau widget est inséré sous le widget portant l'ID indiqué. Une erreur est générée si l'ID du widget est introuvable.

Paramètres

NomTypeDescription
widgetIdStringID du widget à insérer ci-dessous.

Renvois

InsertWidget : objet du widget d'insertion, pour l'association en chaîne.

setWidget(widget)

Définit le Widget à insérer. Une erreur est générée s'il existe déjà un widget avec le même ID.

Paramètres

NomTypeDescription
widgetWidgetWidget à insérer.

Renvois

InsertWidget : objet du widget d'insertion, pour l'association en chaîne.