सुझावों पर काम करना

Google Docs, सहयोगियों को ऐसे सुझाव देने की सुविधा देता है जो मंज़ूरी मिलने का इंतज़ार कर रहे बदलावों को टाल देते हैं.

दस्तावेज़ का कॉन्टेंट फ़ेच करने के लिए documents.get तरीके का इस्तेमाल करने पर, हो सकता है कि कॉन्टेंट में ऐसे सुझाव शामिल हों जिन्हें हल नहीं किया गया हो. यह कंट्रोल करने के लिए कि documents.get, सुझावों को कैसे दिखाता है, SuggestionsViewMode पैरामीटर का इस्तेमाल करें. ऐसा करना ज़रूरी नहीं है. इस पैरामीटर के साथ, फ़िल्टर करने की ये शर्तें उपलब्ध होती हैं:

  • SUGGESTIONS_INLINE वाला कॉन्टेंट पाएं, ताकि दस्तावेज़ में वह टेक्स्ट दिखे जिसे मिटाया या शामिल नहीं किया गया है.
  • सभी सुझावों को स्वीकार करके, झलक के तौर पर कॉन्टेंट पाएं.
  • सभी सुझावों को अस्वीकार करके, सुझावों के बिना कॉन्टेंट की झलक देखें.

SuggestionsViewMode उपलब्ध न कराने पर, Google Docs API, मौजूदा उपयोगकर्ता के खास अधिकारों के हिसाब से डिफ़ॉल्ट सेटिंग का इस्तेमाल करता है.

सुझाव और इंडेक्स

SuggestionsViewMode के अहम होने की एक वजह यह है कि रिस्पॉन्स में इंडेक्स अलग-अलग हो सकते हैं. यह इस बात पर निर्भर करता है कि क्या सुझाव मौजूद हैं, जैसा कि नीचे दिखाया गया है.

