Class HtmlService

سرویس اچ‌تی‌ام‌ال

سرویسی برای برگرداندن HTML و سایر محتوای متنی از یک اسکریپت.

به دلیل ملاحظات امنیتی، اسکریپت‌ها نمی‌توانند مستقیماً محتوا را به مرورگر برگردانند. در عوض، آنها باید HTML را پاکسازی کنند تا نتواند اقدامات مخرب انجام دهد. برای اطلاع از محدودیت‌های این موضوع در مورد آنچه می‌تواند برگرداند، به توضیحات HtmlOutput مراجعه کنید.

خواص

ملک نوع توضیحات
Sandbox Mode Sandbox Mode یک enum که حالت‌های sandbox را نشان می‌دهد که می‌توانند برای اسکریپت‌های Html Service سمت کلاینت استفاده شوند.
XFrameOptionsMode XFrameOptionsMode یک enum که حالت‌های X-Frame-Options را نشان می‌دهد که می‌توانند برای اسکریپت‌های Html Service سمت کلاینت استفاده شوند.

روش‌ها

روش نوع بازگشتی شرح مختصر
create Html Output() Html Output یک شیء Html Output جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.
create Html Output(blob) Html Output یک شیء Html Output جدید از یک منبع Blob Source ایجاد می‌کند.
create Html Output(html) Html Output یک شیء Html Output جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.
create Html Output From File(filename) Html Output یک شیء Html Output جدید از یک فایل در ویرایشگر کد ایجاد می‌کند.
create Template(blob) Html Template یک شیء Html Template جدید از یک منبع Blob Source ایجاد می‌کند.
create Template(html) Html Template یک شیء Html Template جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.
create Template From File(filename) Html Template یک شیء Html Template جدید از یک فایل در ویرایشگر کد ایجاد می‌کند.
get User Agent() String رشته‌ی user-agent مرورگر فعلی را دریافت می‌کند.

مستندات دقیق

createHtmlOutput()

یک شیء HtmlOutput جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.

const output = HtmlService.createHtmlOutput();

بازگشت

HtmlOutput - شیء جدید HtmlOutput

createHtmlOutput(blob)

یک شیء HtmlOutput جدید از منبع BlobSource ایجاد می‌کند.

function createFromBlob(blob) {
  const output = HtmlService.createHtmlOutput(blob);
  return output;
}

پارامترها

نام نوع توضیحات
blob Blob Source شیء برای دریافت HTML از

بازگشت

HtmlOutput - شیء جدید HtmlOutput

پرتاب‌ها

Error - اگر blob حاوی HTML نباشد یا HTML ناقص باشد

createHtmlOutput(html)

یک شیء HtmlOutput جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.

const output = HtmlService.createHtmlOutput('<b>Hello world!</b>');

پارامترها

نام نوع توضیحات
html String محتوایی که قرار است ارائه شود

بازگشت

HtmlOutput - شیء جدید HtmlOutput

پرتاب‌ها

Error - اگر html ناقص باشد

createHtmlOutputFromFile(filename)

یک شیء HtmlOutput جدید از یک فایل در ویرایشگر کد ایجاد می‌کند.

const output = HtmlService.createHtmlOutputFromFile('myPage');

پارامترها

نام نوع توضیحات
filename String نام فایل مورد استفاده

بازگشت

HtmlOutput - شیء جدید HtmlOutput

پرتاب‌ها

Error - اگر فایل پیدا نشد یا HTML موجود در آن ناقص است

createTemplate(blob)

یک شیء HtmlTemplate جدید از منبع BlobSource ایجاد می‌کند.

function createFromBlob(blob) {
  const template = HtmlService.createTemplate(blob);
  const output = template.evaluate();
  return output;
}

پارامترها

نام نوع توضیحات
blob Blob Source شیء‌ای که قرار است HTML از آن استخراج شود.

بازگشت

HtmlTemplate - شیء جدید HtmlTemplate

پرتاب‌ها

Error - اگر blob حاوی HTML نباشد

createTemplate(html)

یک شیء HtmlTemplate جدید ایجاد می‌کند که می‌تواند از اسکریپت برگردانده شود.

const template = HtmlService.createTemplate(
    '<b>The time is &lt;?= new Date() ?&gt;</b>',
);

پارامترها

نام نوع توضیحات
html String محتوای الگو

بازگشت

HtmlTemplate - شیء جدید HtmlTemplate

createTemplateFromFile(filename)

یک شیء HtmlTemplate جدید از یک فایل در ویرایشگر کد ایجاد می‌کند.

const template = HtmlService.createTemplateFromFile('myTemplate');

پارامترها

نام نوع توضیحات
filename String نام فایل مورد استفاده

بازگشت

HtmlTemplate - شیء جدید HtmlTemplate

پرتاب‌ها

Error — اگر فایل پیدا نشد

getUserAgent()

رشته‌ی عامل کاربر (user-agent) را برای مرورگر فعلی دریافت می‌کند. اگر در تابع doGet() یا doPost() یک برنامه‌ی وب استفاده نشود، برای اکثر اجراهای اسکریپت null برمی‌گرداند.

بازگشت

String - رشته‌ی عامل کاربر