Class TextInput

Văn bảnĐầu vào

Một tiện ích trường nhập dữ liệu chấp nhận dữ liệu nhập văn bản.

Hỗ trợ xác thực dữ liệu trên biểu mẫu mà người dùng gửi. Khi Action.setAllWidgetsAreRequired(allWidgetsAreRequired) được đặt thành true hoặc tiện ích này được chỉ định thông qua Action.addRequiredWidget(requiredWidget), thao tác gửi sẽ bị chặn trừ phi bạn nhập một giá trị.

Dành cho tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setFieldName(fieldName)TextInputĐặt khoá xác định dữ liệu đầu vào văn bản này trong đối tượng sự kiện được tạo khi có một hoạt động tương tác trên giao diện người dùng.
setHint(hint)TextInputĐặt một gợi ý cho dữ liệu đầu vào văn bản.
setHostAppDataSource(hostAppDataSource)TextInputĐặt một nguồn dữ liệu từ các ứng dụng Google Workspace.
setMultiline(multiline)TextInputĐặt xem văn bản đầu vào xuất hiện trên một hay nhiều dòng.
setOnChangeAction(action)TextInputĐặt một thao tác sẽ được thực hiện bất cứ khi nào dữ liệu nhập văn bản thay đổi.
setSuggestions(suggestions)TextInputĐặt các đề xuất để tự động hoàn thành trong trường văn bản.
setSuggestionsAction(suggestionsAction)TextInputĐặt thao tác gọi lại để tìm nạp đề xuất dựa trên thông tin đầu vào của người dùng cho tính năng tự động hoàn thành.
setTitle(title)TextInputĐặt tiêu đề sẽ xuất hiện phía trên trường nhập.
setValidation(validation)TextInputĐặt quy tắc xác thực cho tiện ích này.
setValue(value)TextInputĐặt giá trị được điền sẵn sẽ được đặt trong trường nhập.

Tài liệu chi tiết

setFieldName(fieldName)

Đặt khoá xác định dữ liệu đầu vào văn bản này trong đối tượng sự kiện được tạo khi có một hoạt động tương tác trên giao diện người dùng. Người dùng không nhìn thấy. Bắt buộc, phải là duy nhất.

Thông số

TênLoạiMô tả
fieldNameStringKhoá dùng để xác định dữ liệu đầu vào này.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setHint(hint)

Đặt một gợi ý cho dữ liệu đầu vào văn bản. Được dùng để cung cấp cho người dùng hướng dẫn bổ sung về nội dung cần nhập. Ví dụ: một gợi ý có thể mô tả định dạng ("xxx-xxx-xxxx") cho trường số điện thoại.

Thông số

TênLoạiMô tả
hintStringGợi ý văn bản sẽ xuất hiện bên dưới trường nhập. Văn bản này luôn hiển thị.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setHostAppDataSource(hostAppDataSource)

Đặt một nguồn dữ liệu từ các ứng dụng Google Workspace. Hiện hỗ trợ người dùng và phòng Chat.

Chỉ có trong chương trình Gemini Alpha cho các tiện ích bổ sung Google Workspace mở rộng Google Workspace Flows.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Thông số

TênLoạiMô tả
hostAppDataSourceHostAppDataSourceNguồn dữ liệu.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setMultiline(multiline)

Đặt xem văn bản đầu vào xuất hiện trên một hay nhiều dòng.

Thông số

TênLoạiMô tả
multilineBooleanChế độ cài đặt nhiều dòng.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setOnChangeAction(action)

Đặt một thao tác sẽ được thực hiện bất cứ khi nào dữ liệu nhập văn bản thay đổi.

Thông số

TênLoạiMô tả
actionActionHành động cần thực hiện.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setSuggestions(suggestions)

Đặt các đề xuất để tự động hoàn thành trong trường văn bản.

Thông số

TênLoạiMô tả
suggestionsSuggestionsTập hợp các đề xuất để sử dụng.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setSuggestionsAction(suggestionsAction)

Đặt thao tác gọi lại để tìm nạp đề xuất dựa trên thông tin đầu vào của người dùng cho tính năng tự động hoàn thành. Tham số Action phải chỉ định một hàm callback trả về đối tượng SuggestionsResponse.

const action = CardService.newAction()
                   .setFunctionName('suggestionCallback')
                   .setParameters({numSuggestions: 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Thông số

TênLoạiMô tả
suggestionsActionActionThao tác tìm nạp các đề xuất cho dữ liệu đầu vào này.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setTitle(title)

Đặt tiêu đề sẽ xuất hiện phía trên trường nhập. Bắt buộc.

Thông số

TênLoạiMô tả
titleStringNhãn văn bản cho dữ liệu đầu vào này.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setValidation(validation)

Đặt quy tắc xác thực cho tiện ích này.

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

Thông số

TênLoạiMô tả
validationValidationQuy tắc xác thực cho tiện ích TextInput này.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.


setValue(value)

Đặt giá trị được điền sẵn sẽ được đặt trong trường nhập.

Thông số

TênLoạiMô tả
valueStringGiá trị mặc định được đặt trong dữ liệu đầu vào. Tham số này luôn được biểu thị dưới dạng một chuỗi trong các tham số lệnh gọi lại biểu mẫu.

Cầu thủ trả bóng

TextInput – Đối tượng này, để liên kết.