مرجع Google Picker API

این صفحه شامل فهرستی از کلاس‌ها، روش‌ها و انواع برشماری موجود در Google Picker API است. همه این عناصر به فضای نام google.picker.* 2 نوع کلاس و نوع شمارش شده وجود دارد: آنهایی که برای ساخت و پیکربندی Google Picker استفاده می شوند و آنهایی که پس از انتخاب کاربر توسط Google Picker برگردانده می شوند. مورد

کلاس ها و انواع پیکربندی

کلاس ها و انواع برشمرده شده زیر برای ساخت و پیکربندی Google Picker استفاده می شود.

DocsUploadView

از DocsUploadView برای آپلود اسناد در Google Drive استفاده کنید.

DocsUploadView() سازنده.
DocsUploadView.setIncludeFolders(boolean) به کاربر امکان می‌دهد پوشه‌ای را در Google Drive برای آپلود انتخاب کند.
DocsUploadView.setParent(string) مقصد آپلود را روی پوشه مشخص شده تنظیم می کند. این گزینه setIncludeFolders به false لغو می کند.

DocsView

DocsView یک زیر کلاس از View است که می تواند برای نمایش های Google Drive استفاده شود.

DocsView( ViewId | undefined) سازنده. ViewId باید یکی از نماهای Google Drive باشد. پیش فرض ViewId.DOCS است.
DocsView.setEnableDrives(boolean) درایوهای مشترک و فایل های موجود در آنها را نشان می دهد. قبل از فعال کردن، به اسناد Google Drive API برای فعال کردن درایوهای مشترک مراجعه کنید.
DocsView.setIncludeFolders(boolean) نمایش پوشه ها در موارد مشاهده با setOwnedByMe ترکیب نکنید. وقتی setIncludeFolders(true) تنظیم شود، setOwnedByMe نادیده گرفته می شود.
DocsView.setSelectFolderEnabled(boolean) به کاربر امکان می‌دهد پوشه‌ای را در Google Drive انتخاب کند.
DocsView.setMode( DocsViewMode ) حالتی را که نما برای نمایش اسناد استفاده می کند، انتخاب می کند.
DocsView.setOwnedByMe(boolean | undefined) اسناد را بر اساس اینکه متعلق به کاربر است یا به اشتراک گذاشته شده با کاربر فیلتر می کند. این تنظیم را با setIncludeFolders ترکیب نکنید. وقتی setIncludeFolders(true) تنظیم شود، setOwnedByMe نادیده گرفته می شود.
DocsView.setParent(string) پوشه والد اولیه را برای نمایش تنظیم می کند.
DocsView.setStarred(boolean) اسناد را بر اساس ستاره‌دار بودن کاربر فیلتر می‌کند.

DocsViewMode

DocsViewMode یک نوع شمارش شده برای نمایش داده ها در یک DocsView است. از این مقادیر در تماس با DocsView.setMode استفاده کنید.

DocsViewMode.GRID نمایش اسناد در یک شبکه بندانگشتی
DocsViewMode.LIST نمایش اسناد در یک لیست دقیق

ویژگی

Feature یک نوع برشماری است، برای روشن/خاموش کردن ویژگی‌ها برای نماهای مختلف. از این مقادیر در تماس با PickerBuilder.enableFeature و PickerBuilder.disableFeature استفاده کنید.

Feature.MINE_ONLY هنگام نمایش موارد از Google Drive فقط اسناد متعلق به کاربر را نشان دهید.
Feature.MULTISELECT_ENABLED به کاربر اجازه می دهد تا بیش از یک مورد را انتخاب کند.
Feature.NAV_HIDDEN پنجره ناوبری را مخفی کنید. اگر صفحه ناوبری پنهان باشد، کاربران فقط می توانند از اولین نمای انتخابی انتخاب کنند.
Feature.SIMPLE_UPLOAD_ENABLED برای آپلود عکس، فعال بودن انتخاب هر عکس (برخلاف هر آلبوم) را کنترل می کند.
Feature.SUPPORT_DRIVES

منسوخ شده: موارد درایو مشترک اکنون به طور پیش فرض گنجانده شده است.

آیا موارد درایو مشترک در نتایج گنجانده شده است یا خیر.

انتخابگر

Picker شی سطح بالایی است که عملکرد UI را با کاربر نشان می دهد. این اشیا مستقیما ایجاد نمی شوند، بلکه از شی PickerBuilder استفاده می کنند.

Picker.isVisible() یک بولی دریافت کنید که نمایان بودن Picker فعلی را نشان می دهد.
Picker.setCallback(function(object)) هر زمان که کاربر موردی را انتخاب کرد (یا لغو کرد) روش برگشت تماس را مشخص کنید.
Picker.setRelayUrl(string) یک URL رله را برای دور زدن مشکلات بین دامنه مشخص کنید.
Picker.setVisible(boolean) قابلیت مشاهده شی Picker را کنترل کنید.
Picker.dispose() شی Picker را دفع می کند.

PickerBuilder

