إدارة التعليقات والردود

التعليقات هي تعليقات يقدمها المستخدم على ملف، مثل قارئ لـ مستند معالجة الكلمات يشير إلى كيفية إعادة صياغة جملة. هناك خياران أنواع التعليقات: التعليقات الثابتة والتعليقات غير الثابتة. يرتبط التعليق بموقع محدد، مثل جملة في مستند معالجة الكلمات، داخل نسخة معينة من المستند. وعلى العكس، تعليق غير ثابت مرتبط فقط بالوثيقة.

يتم إرفاق الردود بالتعليقات وتمثّل ردّ المستخدم على التعليق تسمح واجهة برمجة تطبيقات Drive للمستخدمين بإضافة تعليقات وردود عليها المستندات التي تم إنشاؤها بواسطة تطبيقك. يُعرف التعليق الذي يتضمّن ردودًا مجتمعةً باسم مناقشة

إضافة تعليق غير ثابت

لإضافة تعليق غير ثابت إلى مستند، يمكنك استدعاء الطريقة comments.create مع مَعلمة fileId و مرجع comments يحتوي على التعليق

يتم إدراج التعليق كنص عادي، لكن نص الاستجابة يقدم حقل "htmlContent" الذي يتضمّن محتوى تم تنسيقه للعرض.

إضافة ردّ على تعليق

لإضافة ردّ على تعليق، اتّصِل بـ replies.create مع التعليق، معلَمة fileId ومورد replies التي تحتوي على الرد.

يتم إدراج الرد كنص عادي، لكن نص الاستجابة يوفر حقل "htmlContent" الذي يتضمّن محتوى تم تنسيقه للعرض.

إضافة تعليق ثابت إلى أحدث مراجعة لمستند

عند إضافة تعليق، قد تحتاج إلى ربطه بمنطقة في الملف. إنّ الارتساء تحدد مراجعة الملف والمنطقة في الملف الذي يمكن التعليق عليه يشير. يحدد مورد comments anchor كسلسلة JSON.

لإضافة تعليق ثابت:

  1. (اختياري). يمكنك الاتصال بالرقم revisions.list. لسرد كل revisionID لمستند. يجب اتّباع هذه الخطوة فقط إذا تريد تثبيت تعليق في أي مراجعة بخلاف النسخة السابقة. إذا كنت تريد استخدام أحدث نسخة، استخدِم head بدلاً من revisionID.

  2. استدعاء الطريقة comments.create مع المعلمة fileID، وهي comments مورد يحتوي على التعليق وسلسلة ارتساء JSON تحتوي على revisionID (r) والمنطقة (a).

تعتمد كيفية تحديد منطقة على نوع محتوى المستند الذي تعمل عليه معهم. لمزيد من المعلومات، يمكنك الاطّلاع على مقالة تحديد منطقة.

تحديد المنطقة

كما ذكرنا سابقًا، تحتوي سلسلة ارتساء JSON على revisionID (r) المنطقة (a). المنطقة (a) هي مصفوفة JSON تحتوي على أدوات تصنيف المناطق. لتحديد التنسيق والموقع الذي يرتبط به التعليق. المصنِّف قد يكون مستطيلاً ثنائي الأبعاد لصورة أو سطرًا من النص في مستند أو مدة زمنية في الفيديو لتحديد منطقة، اختَر المنطقة. المصنِّف الذي يتطابق مع نوع المحتوى الذي تحاول الربط به. بالنسبة على سبيل المثال، إذا كان المحتوى نصًا، من المرجّح أن تستخدم السمة txt. أو مصنِّف منطقة واحد (line).

للاطّلاع على قائمة بأدوات تصنيف المناطق في واجهة برمجة تطبيقات Drive، يُرجى الرجوع إلى صفحة المنطقة والمصنِّفات

يعرض المثال التالي سلسلة ارتساء JSON التي تؤدي إلى تثبيت التعليقات في الأسطر. في قسمين منفصلين من المستند:

  • تبدأ المنطقة الأولى من السطر 12 ('n':12) وتمتد إلى ثلاثة أسطر ('l':3).
  • لا يغطي المنطقة الثانية سوى السطر 18 ('n':18, 'l':1`).
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

استبدِل REVISION_ID بـ head أو بمعرّف عنصر معيّن. المراجعة.

التعامل بشكل نهائي مع تعليق

استخدِم الطريقة comment.update لضبط السمة resolved في comments المورد إلى true عندما تتم معالجة تعليق.

عندما يضبط تطبيقك السمة resolved على true، من المفترض أن تشير واجهة المستخدم إلى بأنه تم التعامل مع التعليق. على سبيل المثال، قد:

  • عدم السماح بمزيد من الردود وتعتيم جميع الردود السابقة بالإضافة إلى الرد الأصلي التعليق
  • إخفاء التعليقات التي تم حلّها.

حذف تعليق

استخدِم الطريقة comments.delete من أجل حذف التعليقات. عند حذف تعليق، يضع Drive علامة على مرجع التعليقات باسم "deleted": "true".

إدراج التعليقات

استخدِم الطريقة comments.list لعرض التعليقات إذا كنت تريد تضمين التعليقات المحذوفة في النتائج، فقم بتعيين includedDeleted إلى true.