Class TextInput

TextInput (Nhập văn bản)

Một tiện ích trường nhập chấp nhận phương thức nhập văn bản.

Hỗ trợ xác thực việc gửi biểu mẫu. 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ị.

Có sẵn cho các 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 phương thức nhập văn bản này trong đối tượng sự kiện được tạo khi có tương tác với giao diện người dùng.
setHint(hint)TextInputĐặt gợi ý cho hoạt động nhập văn bản.
setMultiline(multiline)TextInputĐặt xem văn bản nhập vào hiển thị trên một dòng hay nhiều dòng.
setOnChangeAction(action)TextInputĐặt một hành động 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 nội dung đề 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 các đề xuất dựa trên dữ liệu đầu vào của người dùng để tự động hoàn thành.
setTitle(title)TextInputĐặt tiêu đề sẽ hiển thị 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 trong trường nhập.

Tài liệu chi tiết

setFieldName(fieldName)

Đặt khoá xác định phương thức nhập văn bản này trong đối tượng sự kiện được tạo khi có tương tác với 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, để tạo chuỗi.


setHint(hint)

Đặt gợi ý cho hoạt động nhập văn bản. Dùng để cung cấp cho người dùng thêm hướng dẫn về nội dung cần nhập. Ví dụ: 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ẽ hiển thị 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, để tạo chuỗi.


setMultiline(multiline)

Đặt xem văn bản nhập vào hiển thị trên một dòng 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, để tạo chuỗi.


setOnChangeAction(action)

Đặt một hành động 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, để tạo chuỗi.


setSuggestions(suggestions)

Đặt nội dung đề 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, để tạo chuỗi.


setSuggestionsAction(suggestionsAction)

Đặt thao tác gọi lại để tìm nạp nội dung đề xuất dựa trên dữ liệu đầu vào của người dù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 nội dung đề xuất cho dữ liệu đầu vào này.

Cầu thủ trả bóng

TextInput – Đối tượng này, để tạo chuỗi.


setTitle(title)

Đặt tiêu đề sẽ hiển thị 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, để tạo chuỗi.


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, để tạo chuỗi.


setValue(value)

Đặt giá trị được điền sẵn 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. Giá trị này luôn được biểu thị dưới dạng chuỗi trong tham số lệnh gọi lại của biểu mẫu.

Cầu thủ trả bóng

TextInput – Đối tượng này, để tạo chuỗi.