PickerBuilder برای ایجاد اشیاء Picker استفاده می شود. به جز مواردی که در غیر این صورت ذکر شده است، نوع برگشت روش های زیر از نوع PickerBuilder است که به شما امکان می دهد یک تماس را پس از دیگری زنجیره ای کنید. برای استفاده معمولی ، نمونه کد Google Picker را ببینید.

PickerBuilder() سازنده.
PickerBuilder.addView( View | ViewId ) یک View به صفحه پیمایش اضافه کنید.
PickerBuilder.addViewGroup( ViewGroup ) یک ViewGroup به صفحه ناوبری سطح بالا اضافه کنید.
PickerBuilder.build() شی Picker را بسازید. شی Picker برگردانده می شود.
PickerBuilder.disableFeature( Feature ) یک ویژگی انتخابگر را غیرفعال کنید.
PickerBuilder.enableFeature( Feature ) یک ویژگی انتخابگر را فعال کنید.
PickerBuilder.getRelayUrl() URL رله مورد استفاده برای gadgets.rpc را دریافت کنید.
PickerBuilder.getTitle() عنوان گفتگو را دریافت کنید.
PickerBuilder.hideTitleBar() غیرفعال کردن نمایش نوار عنوان برای فعال کردن مجدد، setTitle با عنوانی غیر خالی یا نامشخص تماس بگیرید.
PickerBuilder.isFeatureEnabled( Feature ) بررسی کنید که آیا Feature انتخابگر فعال است یا خیر.
PickerBuilder.setAppId(string) شناسه برنامه Google Drive را تنظیم می‌کند تا به برنامه اجازه دهد از طریق Google Drive API به فایل‌های کاربر دسترسی داشته باشد.
PickerBuilder.setCallback(method) روش برگشت تماس را تنظیم کنید. این روش زمانی فراخوانی می شود که کاربر مواردی را انتخاب کرده یا لغو کند. متد callback یک شیء پاسخ به تماس را دریافت می کند. ساختار شی بازگشت به تماس در راهنمای JSON توضیح داده شده است.
PickerBuilder.setDeveloperKey(string) کلید API مرورگر به‌دست‌آمده از Google API Console را تنظیم می‌کند. برای جزئیات بیشتر در مورد نحوه به دست آوردن کلید API مرورگر، به راهنمای توسعه دهنده مراجعه کنید.
PickerBuilder.setDocument(document) سند را تنظیم کنید.
PickerBuilder.setLocale(string) کد زبان ISO 639. اگر زبان پشتیبانی نمی شود، از en-US استفاده می شود. این روش جایگزینی برای تنظیم محلی در زمان google.load() ارائه می دهد. برای فهرستی از مناطق پشتیبانی شده، به راهنمای برنامه نویس مراجعه کنید.
PickerBuilder.setMaxItems(number) حداکثر تعداد مواردی را که کاربر می تواند انتخاب کند را تنظیم می کند.
PickerBuilder.setOAuthToken(string) یک نشانه OAuth را برای تأیید اعتبار کاربر فعلی تنظیم می کند. بسته به محدوده توکن، فقط نماهای خاصی داده ها را نمایش می دهند. دامنه‌های معتبر Google Docs و Drive هستند.
PickerBuilder.setOrigin(string) مبدا گفتگوی Google Picker را تنظیم می کند. اگر برنامه شما در iframe اجرا می شود، مبدا باید روی window.location.protocol + '//' + window.location.host بالای صفحه تنظیم شود.
PickerBuilder.setRelayUrl(string) URL رله مورد استفاده برای gadgets.rpc را تنظیم کنید.
PickerBuilder.setSelectableMimeTypes(string) لیستی از انواع MIME قابل انتخاب را تنظیم کنید. اگر بیش از یک مورد نیاز است، از کاما برای جدا کردن انواع MIME استفاده کنید.
PickerBuilder.setSize() اندازه گفتگوی دلخواه را تنظیم کنید. گفتگو به صورت خودکار در مرکز قرار می گیرد. حداقل اندازه (566,350) و حداکثر اندازه (1051,650) است.
PickerBuilder.setTitle(string) عنوان گفتگو را تنظیم کنید.
PickerBuilder.toUri() URI تولید شده توسط این سازنده را برمی گرداند.

شناسه منبع

ResourceId یک کلاس ثابت است که برای تولید شناسه های منبع مناسب برای API فهرست اسناد Google استفاده می شود.

ResourceId.generate( Document ) یک شی سند را به شناسه منبع نگاشت کنید.

چشم انداز

View کلاس پایه انتزاعی برای کلاس های View مختلف، مانند DocsView است.

View( ViewId ) سازنده.
View.getId() ViewId را برای این نما برمی‌گرداند.
View.setMimeTypes(string) انواع MIME موجود در نما را تنظیم می کند. اگر بیش از یک مورد نیاز است، از کاما برای جدا کردن انواع MIME استفاده کنید. اگر انواع MIME را تنظیم نکنید، فایل‌های همه انواع MIME در نمای نمایش داده می‌شوند.
View.setQuery(string) برای نماهایی که شامل جستجو هستند، عبارت جستجو را از قبل با این عبارات پر کنید.

ViewGroup

