تضم هذه الصفحة قائمة بالفئات والطرق والأنواع العددية المتوفرة في
Google Picker API. تنتمي جميع هذه العناصر إلى مساحة الاسم google.picker.*
هناك نوعان من الفئات والأنواع العددية: العناصر التي يتم استخدامها لإنشاء
"أداة اختيار Google" وإعدادها، وتلك التي يتم عرضها بواسطة "أداة اختيار Google" بعد أن يختار المستخدم عنصرًا.
فئات الضبط وأنواعه
تُستخدم الفئات والأنواع التعداد التالية لإنشاء أداة اختيار Google وضبطها.
DocsUploadView
استخدِم "DocsUploadView" لتحميل المستندات إلى Google Drive.
DocsUploadView() | منشئ. |
DocsUploadView.setIncludeFolders(boolean) | يسمح هذا الخيار للمستخدم باختيار مجلد في Google Drive للتحميل إليه. |
DocsUploadView.setParent(string) | لضبط وجهة التحميل على المجلد المحدّد. يؤدي هذا الإجراء إلى إلغاء ضبط السمة setIncludeFolders على القيمة "خطأ". |
DocsView
DocsView هي فئة فرعية من View يمكن استخدامها للملفات الشخصية على Google Drive.
DocsView(ViewId | undefined) | منشئ. يجب أن تكون ViewId إحدى طرق العرض في Google Drive. الإعداد التلقائي هو ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | يعرض مساحات التخزين السحابي المشتركة والملفات التي تحتوي عليها. قبل التفعيل، يمكنك الاطّلاع على مستندات واجهة برمجة تطبيقات Google Drive لتفعيل مساحات التخزين السحابي المشتركة. |
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 هو كائن المستوى الأعلى الذي يمثّل إجراء واجهة المستخدم مع المستخدم. لا يتم إنشاء هذه العناصر مباشرةً، ولكن يمكنك استخدام الكائن PickerBuilder بدلاً من ذلك.
Picker.isVisible() | الحصول على قيمة منطقية تشير إلى مستوى رؤية "أداة الاختيار" الحالية |
Picker.setCallback(function(object)) | حدِّد طريقة معاودة الاتصال التي يتم استدعاؤها كلما اختار المستخدم عنصرًا (أو يلغيه). |
Picker.setRelayUrl(string) | تحديد عنوان URL للإرسال للتحايل على المشاكل في جميع النطاقات |
Picker.setVisible(boolean) | يمكنك التحكّم في إذن الوصول إلى عنصر "أداة الاختيار". |
Picker.dispose() | التخلص من كائن "المنتقي". |
PickerBuilder
يتم استخدام PickerBuilder لإنشاء عناصر Picker. ما لم يُذكر خلاف ذلك، يكون نوع إرجاع الطرق أدناه من النوع PickerBuilder، ما يتيح لك إجراء سلسلة من الاستدعاءات بعد الأخرى. يمكنك الاطّلاع على نموذج رمز منتقي Google للاستخدام العادي.
PickerBuilder() | منشئ. |
PickerBuilder.addView( | أضِف View إلى مساحة الروابط. |
PickerBuilder.addViewGroup(ViewGroup) | أضِف ViewGroup إلى مساحة الروابط في المستوى الأعلى. |
PickerBuilder.build() | أنشئ كائن "المنتقي". يتم عرض كائن "المنتقي". |
PickerBuilder.disableFeature(Feature) | إيقاف إحدى ميزات أداة الاختيار |
PickerBuilder.enableFeature(Feature) | تفعيل إحدى ميزات أداة الاختيار |
PickerBuilder.getRelayUrl() | احصل على عنوان URL الخاص بالإرسال، والمستخدَم في الأدوات.rpc. |
PickerBuilder.getTitle() | الحصول على عنوان مربّع الحوار |
PickerBuilder.hideTitleBar() | إيقاف ظهور شريط العناوين لإعادة تفعيله، يمكنك استدعاء الرقم setTitle باستخدام عنوان غير فارغ أو غير محدّد. |
PickerBuilder.isFeatureEnabled(Feature) | تحقَّق من تفعيل أداة الاختيار Feature. |
PickerBuilder.setAppId(string) | تحدِّد رقم تعريف تطبيق Google Drive المطلوب للسماح للتطبيق بالوصول إلى ملفات المستخدم عبر Google Drive API. |
PickerBuilder.setCallback(method) | اضبط طريقة معاودة الاتصال. يتم استدعاء هذه الطريقة عندما يختار المستخدم عناصر أو يلغيها. تتلقى طريقة رد الاتصال كائن استدعاء واحد. يمكنك الاطّلاع على بنية كائن معاودة الاتصال في دليل JSON. |
PickerBuilder.setDeveloperKey(string) | لضبط مفتاح واجهة برمجة تطبيقات المتصفّح الذي تم الحصول عليه من وحدة التحكم في واجهة Google API. راجِع دليل المطوّر لمعرفة التفاصيل حول كيفية الحصول على مفتاح واجهة برمجة تطبيقات المتصفّح. |
PickerBuilder.setDocument(document) | اضبط المستند. |
PickerBuilder.setLocale(string) | رمز اللغة وفقًا لمعيار ISO 639 وإذا لم تكن اللغة متوفرة، يتم استخدام en-US. توفر هذه الطريقة بديلاً لضبط اللغة في وقت google.load(). راجِع دليل مطوّر البرامج للحصول على قائمة باللغات المتاحة. |
PickerBuilder.setMaxItems(number) | لضبط الحد الأقصى لعدد العناصر التي يمكن للمستخدم اختيارها. |
PickerBuilder.setOAuthToken(string) | لضبط رمز OAuth مميز لاستخدامه في مصادقة المستخدم الحالي. استنادًا إلى نطاق الرمز المميّز، يتمّ عرض البيانات لبعض طرق العرض فقط. النطاقات الصالحة هي "مستندات Google" وDrive. |
PickerBuilder.setOrigin(string) | لتعيين مصدر مربع حوار منتقي Google. يجب ضبط المصدر على window.location.protocol + '//' + window.location.host في أعلى الصفحة، إذا كان تطبيقك يعمل في إطار iframe. |
PickerBuilder.setRelayUrl(string) | قم بتعيين عنوان URL الخاص بالإرسال، والذي يتم استخدامه في الأدوات.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | ضبط قائمة أنواع MIME القابلة للاختيار استخدِم الفواصل للفصل بين أنواع MIME إذا لزم الأمر أكثر من نوع واحد. |
PickerBuilder.setSize() | اضبط حجم مربّع الحوار المفضّل. يتم توسيط مربّع الحوار تلقائيًا. يبلغ الحد الأدنى للحجم (566,350) والحد الأقصى للحجم (1051,650). |
PickerBuilder.setTitle(string) | حدِّد عنوان مربّع الحوار. |
PickerBuilder.toUri() | تعرض معرّف الموارد المنتظم (URI) الذي تم إنشاؤه من خلال أداة الإنشاء هذه. |
ResourceId
ResourceId هي فئة ثابتة تُستخدم لإنشاء معرّفات موارد مناسبة لواجهة Google Documents List API.
ResourceId.generate(Document) | عليك ربط عنصر من عنصر المستند برقم تعريف مورد. |
عرض
View هي الفئة الأساسية المجرّدة لفئات العرض المختلفة، مثل DocsView.
View(ViewId) | منشئ. |
View.getId() | تؤدي إلى إرجاع رقم تعريف الملف الشخصي لهذا الملف الشخصي. |
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 | صور Google Drive: |
ViewId.DOCS_IMAGES_AND_VIDEOS | صور وفيديوهات Google Drive |
ViewId.DOCS_VIDEOS | الفيديوهات على Google Drive |
ViewId.DOCUMENTS | مستندات Google Drive. |
ViewId.DRAWINGS | رسومات Google Drive. |
ViewId.FOLDERS | مجلدات Google Drive: |
ViewId.FORMS | نماذج Google Drive: |
ViewId.PDFS | ملفات PDF المخزَّنة في Google Drive |
ViewId.PRESENTATIONS | عروض Google Drive التقديمية: |
ViewId.SPREADSHEETS | جداول بيانات Google Drive. |
أنواع معاودة الاتصال
توجد الأنواع العددية التالية في بيانات معاودة الاتصال التي تعرضها واجهة برمجة تطبيقات Google Picker.
الإجراء
Action هو نوع معدود يمثّل الإجراء الذي اتخذه المستخدم لإغلاق مربّع الحوار. تتوفّر هذه القيمة في الحقل Response.ACTION ضِمن بيانات معاودة الاتصال.
Action.CANCEL | ألغى المستخدم مربّع حوار "أداة اختيار Google". |
Action.PICKED | اختار المستخدم عنصرًا واحدًا على الأقل. |
مستند
Document هو نوع عددي يُستخدم لنقل المعلومات حول عنصر محدد محدد. يتم فقط عرض الحقول ذات الصلة بالعنصر المحدّد. تتوفّر هذه القيمة في الحقل Response.DOCUMENTS ضِمن بيانات معاودة الاتصال.
Document.DESCRIPTION | تمثّل هذه السمة وصف العنصر المحدّد الذي يساهم به المستخدم. |
Document.DURATION | تمثّل هذه السمة مدة الفيديو المحدَّد. |
Document.EMBEDDABLE_URL | عنوان URL لهذا العنصر مناسب للتضمين في صفحة ويب. |
Document.ICON_URL | تمثّل هذه السمة عنوان 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 | عنوان URL لهذا العنصر. |
الإجابة
Response هو نوع عددي يُستخدم لنقل المعلومات حول العناصر التي اختارها المستخدم.
Response.ACTION | نوع Action يمثّل الإجراء الذي اتخذه المستخدم لإغلاق مربّع الحوار. |
Response.DOCUMENTS | مصفوفة من Document اختارها المستخدم. |
Response.PARENTS | أرقام تعريف المجلدات الرئيسية للعناصر المحددة. (على سبيل المثال، أرقام تعريف المجلدات الرئيسية التي تم اختيار ملفاتها). |
Response.VIEW | View التي اختار المستخدم هذه العناصر منها. |
رقم تعريف الخدمة
ServiceId هو نوع معدود يُستخدم لوصف الخدمة التي تم اختيار العنصر منها. تتوفّر هذه القيمة في الحقل Document.SERVICE_ID من القيم المحدّدة في Document.
ServiceId.DOCS | Google Drive. |
thumbnail
Thumbnail هو نوع عددي يُستخدم لنقل المعلومات حول صورة أو فيديو تم اختياره. يمكن العثور على هذه القيمة في الحقل Document.THUMBNAILS في Document محدّدة.
Thumbnail.HEIGHT | ارتفاع الصورة أو الفيديو بالبكسل. |
Thumbnail.WIDTH | عرض الصورة أو الفيديو بالبكسل. |
Thumbnail.URL | عنوان URL للصورة أو الفيديو المحدَّدين |
كتابة
Type هو نوع معدود يُستخدَم لتصنيف العنصر المحدّد. يمكن العثور على هذه القيمة في الحقل Document.TYPE في Document محدّدة.
Type.DOCUMENT | العنصر عبارة عن مستند. |
Type.PHOTO | العنصر عبارة عن صورة. |
Type.VIDEO | العنصر عبارة عن فيديو. |