REST Resource: sites.channels

منبع: کانال

یک Channel نشان دهنده جریانی از انتشارات برای یک سایت است. همه سایت‌ها دارای یک کانال live پیش‌فرض هستند که محتوا را به زیر دامنه‌های ارائه‌شده توسط Firebase و هر دامنه سفارشی متصل ارائه می‌کند.

نمایندگی JSON
{
  "name": string,
  "url": string,
  "release": {
    object (Release)
  },
  "createTime": string,
  "updateTime": string,
  "retainedReleaseCount": integer,
  "labels": {
    string: string,
    ...
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
زمینه های
name

string

نام منبع کاملاً واجد شرایط برای کانال، در قالب:

sites/ SITE_ID /channels/ CHANNEL_ID

url

string

فقط خروجی نشانی اینترنتی که در آن محتوای نسخه فعلی این کانال قابل مشاهده است. این نشانی وب یک زیر دامنه ارائه شده توسط Firebase از web.app است.

محتوای نسخه فعلی این کانال را نیز می‌توانید در زیر دامنه Firebase در firebaseapp.com مشاهده کنید.

اگر این کانال کانال live برای سایت میزبانی وب است، پس محتوای نسخه فعلی این کانال نیز در هر دامنه سفارشی متصل قابل مشاهده است.

release

object ( Release )

فقط خروجی نسخه فعلی برای کانال، در صورت وجود.

createTime

string ( Timestamp format)

فقط خروجی زمانی که کانال ایجاد شد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

فقط خروجی زمانی که کانال آخرین بار به روز شد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

retainedReleaseCount

integer

تعداد نسخه‌های قبلی که برای بازگرداندن یا اهداف دیگر در کانال باقی می‌مانند.

باید عددی بین 1 تا 100 باشد. پیش‌فرض برای کانال‌های جدید 10 است.

labels

map (key: string, value: string)

برچسب‌های متنی که برای ابرداده‌های اضافی و/یا فیلتر کردن استفاده می‌شوند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

expiration میدان اتحادیه

expiration فقط می تواند یکی از موارد زیر باشد:

expireTime

string ( Timestamp format)

زمانی که کانال به طور خودکار حذف می شود.

در صورت تهی بودن، کانال به طور خودکار حذف نمی شود. این فیلد در خروجی وجود دارد که مستقیماً تنظیم شده باشد یا از طریق فیلد ttl .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

ttl

string ( Duration format)

فقط ورودی زمانی برای زندگی برای این کانال. expireTime را روی مدت زمان ارائه شده گذشته از زمان درخواست تنظیم می کند.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

مواد و روش ها

create

 یک کانال جدید در سایت مشخص شده ایجاد می کند.

delete

 کانال مشخص شده سایت مشخص شده را حذف می کند.

get

 اطلاعات کانال مشخص شده سایت مشخص شده را بازیابی می کند.

list

 کانال ها را برای سایت مشخص شده لیست می کند.

patch

 اطلاعات کانال مشخص شده سایت مشخص شده را به روز می کند.