ViewGroup یک گروه بندی بصری از نماها است. مورد ریشه خود ViewGroup باید View باشد.

ViewGroup( View | ViewId ) ViewGroup یک گروه بندی بصری از نماها در صفحه ناوبری است. مورد ریشه خود ViewGroup باید View باشد.
ViewGroup.addLabel(string) یک برچسب به این ViewGroup اضافه کنید.
ViewGroup.addView( ViewId | View ) یک نما به ViewGroup اضافه کنید. View می توان با یک شی مشتق از view یا به سادگی با ViewId نشان داد.
ViewGroup.addViewGroup( ViewGroup ) یک ViewGroup در ViewGroup فعلی قرار دهید.

ViewId

ViewId یک نوع شمارش شده است که برای ساخت اشیاء View و ViewGroup استفاده می شود.

ViewId.DOCS همه انواع سند Google Drive.
ViewId.DOCS_IMAGES عکس های گوگل درایو
ViewId.DOCS_IMAGES_AND_VIDEOS عکس‌ها و ویدیوهای Google Drive.
ViewId.DOCS_VIDEOS ویدیوهای Google Drive.
ViewId.DOCUMENTS اسناد Google Drive.
ViewId.DRAWINGS نقشه های گوگل درایو.
ViewId.FOLDERS پوشه های گوگل درایو
ViewId.FORMS فرم های گوگل درایو
ViewId.PDFS فایل های PDF ذخیره شده در Google Drive.
ViewId.PRESENTATIONS ارائه های گوگل درایو.
ViewId.SPREADSHEETS صفحات گسترده Google Drive.

انواع پاسخ به تماس

انواع برشمرده شده زیر در داده های برگشت به تماس که توسط Google Picker API برگردانده شده است، یافت می شود.

عمل

Action یک نوع برشماری شده است که نشان دهنده اقدام کاربر برای رد کردن گفتگو است. این مقدار در فیلد Response.ACTION در داده های برگشت به تماس است.

Action.CANCEL کاربر گفتگوی Google Picker را لغو کرد.
Action.PICKED کاربر حداقل یک مورد را انتخاب کرده است.

سند

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

Document.DESCRIPTION توضیحی که توسط کاربر از مورد انتخاب شده ارائه شده است.
Document.DURATION مدت زمان یک ویدیوی انتخابی.
Document.EMBEDDABLE_URL یک URL برای این مورد مناسب برای جاسازی در یک صفحه وب.
Document.ICON_URL نشانی وب به یک نماد برای این مورد.
Document.ID شناسه مورد انتخاب شده
Document.IS_NEW اگر مورد انتخابی به تازگی آپلود شده باشد، مقدار true را برمی گرداند.
Document.LAST_EDITED_UTC مهر زمانی که آخرین ویرایش این مورد را توصیف می کند.
Document.MIME_TYPE نوع MIME این مورد.
Document.NAME نام این مورد.
Document.NUM_CHILDREN تعداد فرزندان موجود در این مورد. به عنوان مثال، تعداد فایل های موجود در پوشه انتخاب شده.
Document.PARENT_ID شناسه والد این مورد. به عنوان مثال، پوشه حاوی این فایل.
Document.SERVICE_ID یک ServiceId که خدماتی را که این مورد از آن تشریح می‌کند انتخاب شده است.
Document.THUMBNAILS آرایه ای از Thumbnail که ویژگی های یک عکس یا ویدیو را توصیف می کند. اگر موارد انتخابی متعلق به Google Drive باشد، تصاویر کوچک برگردانده نمی‌شوند.
Document.TYPE Type مورد انتخاب شده
Document.URL آدرس اینترنتی این مورد.

واکنش

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

Response.ACTION یک نوع Action که نشان دهنده اقدام کاربر برای رد کردن گفتگو است.
Response.DOCUMENTS آرایه ای از Document توسط کاربر انتخاب شده است.
Response.PARENTS شناسه‌های پوشه‌های والد برای موارد انتخاب شده. (به عنوان مثال، شناسه های پوشه های والد که فایل های آنها انتخاب شده است.)
Response.VIEW View کاربر این موارد را از آن انتخاب کرده است.

شناسه سرویس

ServiceId یک نوع شمارش شده است که برای توصیف سرویسی که مورد از آن انتخاب شده است استفاده می شود. این مقدار در قسمت Document.SERVICE_ID Document انتخاب شده است.

ServiceId.DOCS درایو گوگل.

بند انگشتی

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

Thumbnail.HEIGHT ارتفاع عکس یا ویدیو بر حسب پیکسل.
Thumbnail.WIDTH عرض عکس یا ویدیو بر حسب پیکسل.
Thumbnail.URL نشانی اینترنتی عکس یا ویدیوی انتخابی.

نوع

Type یک نوع برشماری است که برای دسته بندی آیتم انتخاب شده استفاده می شود. این مقدار را می توان در قسمت Document.TYPE یک Document انتخابی یافت.

Type.DOCUMENT مورد یک سند است.
Type.PHOTO مورد یک عکس است.
Type.VIDEO مورد یک ویدیو است.