Contacts

برای لیست روش های این منبع، انتهای این صفحه را ببینید.

بازنمایی منابع

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

{
  "kind": "mirror#contact",
  "source": string,
  "id": string,
  "displayName": string,
  "imageUrls": [
    string
  ],
  "type": string,
  "acceptTypes": [
    string
  ],
  "phoneNumber": string,
  "priority": unsigned integer,
  "acceptCommands": [
    {
      "type": string
    }
  ],
  "speakableName": string,
  "sharingFeatures": [
    string
  ]
}
نام ملک ارزش شرح یادداشت
acceptCommands[] list فهرستی از دستورات منوی صوتی که مخاطب می تواند از عهده آنها برآید. شیشه حداکثر سه مخاطب را برای هر فرمان منوی صوتی نشان می دهد. اگر بیشتر از آن وجود داشته باشد، سه مخاطب با بالاترین priority برای آن دستور خاص نشان داده می شوند. قابل نوشتن
acceptCommands[]. type string نوع عملیات مربوط به این دستور. مقادیر مجاز عبارتند از:
  • TAKE_A_NOTE - یک مورد جدول زمانی را با رونویسی گفتار کاربر از فرمان منوی صوتی "یادداشت بردارید" به اشتراک می گذارد.
  • POST_AN_UPDATE - یک مورد خط زمانی را با رونویسی گفتار کاربر از فرمان منوی صوتی "پست یک به روز رسانی" به اشتراک می گذارد.
قابل نوشتن
acceptTypes[] list لیستی از انواع MIME که یک مخاطب از آنها پشتیبانی می کند. اگر هر یک از نوع های پذیرش آن با هر یک از انواع پیوست های موجود در مورد مطابقت داشته باشد، مخاطب به کاربر نشان داده می شود. اگر هیچ نوع AcceptType داده نشود، مخاطب برای همه موارد نشان داده می شود. قابل نوشتن
displayName string نامی که برای این مخاطب نمایش داده می شود. قابل نوشتن
id string شناسه ای برای این مخاطب این توسط برنامه ایجاد می شود و به عنوان یک نشانه غیر شفاف در نظر گرفته می شود. قابل نوشتن
imageUrls[] list مجموعه ای از URL های تصویر برای نمایش برای یک مخاطب. بیشتر مخاطبین یک تصویر واحد خواهند داشت، اما یک مخاطب "گروهی" ممکن است تا 8 URL تصویر را شامل شود و اندازه آنها تغییر کرده و به صورت موزاییکی روی مشتری برش داده می شود. قابل نوشتن
kind string نوع منبع. این همیشه mirror#contact است.
phoneNumber string شماره تلفن اصلی برای مخاطب این می تواند یک شماره کاملاً واجد شرایط، با کد تماس کشور و کد منطقه، یا یک شماره محلی باشد. قابل نوشتن
priority unsigned integer اولویت برای مخاطب برای تعیین ترتیب در لیستی از مخاطبین. مخاطبین با اولویت بالاتر قبل از مخاطبین با اولویت کمتر نشان داده می شوند. قابل نوشتن
sharingFeatures[] list فهرستی از ویژگی‌های اشتراک‌گذاری که یک مخاطب می‌تواند از عهده آن برآید. مقادیر مجاز عبارتند از:
  • ADD_CAPTION
source string شناسه برنامه ای که این مخاطب را ایجاد کرده است. این توسط API پر شده است
speakableName string نام این مخاطب همانطور که باید تلفظ شود. اگر نام این مخاطب باید به عنوان بخشی از منوی ابهام‌زدایی صدا گفته شود، از این نام به عنوان تلفظ مورد انتظار استفاده می‌شود. این برای نام‌های مخاطب با نویسه‌های غیرقابل تلفظ مفید است یا املای نمایش آن‌ها در غیر این صورت آوایی نیست. قابل نوشتن
type string نوع این مخاطب این برای مرتب سازی در UI ها استفاده می شود. مقادیر مجاز عبارتند از:
  • INDIVIDUAL - نماینده یک فرد مجرد است. این پیش فرض است.
  • GROUP - بیش از یک نفر را نشان می دهد.
قابل نوشتن

مواد و روش ها

حذف
مخاطب را حذف می کند.
گرفتن
یک مخاطب را با شناسه دریافت می کند.
درج کنید
یک مخاطب جدید درج می کند.
فهرست
لیستی از مخاطبین را برای کاربر احراز هویت شده بازیابی می کند.
پچ
یک مخاطب را در جای خود به روز می کند. این روش از معنای پچ پشتیبانی می کند.
به روز رسانی
یک مخاطب را در جای خود به روز می کند.