文本输入的自动补全建议

Text Input 微件可让您的插件读取并对用户提供的文本做出反应。您可以配置这些微件,为用户提供输入文本的自动建议。

提供的建议可以来自您提供的静态字符串列表。或者,您可以根据上下文(例如用户在微件中输入的文本)构建建议。

配置建议

如需配置针对文本输入的建议,您只需执行以下操作:

  • 按照以下操作创建建议列表:
    • 创建静态列表和/或
    • 使用可基于上下文动态构建该列表的回调函数定义操作
  • 将建议列表和/或操作附加到文本输入微件。

如果您同时提供静态建议列表和操作,则应用界面会使用静态列表,直到用户开始输入字符为止;此时,系统会使用回调函数,并忽略静态列表。

静态建议

如需提供静态的建议列表,您只需执行以下操作:

  1. 创建一个 Suggestions 对象。
  2. 使用 addSuggestion()addSuggestions() 将每条静态建议添加到其中。
  3. 使用 TextInput.setSuggestions()Suggestions 对象附加到 widget。

界面会按照添加建议的顺序显示静态建议。界面还会执行不区分大小写的前缀匹配,并在用户在微件中输入字符时过滤建议列表。

建议操作

如果您没有使用静态建议列表,则必须定义一项操作来动态构建建议。您可按以下步骤实现这一目的:

  1. 创建一个 Action 对象,并将其与您定义的回调函数相关联。
  2. 调用微件的 TextInput.setSuggestionsAction() 函数,为其提供 Action 对象。
  3. 实现回调函数以构建建议列表并返回构建的 SuggestionsResponse 对象。

每当用户在文本输入中输入字符时,界面都会调用回调函数,但这只是在用户停止输入一段时间后才调用。该回调函数会接收一个事件对象,其中包含关于开放卡片的 widget 的信息。如需了解详情,请参阅操作事件对象

该回调函数必须返回有效的 SuggestionsResponse 对象,其中包含要显示的建议列表。界面会按照添加建议的顺序显示建议。与静态列表不同,界面不会根据用户输入自动过滤回调建议。如果您希望进行此类过滤,则必须从事件对象中读取文本输入值,并在构建列表时过滤建议。

示例

下面的 Google Workspace 插件代码段展示了如何为两个不同的文本输入微件配置建议,其中第一个微件具有静态列表,第二个微件使用回调函数:

// Create an input with a static suggestion list.
var textInput1 = CardService.newTextInput()
    .setFieldName('colorInput')
    .setTitle('Color choice')
    .setSuggestions(CardService.newSuggestions()
        .addSuggestion('Red')
        .addSuggestion('Yellow')
        .addSuggestions(['Blue', 'Black', 'Green']));

// Create an input with a dynamic suggestion list.
var action = CardService.newAction()
    .setFunctionName('refreshSuggestions');
var textInput2 = CardService.newTextInput()
    .setFieldName('emailInput')
    .setTitle('Email')
    .setSuggestionsAction(action);

// ...

/**
 *  Build and return a suggestion response. In this case, the suggestions
 *  are a list of emails taken from the To: and CC: lists of the open
 *  message in Gmail, filtered by the text that the user has already
 *  entered. This method assumes the Google Workspace
 *  add-on extends Gmail; the add-on only calls this method for cards
 *  displayed when the user has entered a message context.
 *
 *  @param {Object} e the event object containing data associated with
 *      this text input widget.
 *  @return {SuggestionsResponse}
 */
 function refreshSuggestions(e) {
   // Activate temporary Gmail scopes, in this case so that the
   // open message metadata can be read.
   var accessToken = e.gmail.accessToken;
   GmailApp.setCurrentMessageAccessToken(accessToken);

   var userInput = e && e.formInput['emailInput'].toLowerCase();
   var messageId = e.gmail.messageId;
   var message = GmailApp.getMessageById(messageId);

   // Combine the comma-separated returned by these methods.
   var addresses = message.getTo() + ',' + message.getCc();

   // Filter the address list to those containing the text the user
   // has already entered.
   var suggestionList = [];
   addresses.split(',').forEach(function(email) {
     if (email.toLowerCase().indexOf(userInput) !== -1) {
       suggestionList.push(email);
     }
   });
   suggestionList.sort();

   return CardService.newSuggestionsResponseBuilder()
       .setSuggestions(CardService.newSuggestions()
           .addSuggestions(suggestionList))
       .build();  // Don't forget to build the response!
 }

建议和OnChangeAction()

文本输入微件可以定义 setOnChangeAction() 处理程序函数,该函数会在微件失去焦点时执行。如果为同一文本输入同时启用了此处理程序和建议,则以下规则可定义文本输入互动行为:

  1. 选择建议后,系统会执行 setOnChangeAction() 处理程序。
  2. 如果用户按 Enter 键(或使文本输入丢失焦点),而不修改所选建议,setOnChangeAction() 不会再次触发。
  3. 如果用户在选择某个建议后对其进行修改,使其不再与列表中的任何建议匹配,setOnChangeAction() 会再次触发。
  4. 如果用户未选择建议,则 setOnChangeAction() 会在文本输入失去焦点时触发。