Class KeyValue

KeyValue

منسوخ شده است. این کلاس منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

این کلاس منسوخ شده است. در عوض، از DecoratedText استفاده کنید.

روش ها

روش نوع برگشت شرح مختصر
setAuthorizationAction(action) KeyValue یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند.
setComposeAction(action, composedEmailType) KeyValue اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد.
setOnClickAction(action) KeyValue عملی را تنظیم می کند که با کلیک روی شی اجرا شود.
setOnClickOpenLinkAction(action) KeyValue عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند.
setOpenLink(openLink) KeyValue یک URL را تنظیم می کند که با کلیک روی شیء باز شود.
روش نوع برگشت شرح مختصر
setBottomLabel(text) KeyValue متن برچسب را برای استفاده به عنوان کلید تنظیم می کند.
setButton(button) KeyValue Button را که در سمت راست زمینه نمایش داده می شود را تنظیم می کند.
setContent(text) KeyValue متن مورد استفاده را به عنوان مقدار تنظیم می کند.
setIcon(icon) KeyValue نماد را برای استفاده به عنوان کلید تنظیم می کند.
setIconAltText(altText) KeyValue متن جایگزین را برای نماد تنظیم می کند.
setIconUrl(url) KeyValue نشانی اینترنتی نماد را برای استفاده به عنوان کلید تنظیم می کند.
setMultiline(multiline) KeyValue تنظیم می کند که متن مقدار باید در یک خط یا چند خط نمایش داده شود.
setSwitch(switchToSet) KeyValue Switch را تنظیم می کند که در سمت راست محتوا نمایش داده می شود.
setTopLabel(text) KeyValue متن برچسب را برای استفاده به عنوان کلید تنظیم می کند.

مستندات دقیق

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

پارامترها

نام تایپ کنید توضیحات
action AuthorizationAction شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


setComposeAction(action, composedEmailType)

اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد. یک شی UI فقط می تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.setGmailDraft(draft) را برمی گرداند.

// ...

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

پارامترها

نام تایپ کنید توضیحات
action Action شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
composedEmailType ComposedEmailType یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


setOnClickAction(action)

عملی را تنظیم می کند که با کلیک روی شی اجرا شود. یک شی UI فقط می تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی 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();
}

پارامترها

نام تایپ کنید توضیحات
action Action اقدامی که هنگام کلیک روی این عنصر انجام می شود.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


setOnClickOpenLinkAction(action)

عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند. زمانی که باید URL ساخته شود یا زمانی که باید اقدامات دیگری را علاوه بر ایجاد شی OpenLink انجام دهید، از این تابع استفاده کنید. یک شی UI فقط می تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی ActionResponse پیکربندی شده با استفاده از ActionResponseBuilder.setOpenLink(openLink) را برمی گرداند.

// ...

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

پارامترها

نام تایپ کنید توضیحات
action Action شیئی که عمل پیوند باز را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط می تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامترها

نام تایپ کنید توضیحات
openLink OpenLink یک شی OpenLink که URL مورد نظر را برای باز کردن توصیف می کند.

بازگشت

KeyValue - این شی، برای زنجیر کردن.

روش های منسوخ شده

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

متن برچسب را برای استفاده به عنوان کلید تنظیم می کند. در زیر متن-محتوا نمایش داده می شود.

پارامترها

نام تایپ کنید توضیحات
text String متن برچسب توجه: از قالب بندی اولیه HTML پشتیبانی نمی کند.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

Button را که در سمت راست زمینه نمایش داده می شود را تنظیم می کند. یک KeyValue فقط می تواند یک دکمه، یک سوئیچ یا یک نماد را پشتیبانی کند.

پارامترها

نام تایپ کنید توضیحات
button Button دکمه اضافه کردن

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

متن مورد استفاده را به عنوان مقدار تنظیم می کند. از قالب بندی اولیه HTML پشتیبانی می کند. مورد نیاز.

پارامترها

نام تایپ کنید توضیحات
text String محتوای متنی برای این ویجت.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نماد را برای استفاده به عنوان کلید تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
icon Icon یکی از مقادیر Icon از پیش تعریف شده.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

متن جایگزین را برای نماد تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
altText String متن جایگزین برای نماد.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

نشانی اینترنتی نماد را برای استفاده به عنوان کلید تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
url String آدرس URL یک تصویر میزبانی شده برای استفاده به عنوان نماد.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تنظیم می کند که متن مقدار باید در یک خط یا چند خط نمایش داده شود.

پارامترها

نام تایپ کنید توضیحات
multiline Boolean تنظیم چند خطی

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

Switch را تنظیم می کند که در سمت راست محتوا نمایش داده می شود. یک KeyValue فقط می تواند یک دکمه، یک سوئیچ یا یک نماد را پشتیبانی کند.

پارامترها

نام تایپ کنید توضیحات
switchToSet Switch سوئیچ برای اضافه کردن.

بازگشت

KeyValue - این شی، برای زنجیر کردن.


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

متن برچسب را برای استفاده به عنوان کلید تنظیم می کند. در بالای متن-محتوا نمایش داده می شود.

پارامترها

نام تایپ کنید توضیحات
text String متن برچسب توجه: از قالب بندی اولیه HTML پشتیبانی نمی کند.

بازگشت

KeyValue - این شی، برای زنجیر کردن.