Diese Seite wurde von der Cloud Translation API übersetzt.

Class TextButton

Ein TextButton mit einem Textlabel. Du kannst die Hintergrundfarbe festlegen und die Schaltfläche deaktivieren. wenn nötig.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`setAltText(altText)`	`TextButton`	Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest.
`setAuthorizationAction(action)`	`TextButton`	Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde.
`setBackgroundColor(backgroundColor)`	`TextButton`	Legt die Hintergrundfarbe der Schaltfläche „`TextButtonStyle.FILLED`“ fest.
`setComposeAction(action, composedEmailType)`	`TextButton`	Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
`setDisabled(disabled)`	`TextButton`	Legt fest, ob die Schaltfläche deaktiviert ist.
`setOnClickAction(action)`	`TextButton`	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`TextButton`	Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird.
`setOpenLink(openLink)`	`TextButton`	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
`setText(text)`	`TextButton`	Legt den Text fest, der auf der Schaltfläche angezeigt wird.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Hier legen Sie den Stil der Schaltfläche fest.

Detaillierte Dokumentation

`setAltText(altText)`

Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest. Wenn kein Wert festgelegt ist, wird standardmäßig der Text verwendet, auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
`altText`	`String`	Der alternative Text, der dieser Schaltfläche zugewiesen werden soll.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. Daraufhin wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und an die Anwendung zurückkehrt, wird das Add-on neu geladen.

Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

// ...

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

Parameter

Name	Typ	Beschreibung
`action`	`AuthorizationAction`	Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setBackgroundColor(backgroundColor)`

Legt die Hintergrundfarbe der Schaltfläche „TextButtonStyle.FILLED“ fest. Ist die Richtlinie für eine TextButtonStyle.FILLED-Schaltfläche nicht konfiguriert, wird für die Schaltfläche die im Add-on-Manifest definierte sekundäre Farbe verwendet. Diese Methode ist ein No-Op für TextButtonStyle.OUTLINED-Schaltflächen.

Parameter

Name	Typ	Beschreibung
`backgroundColor`	`String`	Die Farbe im #rgb-Format.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur haben einen der folgenden Werte: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Action-Parameter muss eine Callback-Funktion angeben, die ein ComposeActionResponse-Objekt zurückgibt, das mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriert wurde.

</ph> Hinweis: Mit dieser Methode wird keine compose-Aktion festgelegt, die zum Erweitern der Benutzeroberfläche zum Schreiben. Stattdessen verbindet diese Methode dieses UI-Element mit einem Action, das in Apps Script Nachrichtenentwürfe verfasst, die nach Abschluss der Aktion in Gmail geöffnet.

// ...

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

// ...

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

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der zusammengestellte Entwurf ein als eigenständiger Entwurf oder als Antwortentwurf.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setDisabled(disabled)`

Legt fest, ob die Schaltfläche deaktiviert ist. Eine deaktivierte Schaltfläche ist ausgegraut und kann nicht angeklickt werden.

Parameter

Name	Typ	Beschreibung
`disabled`	`Boolean`	Der Status „Deaktiviert“.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setOnClickAction(action)`

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur eines der folgenden Elemente haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Parameter Action muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt.

// ...

var 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();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setOnClickOpenLinkAction(action)`

Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn das Die URL muss erstellt werden oder wenn Sie zusätzlich zum Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Action-Parameter muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt, das mit ActionResponseBuilder.setOpenLink(openLink) konfiguriert wurde.

// ...

var 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();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Aktion zum Öffnen von Links angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setOpenLink(openLink)`

Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits und muss nur geöffnet werden. Ein UI-Objekt kann nur einen der folgenden Werte haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Parameter

Name	Typ	Beschreibung
`openLink`	`OpenLink`	Ein `OpenLink`-Objekt, das die zu öffnende URL beschreibt.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setText(text)`

Legt den Text fest, der auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Der auf der Schaltfläche angezeigte Text.

Rückflug

TextButton: Dieses Objekt zur Verkettung.

`setTextButtonStyle(textButtonStyle)`

Hier legen Sie den Stil der Schaltfläche fest. Wenn kein Wert festgelegt ist, wird standardmäßig die Schaltfläche „TextButtonStyle.OUTLINED“ verwendet.

Parameter

Name	Typ	Beschreibung
`textButtonStyle`	`TextButtonStyle`	Der Stil der Schaltfläche.

Rückflug

TextButton: Dieses Objekt zur Verkettung.