Class DecoratedText

DecoratedText

선택적 장식과 함께 텍스트를 표시하는 위젯입니다. 가능한 키에는 아이콘, 위의 라벨, 아래의 라벨이 있습니다. setText(text)DecoratedText, DecoratedText, setTopLabel(text), setBottomLabel(text) 중 하나를 사용하여 텍스트 콘텐츠와 키 중 하나를 설정해야 합니다. 이 클래스는 KeyValue를 대체하기 위한 클래스입니다.

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

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var multilineDecoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel")
    .setWrapText(true)
    .setBottomLabel("BottomLabel");

방법

메서드반환 유형간략한 설명
setAuthorizationAction(action)DecoratedText객체를 클릭하면 승인 흐름의 URL을 여는 승인 작업을 설정합니다.
setBottomLabel(text)DecoratedText키로 사용할 라벨 텍스트를 설정하고 텍스트 콘텐츠 아래에 표시됩니다.
setButton(button)DecoratedText텍스트 오른쪽에 표시되는 Button를 설정합니다.
setComposeAction(action, composedEmailType)DecoratedText객체를 클릭하면 초안 이메일을 작성하는 작업을 설정합니다.
setEndIcon(endIcon)DecoratedText콘텐츠 오른쪽에 표시되는 선택적 IconImage를 설정합니다.
setOnClickAction(action)DecoratedText객체를 클릭할 때 실행되는 작업을 설정합니다.
setOnClickOpenLinkAction(action)DecoratedText객체를 클릭하면 탭에서 URL을 여는 작업을 설정합니다.
setOpenLink(openLink)DecoratedText객체를 클릭하면 열릴 URL을 설정합니다.
setStartIcon(startIcon)DecoratedText텍스트 콘텐츠 앞에 표시할 IconImage(선택사항)를 설정합니다.
setSwitchControl(switchToSet)DecoratedText콘텐츠 오른쪽에 표시되는 Switch를 설정합니다.
setText(text)DecoratedText값으로 사용할 텍스트를 설정합니다.
setTopLabel(text)DecoratedText키로 사용하고 텍스트 콘텐츠 위에 표시되도록 라벨 텍스트를 설정합니다.
setWrapText(wrapText)DecoratedText값 텍스트를 한 줄에 표시해야 하는지 여러 줄로 표시할지 설정합니다.

자세한 문서

setAuthorizationAction(action)

객체를 클릭하면 승인 흐름의 URL을 여는 승인 작업을 설정합니다. 그러면 새 창에서 URL이 열립니다. 사용자가 승인 흐름을 완료하고 애플리케이션으로 돌아오면 부가기능이 새로고침됩니다.

UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

// ...

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

매개변수

이름유형설명
actionAuthorizationAction이 요소를 클릭할 때 실행할 승인 작업을 지정하는 객체입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setBottomLabel(text)

키로 사용할 라벨 텍스트를 설정하고 텍스트 콘텐츠 아래에 표시됩니다.

매개변수

이름유형설명
textString라벨 텍스트입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setButton(button)

텍스트 오른쪽에 표시되는 Button를 설정합니다. DecoratedText는 버튼 한 개 또는 스위치 한 개만 지원할 수 있습니다.

매개변수

이름유형설명
buttonButton추가할 버튼입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setComposeAction(action, composedEmailType)

객체를 클릭하면 초안 이메일을 작성하는 작업을 설정합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ComposeActionResponseBuilder.setGmailDraft(draft)를 사용하여 구성된 ComposeActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

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

매개변수

이름유형설명
actionAction이 요소를 클릭할 때 실행할 작성 작업을 지정하는 객체입니다.
composedEmailTypeComposedEmailType작성된 초안이 독립형인지 답장 초안인지 지정하는 열거형 값입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setEndIcon(endIcon)

콘텐츠 오른쪽에 표시되는 선택적 IconImage를 설정합니다. DecoratedText는 버튼 1개, 스위치 1개 또는 아이콘 1개만 지원할 수 있습니다.

매개변수

이름유형설명
endIconIconImage추가할 아이콘입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setOnClickAction(action)

객체를 클릭할 때 실행되는 작업을 설정합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

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

매개변수

이름유형설명
actionAction이 요소를 클릭하면 수행할 작업입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setOnClickOpenLinkAction(action)

객체를 클릭하면 탭에서 URL을 여는 작업을 설정합니다. URL을 빌드해야 하거나 OpenLink 객체를 만드는 것과 더불어 다른 작업을 해야 하는 경우 이 함수를 사용합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponseBuilder.setOpenLink(openLink)를 사용하여 구성된 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

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

매개변수

이름유형설명
actionAction이 요소를 클릭할 때 실행할 링크 열기 작업을 지정하는 객체입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


객체를 클릭하면 열릴 URL을 설정합니다. URL이 이미 알려져 있고 URL을 열어야 하는 경우 이 함수를 사용합니다. UI 객체에는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

매개변수

이름유형설명
openLinkOpenLink열려는 URL을 설명하는 OpenLink 객체입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setStartIcon(startIcon)

텍스트 콘텐츠 앞에 표시할 IconImage(선택사항)를 설정합니다.

매개변수

이름유형설명
startIconIconImage표시할 아이콘입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setSwitchControl(switchToSet)

콘텐츠 오른쪽에 표시되는 Switch를 설정합니다. DecoratedText는 버튼 한 개 또는 스위치 한 개만 지원할 수 있습니다.

매개변수

이름유형설명
switchToSetSwitch추가할 스위치입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setText(text)

값으로 사용할 텍스트를 설정합니다. 기본 HTML 형식을 지원합니다. 필수 항목입니다.

매개변수

이름유형설명
textString이 위젯의 텍스트 콘텐츠입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setTopLabel(text)

키로 사용하고 텍스트 콘텐츠 위에 표시되도록 라벨 텍스트를 설정합니다.

매개변수

이름유형설명
textString라벨 텍스트입니다.

리턴

DecoratedText: 체이닝용 객체입니다.


setWrapText(wrapText)

값 텍스트를 한 줄에 표시해야 하는지 여러 줄로 표시할지 설정합니다.

매개변수

이름유형설명
wrapTextBooleantrue인 경우 텍스트가 래핑되어 여러 줄로 표시됩니다. 그렇지 않으면 텍스트가 잘립니다.

리턴

DecoratedText: 체이닝용 객체입니다.