Class TextInput

TextInput

텍스트 입력을 허용하는 입력란 위젯입니다.

Google Workspace 부가기능 및 Google Chat 앱에서 사용할 수 있습니다.

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

메서드

메서드반환 유형간략한 설명
setFieldName(fieldName)TextInputUI 상호작용이 있을 때 생성되는 이벤트 객체에서 이 텍스트 입력을 식별하는 키를 설정합니다.
setHint(hint)TextInput텍스트 입력의 힌트를 설정합니다.
setMultiline(multiline)TextInput입력 텍스트가 한 줄에 표시되는지 여러 줄에 표시되는지 설정합니다.
setOnChangeAction(action)TextInput텍스트 입력이 변경될 때마다 실행할 작업을 설정합니다.
setSuggestions(suggestions)TextInput텍스트 필드에 자동 완성 추천을 설정합니다.
setSuggestionsAction(suggestionsAction)TextInput자동 완성을 위해 사용자 입력을 기반으로 추천을 가져오도록 콜백 작업을 설정합니다.
setTitle(title)TextInput입력란 위에 표시할 제목을 설정합니다.
setValidation(validation)TextInput이 위젯의 유효성 검사 규칙을 설정합니다.
setValue(value)TextInput입력란에 미리 채워질 값을 설정합니다.

자세한 문서

setFieldName(fieldName)

UI 상호작용이 있을 때 생성되는 이벤트 객체에서 이 텍스트 입력을 식별하는 키를 설정합니다. 사용자에게 표시되지 않습니다. 필수사항이며 고유해야 합니다.

매개변수

이름유형설명
fieldNameString이 입력을 식별하는 데 사용되는 키입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setHint(hint)

텍스트 입력의 힌트를 설정합니다. 사용자에게 입력할 내용에 관한 추가 안내를 제공하는 데 사용됩니다. 예를 들어 힌트는 전화번호 필드의 형식 ('xxx-xxx-xxxx')을 설명할 수 있습니다.

매개변수

이름유형설명
hintString입력란 아래에 표시할 텍스트 힌트입니다. 이 텍스트는 항상 표시됩니다.

리턴

TextInput: 연결을 위한 객체입니다.


setMultiline(multiline)

입력 텍스트가 한 줄에 표시되는지 여러 줄에 표시되는지 설정합니다.

매개변수

이름유형설명
multilineBoolean여러 줄 설정

리턴

TextInput: 연결을 위한 객체입니다.


setOnChangeAction(action)

텍스트 입력이 변경될 때마다 실행할 작업을 설정합니다.

매개변수

이름유형설명
actionAction수행할 작업입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setSuggestions(suggestions)

텍스트 필드에 자동 완성 추천을 설정합니다.

매개변수

이름유형설명
suggestionsSuggestions사용할 추천 모음입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setSuggestionsAction(suggestionsAction)

자동 완성을 위해 사용자 입력을 기반으로 추천을 가져오도록 콜백 작업을 설정합니다. Action 매개변수는 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();
}

매개변수

이름유형설명
suggestionsActionAction이 입력에 대한 추천을 가져오는 작업입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setTitle(title)

입력란 위에 표시할 제목을 설정합니다. 필수 항목입니다.

매개변수

이름유형설명
titleString이 입력의 텍스트 라벨입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setValidation(validation)

이 위젯의 유효성 검사 규칙을 설정합니다.

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

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

매개변수

이름유형설명
validationValidationTextInput 위젯의 유효성 검사 규칙입니다.

리턴

TextInput: 연결을 위한 객체입니다.


setValue(value)

입력란에 미리 채워질 값을 설정합니다.

매개변수

이름유형설명
valueString입력에 배치된 기본값입니다. 항상 양식 콜백 매개변수에서 문자열로 표현됩니다.

리턴

TextInput: 연결을 위한 객체입니다.