सुझावों वाला कॉन्टेंट सुझावों के बिना सामग्री 
{
 "startIndex": 1,
 "endIndex": 31,
 "paragraph": {
  "elements": [
   {
    "startIndex": 1,
    "endIndex": 31,
    "textRun": {
     "content": "Text preceding the suggestion\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},
{
 "startIndex": 31,
 "endIndex": 51,
 "paragraph": {
  "elements": [
   {
    "startIndex": 31,
    "endIndex": 50,
    "textRun": {
     "content": "Suggested insertion",
     "suggestedInsertionIds": [
      "suggest.vcti8ewm4mww"
     ],
     "textStyle": {
     }
    }
   },
   {
    "startIndex": 50,
    "endIndex": 51,
    "textRun": {
     "content": "\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},
 {
 "startIndex": 51,
 "endIndex": 81,
 "paragraph": {
  "elements": [
   {
    "startIndex": 51,
    "endIndex": 81,
    "textRun": {
     "content": "Text following the suggestion\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},


{
 "startIndex": 1,
 "endIndex": 31,
 "paragraph": {
  "elements": [
   {
    "startIndex": 1,
    "endIndex": 31,
    "textRun": {
     "content": "Text preceding the suggestion\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},
{
 "startIndex": 31,
 "endIndex": 32,
 "paragraph": {
  "elements": [
   {
    "startIndex": 31,
    "endIndex": 32,
    "textRun": {
     "content": "\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},
{
 "startIndex": 32,
 "endIndex": 62,
 "paragraph": {
  "elements": [
   {
    "startIndex": 32,
    "endIndex": 62,
    "textRun": {
     "content": "Text following the suggestion\n",
     "textStyle": {
     }
    }
   }
  ],
  "paragraphStyle": {
   "namedStyleType": "NORMAL_TEXT",
   "direction": "LEFT_TO_RIGHT"
  }
 }
},

ऊपर दिए गए जवाब में, "सुझाव के बाद दिखने वाला टेक्स्ट" लाइन वाले पैराग्राफ़ में SuggestionsViewMode का इस्तेमाल करने पर अंतर दिखता है. वैल्यू को SUGGESTIONS_INLINE पर सेट करने पर, ParagraphElement का startIndex, 51 से शुरू और endIndex 81 पर रुक जाता है. सुझावों के बिना, startIndex और endIndex की रेंज 32 से 62 के बीच है.

सुझावों के बिना कॉन्टेंट पाएं

नीचे दिए गए पार्शियल कोड सैंपल में, SuggestionsViewMode पैरामीटर को PREVIEW_WITHOUT_SUGGESTIONS पर सेट करके, किसी दस्तावेज़ को झलक के तौर पर दिखाने का तरीका बताया गया है. इसमें, कोई भी सुझाव अस्वीकार होने (अगर कोई हो) शामिल है.

Java

फ़ाइनल स्ट्रिंग SUGGEST_ मोड = "Preview_WITHOUT_SUGGESTIONS"; दस्तावेज़ दस्तावेज़ = service.documents().get(DOCUMENT_ID).setrecommendationsViewMode(SUGGEST_mode).exeकुट();

Python

SUGGEST_Mode=" देखने_WITHOUT_SUGGESTIONS" नतीजा = service.documents().get(documentId=DOCUMENT_ID, suggestionsViewMode=SUGGEST_mode).exeकुट()

SuggestionsViewMode पैरामीटर को छोड़ने का मतलब, पैरामीटर की वैल्यू के तौर पर DEFAULT_FOR_CURRENT_ACCESS देने के बराबर है.

शैली के सुझाव

दस्तावेज़ों में स्टाइल के सुझाव भी शामिल हो सकते हैं. ये कॉन्टेंट में बदलावों के बजाय, फ़ॉर्मैटिंग और प्रज़ेंटेशन में किए जाने वाले बदलावों के सुझाव हैं.

टेक्स्ट डालने या मिटाने से अलग, ये इंडेक्स को ऑफ़सेट नहीं करते. हालांकि, ये इंडेक्स TextRun को छोटे-छोटे हिस्सों में बांट सकते हैं. हालांकि, स्टाइल बदलने के लिए सुझाए गए तरीके के बारे में सिर्फ़ एनोटेशन जोड़ें.

ऐसा ही एक एनोटेशन SuggestedTextStyle है, जिसके दो हिस्से होते हैं:

  • textStyle से यह पता चलता है कि सुझाए गए बदलावों के बाद टेक्स्ट को कैसे स्टाइल किया गया है. हालांकि, इसमें यह नहीं बताया गया है कि क्या बदलाव हुआ है.

  • textStyleSuggestionState, जिससे पता चलता है कि सुझाव, textStyle के फ़ील्ड में कैसे बदलाव करता है.

दस्तावेज़ के नीचे दिए गए एक्सट्रैक्ट में, इसे देखा जा सकता है. इसमें स्टाइल में बदलाव करने का सुझाव शामिल है:

[01] "paragraph": {
[02]    "elements": [
[03]        {
[04]            "endIndex": 106,
[05]            "startIndex": 82,
[06]            "textRun": {
[07]                "content": "Some text that does not ",
[08]                "textStyle": {}
[09]            }
[10]        },
[11]        {
[12]            "endIndex": 115,
[13]            "startIndex": 106,
[14]            "textRun": {
[15]                "content": "initially",
[16]                "suggestedTextStyleChanges": {
[17]                    "suggest.xymysbs9zldp": {
[18]                        "textStyle": {
[19]                            "backgroundColor": {},
[20]                            "baselineOffset": "NONE",
[21]                            "bold": true,
[22]                            "fontSize": {
[23]                                "magnitude": 11,
[24]                                "unit": "PT"
[25]                            },
[26]                            "foregroundColor": {
[27]                                "color": {
[28]                                    "rgbColor": {}
[29]                                }
[30]                            },
[31]                            "italic": false,
[32]                            "smallCaps": false,
[33]                            "strikethrough": false,
[34]                            "underline": false
[35]                        },
[36]                        "textStyleSuggestionState": {
[37]                            "boldSuggested": true,
[38]                            "weightedFontFamilySuggested": true
[39]                        }
[40]                    }
[41]                },
[42]                "textStyle": {
[43]                    "italic": true
[44]                }
[45]            }
[46]        },
[47]        {
[48]            "endIndex": 143,
[49]            "startIndex": 115,
[50]            "textRun": {
[51]                "content": " contain any boldface text.\n",
[52]                "textStyle": {}
[53]            }
[54]        }
[55]    ],
[56]    "paragraphStyle": {
[57]        "direction": "LEFT_TO_RIGHT",
[58]        "namedStyleType": "NORMAL_TEXT"
[59]    }
[60] }

ऊपर दिए गए सैंपल में, पैराग्राफ़ में तीन टेक्स्ट रन हैं. इनकी शुरुआत लाइन 6, 14, और 50 से होती है. बीच वाले टेक्स्ट की जांच करें:

  • लाइन 16: एक suggestedTextStyleChanges ऑब्जेक्ट है.
  • लाइन 18: textStyle अलग-अलग फ़ॉर्मैट के बारे में बताता है.
  • लाइन 36: textStyleSuggestionState आपको बताता है कि इस स्पेसिफ़िकेशन का सिर्फ़ बोल्ड हिस्सा सुझाव था.
  • लाइन 42: दिखाए गए इस टेक्स्ट की इटैलिक स्टाइल, मौजूदा दस्तावेज़ का हिस्सा है (और सुझाव पर इसका कोई असर नहीं पड़ता है).

सिर्फ़ textStyleSuggestionState में true पर सेट की गई स्टाइल वाली सुविधाएं ही सुझाव का हिस्सा हैं.