Cette page a été traduite par l'API Cloud Translation.

Class KeyValue

Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Cette classe est obsolète. Utilisez plutôt DecoratedText.

Méthodes

Méthode	Type renvoyé	Brève description
`setAuthorizationAction(action)`	`KeyValue`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
`setComposeAction(action, composedEmailType)`	`KeyValue`	Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
`setOnClickAction(action)`	`KeyValue`	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
`setOnClickOpenLinkAction(action)`	`KeyValue`	Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`KeyValue`	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`setBottomLabel(text)`	`KeyValue`	Définit le texte du libellé à utiliser comme clé.
`setButton(button)`	`KeyValue`	Définit l'`Button` qui s'affiche à droite du contexte.
`setContent(text)`	`KeyValue`	Définit le texte à utiliser comme valeur.
`setIcon(icon)`	`KeyValue`	Définit l'icône à utiliser comme clé.
`setIconAltText(altText)`	`KeyValue`	Définit le texte de substitution de l'icône.
`setIconUrl(url)`	`KeyValue`	Définit l'URL de l'icône à utiliser comme clé.
`setMultiline(multiline)`	`KeyValue`	Indique si le texte de la valeur doit être affiché sur une seule ligne ou sur plusieurs lignes.
`setSwitch(switchToSet)`	`KeyValue`	Définit les `Switch` qui s'affichent à droite du contenu.
`setTopLabel(text)`	`KeyValue`	Définit le texte du libellé à utiliser comme clé.

Documentation détaillée

`setAuthorizationAction(action)`

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur termine le flux d'autorisation et revient à l'application, le module complémentaire se recharge.

Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Paramètres

Nom	Type	Description
`action`	`AuthorizationAction`	Objet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément.

Renvois

KeyValue : cet objet, pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft).

Remarque: Cette méthode ne définit pas d'action de composition utilisée pour étendre l'UI de Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui compose des brouillons de messages dans Apps Script qui sont ouverts dans Gmail une fois l'action terminée.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Paramètres

Nom	Type	Description
`action`	`Action`	Objet qui spécifie l'action de composition à effectuer lorsque cet élément est cliqué.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

KeyValue : cet objet, pour le chaînage.

`setOnClickAction(action)`

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

Paramètres

Nom	Type	Description
`action`	`Action`	Action à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

KeyValue : cet objet, pour le chaînage.

`setOnClickOpenLinkAction(action)`

Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL doit être créée ou lorsque vous devez effectuer d'autres actions en plus de créer l'objet OpenLink. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse configuré à l'aide de ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

Paramètres

Nom	Type	Description
`action`	`Action`	Objet qui spécifie l'action d'ouverture du lien à effectuer lorsque cet élément est cliqué.

Renvois

KeyValue : cet objet, pour le chaînage.

`setOpenLink(openLink)`

Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle ne doit être ouverte que. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Nom	Type	Description
`openLink`	`OpenLink`	Objet `OpenLink` décrivant l'URL à ouvrir.

Renvois

KeyValue : cet objet, pour le chaînage.

Méthodes obsolètes

`setBottomLabel(text)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le texte du libellé à utiliser comme clé. S'affiche sous le contenu textuel.

Paramètres

Nom	Type	Description
`text`	`String`	Texte du libellé. Remarque: Il n'est pas compatible avec la mise en forme HTML de base.

Renvois

KeyValue : cet objet, pour le chaînage.

`setButton(button)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit l'Button qui s'affiche à droite du contexte. Un KeyValue ne peut prendre en charge qu'un seul bouton, un seul bouton ou une seule icône.

Paramètres

Nom	Type	Description
`button`	`Button`	Bouton d'ajout.

Renvois

KeyValue : cet objet, pour le chaînage.

`setContent(text)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le texte à utiliser comme valeur. Compatible avec la mise en forme HTML de base. Obligatoire.

Paramètres

Nom	Type	Description
`text`	`String`	Contenu textuel de ce widget.

Renvois

KeyValue : cet objet, pour le chaînage.

`setIcon(icon)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit l'icône à utiliser comme clé.

Paramètres

Nom	Type	Description
`icon`	`Icon`	L'une des valeurs `Icon` prédéfinies.

Renvois

KeyValue : cet objet, pour le chaînage.

`setIconAltText(altText)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le texte de substitution de l'icône.

Paramètres

Nom	Type	Description
`altText`	`String`	Texte de substitution de l'icône.

Renvois

KeyValue : cet objet, pour le chaînage.

`setIconUrl(url)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit l'URL de l'icône à utiliser comme clé.

Paramètres

Nom	Type	Description
`url`	`String`	URL d'une image hébergée à utiliser comme icône.

Renvois

KeyValue : cet objet, pour le chaînage.

`setMultiline(multiline)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Indique si le texte de la valeur doit être affiché sur une seule ligne ou sur plusieurs lignes.

Paramètres

Nom	Type	Description
`multiline`	`Boolean`	Paramètre multiligne.

Renvois

KeyValue : cet objet, pour le chaînage.

`setSwitch(switchToSet)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit les Switch qui s'affichent à droite du contenu. Un KeyValue ne peut prendre en charge qu'un seul bouton, un seul bouton ou une seule icône.

Paramètres

Nom	Type	Description
`switchToSet`	`Switch`	Bouton à ajouter.

Renvois

KeyValue : cet objet, pour le chaînage.

`setTopLabel(text)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le texte du libellé à utiliser comme clé. S'affiche au-dessus du contenu textuel.

Paramètres

Nom	Type	Description
`text`	`String`	Texte du libellé. Remarque: Il n'est pas compatible avec la mise en forme HTML de base.

Renvois

KeyValue : cet objet, pour le chaînage.