browser.notifications

ब्यौरा

टेंप्लेट का इस्तेमाल करके बेहतर सूचनाएं बनाने के लिए, chrome.notifications एपीआई का इस्तेमाल करें. साथ ही, इन सूचनाओं को सिस्टम ट्रे में उपयोगकर्ताओं को दिखाएं.

अनुमतियां

notifications

टाइप

NotificationBitmap

NotificationButton

प्रॉपर्टी

  • iconUrl

    string ज़रूरी नहीं

    Chrome 59 के बाद से इस्तेमाल नहीं किया जा रहा है

    Mac OS X इस्तेमाल करने वाले लोगों को बटन के आइकॉन नहीं दिखते.

  • title

    स्ट्रिंग

NotificationItem

प्रॉपर्टी

  • मैसेज

    स्ट्रिंग

    इस आइटम के बारे में ज़्यादा जानकारी.

  • title

    स्ट्रिंग

    सूची वाली सूचना के किसी आइटम का टाइटल.

NotificationOptions

प्रॉपर्टी

  • appIconMaskUrl

    string ज़रूरी नहीं

    Chrome 59 के बाद से इस्तेमाल नहीं किया जा रहा है

    Mac OS X का इस्तेमाल करने वाले लोगों को ऐप्लिकेशन का आइकॉन मास्क नहीं दिखता.

    ऐप्लिकेशन के आइकॉन मास्क का यूआरएल. यूआरएल पर वही पाबंदियां लागू होती हैं जो iconUrl पर लागू होती हैं.

    ऐप्लिकेशन आइकॉन का मास्क, ऐल्फ़ा चैनल में होना चाहिए. ऐसा इसलिए, क्योंकि इमेज का सिर्फ़ ऐल्फ़ा चैनल ही इस्तेमाल किया जाएगा.

  • बटन

    NotificationButton[] ज़रूरी नहीं

    सूचना के ज़्यादा से ज़्यादा दो ऐक्शन बटन के लिए टेक्स्ट और आइकॉन.

  • contextMessage

    string ज़रूरी नहीं

    कम वज़न वाले फ़ॉन्ट के साथ सूचना का वैकल्पिक कॉन्टेंट.

  • eventTime

    number ज़रूरी नहीं

    सूचना से जुड़ा टाइमस्टैंप, जो मिलीसेकंड में होता है (उदाहरण के लिए, Date.now() + n).

  • iconUrl

    string ज़रूरी नहीं

    मैसेज भेजने वाले के अवतार, ऐप्लिकेशन के आइकॉन या इमेज वाली सूचनाओं के थंबनेल का यूआरएल.

    यूआरएल, डेटा यूआरएल, ब्लॉब यूआरएल या इस एक्सटेंशन की .crx फ़ाइल में मौजूद किसी संसाधन से जुड़ा यूआरएल हो सकता है

    **ध्यान दें:** notifications.create() तरीके के लिए, यह वैल्यू डालना ज़रूरी है.

  • imageUrl

    string ज़रूरी नहीं

    Chrome 59 के बाद से इस्तेमाल नहीं किया जा रहा है

    Mac OS X का इस्तेमाल करने वाले लोगों को इमेज नहीं दिखती.

    इमेज टाइप की सूचनाओं के लिए, इमेज के थंबनेल का यूआरएल. यूआरएल पर वही पाबंदियां लागू होती हैं जो iconUrl पर लागू होती हैं.

  • isClickable

    बूलियन ज़रूरी नहीं

    Chrome 67 के बाद से, इस सुविधा का इस्तेमाल नहीं किया जा सकता

    Chrome 67 से, इस यूज़र इंटरफ़ेस (यूआई) हिंट को अनदेखा कर दिया जाता है

  • आइटम

    NotificationItem[] ज़रूरी नहीं

    एक से ज़्यादा आइटम की सूचनाओं के लिए आइटम. Mac OS X का इस्तेमाल करने वाले लोगों को सिर्फ़ पहला आइटम दिखता है.

  • मैसेज

    string ज़रूरी नहीं

    सूचना का मुख्य कॉन्टेंट.

    **ध्यान दें:** notifications.create() तरीके के लिए, यह वैल्यू डालना ज़रूरी है.

  • प्राथमिकता

    number ज़रूरी नहीं

    प्राथमिकता की रेंज -2 से 2 तक होती है. -2 सबसे कम प्राथमिकता है. 2 सबसे ज़्यादा है. डिफ़ॉल्ट वैल्यू शून्य है. जिन प्लैटफ़ॉर्म पर सूचना केंद्र की सुविधा काम नहीं करती (Windows, Linux, और Mac), उन पर -2 और -1 की वजह से गड़बड़ी होती है. ऐसा इसलिए, क्योंकि इन प्राथमिकताओं वाली सूचनाएं बिलकुल नहीं दिखाई जाएंगी.

  • प्रोग्रेस

    number ज़रूरी नहीं

    मौजूदा प्रोग्रेस की रेंज 0 से 100 तक है.

  • requireInteraction

    बूलियन ज़रूरी नहीं

    Chrome 50+ browser.*, Chrome 148 से

    इससे पता चलता है कि सूचना तब तक स्क्रीन पर दिखती रहनी चाहिए, जब तक उपयोगकर्ता उसे चालू या खारिज नहीं कर देता. डिफ़ॉल्ट तौर पर, यह 'गलत' पर सेट होती है.

  • साइलेंट

    बूलियन ज़रूरी नहीं

    Chrome 70+ Chrome 148 से browser.*

    इससे पता चलता है कि सूचना दिखने पर, कोई आवाज़ या वाइब्रेशन नहीं होना चाहिए. डिफ़ॉल्ट तौर पर, यह 'गलत' पर सेट होती है.

  • title

    string ज़रूरी नहीं

    सूचना का टाइटल (उदाहरण के लिए, ईमेल भेजने वाले का नाम).

    **ध्यान दें:** notifications.create() तरीके के लिए, यह वैल्यू डालना ज़रूरी है.

  • टाइप

    TemplateType ज़रूरी नहीं है

    किस तरह की सूचना दिखानी है. notifications.create तरीके के लिए ज़रूरी है.

PermissionLevel

Enum

"granted"
इससे पता चलता है कि उपयोगकर्ता ने ऐप्लिकेशन या एक्सटेंशन से सूचनाएं दिखाने का विकल्प चुना है. इंस्टॉल करते समय, यह डिफ़ॉल्ट रूप से सेट होता है.

"denied"
इससे पता चलता है कि उपयोगकर्ता ने ऐप्लिकेशन या एक्सटेंशन से सूचनाएं न दिखाने का विकल्प चुना है.

TemplateType

Enum

"basic"
इसमें एक आइकॉन, टाइटल, मैसेज, expandedMessage, और ज़्यादा से ज़्यादा दो बटन होते हैं.

"image"
इसमें एक आइकॉन, टाइटल, मैसेज, expandedMessage, इमेज, और ज़्यादा से ज़्यादा दो बटन होते हैं.

"list"
इसमें एक आइकॉन, टाइटल, मैसेज, आइटम, और ज़्यादा से ज़्यादा दो बटन होते हैं. Mac OS X का इस्तेमाल करने वाले लोगों को सिर्फ़ पहला आइटम दिखता है.

"प्रोग्रेस"
इसमें एक आइकॉन, टाइटल, मैसेज, प्रोग्रेस, और ज़्यादा से ज़्यादा दो बटन होते हैं.

तरीके

clear()

browser.notifications.clear(
  notificationId: string,
): Promise<boolean>

इससे चुनी गई सूचना को हटाया जा सकता है.

पैरामीटर

  • notificationId

    स्ट्रिंग

    उस सूचना का आईडी जिसे हटाना है. यह notifications.create तरीके से दिखाया जाता है.

रिटर्न

  • Promise<boolean>

    Chrome 116+ browser.* Chrome 148 से

    यह एक प्रॉमिस दिखाता है, जिससे यह पता चलता है कि मैच होने वाली सूचना मौजूद थी या नहीं.

create()

browser.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

सूचना बनाता है और दिखाता है.

पैरामीटर

  • notificationId

    string ज़रूरी नहीं

    सूचना का आइडेंटिफ़ायर. अगर इसे सेट नहीं किया गया है या यह खाली है, तो एक आईडी अपने-आप जनरेट हो जाएगा. अगर यह किसी मौजूदा सूचना से मैच करता है, तो यह तरीका नई सूचना बनाने से पहले, उस सूचना को हटा देता है. आइडेंटिफ़ायर में 500 से ज़्यादा वर्ण नहीं होने चाहिए.

    Chrome 42 से पहले के वर्शन के लिए, notificationId पैरामीटर ज़रूरी है.

  • विकल्प

    NotificationOptions

    सूचना का कॉन्टेंट.

रिटर्न

  • Promise<string>

    Chrome 116+ browser.* Chrome 148 से

    यह एक प्रॉमिस दिखाता है, जो सूचना आईडी (उपलब्ध कराया गया या जनरेट किया गया) के साथ रिज़ॉल्व होता है. यह आईडी, बनाई गई सूचना को दिखाता है.

getAll()

browser.notifications.getAll(): Promise<object>

इस ऐप्लिकेशन या एक्सटेंशन की सभी सूचनाएं वापस लाता है.

रिटर्न

  • Promise<object>

    Chrome 116+ browser.* Chrome 148 से

    यह एक प्रॉमिस दिखाता है, जो सिस्टम में मौजूद notification_ids के सेट के साथ रिज़ॉल्व होता है.

getPermissionLevel()

browser.notifications.getPermissionLevel(): Promise<PermissionLevel>

यह पता लगाता है कि उपयोगकर्ता ने इस ऐप्लिकेशन या एक्सटेंशन से सूचनाएं पाने की सुविधा चालू की है या नहीं.

रिटर्न

  • Promise<PermissionLevel>

    Chrome 116+ browser.* Chrome 148 से

    यह एक प्रॉमिस दिखाता है, जो अनुमति के मौजूदा लेवल के साथ रिज़ॉल्व होता है.

update()

browser.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

किसी मौजूदा सूचना को अपडेट करता है.

पैरामीटर

  • notificationId

    स्ट्रिंग

    अपडेट की जाने वाली सूचना का आईडी. यह notifications.create तरीके से दिखाया जाता है.

  • विकल्प

    NotificationOptions

    सूचना का वह कॉन्टेंट जिसे अपडेट करना है.

रिटर्न

  • Promise<boolean>

    Chrome 116+ browser.* Chrome 148 से

    यह एक प्रॉमिस दिखाता है, जिससे यह पता चलता है कि मैच होने वाली सूचना मौजूद थी या नहीं.

इवेंट

onButtonClicked

browser.notifications.onButtonClicked.addListener(
  callback: function,
)

उपयोगकर्ता ने सूचना में मौजूद किसी बटन को दबाया.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      स्ट्रिंग

    • buttonIndex

      संख्या

onClicked

browser.notifications.onClicked.addListener(
  callback: function,
)

उपयोगकर्ता ने सूचना के ऐसे हिस्से पर क्लिक किया जो बटन नहीं है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (notificationId: string) => void

    • notificationId

      स्ट्रिंग

onClosed

browser.notifications.onClosed.addListener(
  callback: function,
)

सिस्टम या उपयोगकर्ता की कार्रवाई की वजह से सूचना बंद हो गई.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (notificationId: string, byUser: boolean) => void

    • notificationId

      स्ट्रिंग

    • byUser

      बूलियन

onPermissionLevelChanged

browser.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

उपयोगकर्ता, अनुमति का लेवल बदलता है. Chrome 47 के बाद से, सिर्फ़ ChromeOS में ऐसा यूज़र इंटरफ़ेस (यूआई) है जो इस इवेंट को भेजता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (level: PermissionLevel) => void

onShowSettings

Chrome 65 के बाद से इस्तेमाल नहीं किया जा रहा है
browser.notifications.onShowSettings.addListener(
  callback: function,
)

सूचना सेटिंग को पसंद के मुताबिक बनाने की सुविधा अब उपलब्ध नहीं है.

उपयोगकर्ता ने ऐप्लिकेशन की सूचना सेटिंग के लिंक पर क्लिक किया. Chrome 47 के बाद से, सिर्फ़ ChromeOS में ऐसा यूज़र इंटरफ़ेस (यूआई) है जो इस इवेंट को भेजता है. Chrome 65 के बाद से, उस यूज़र इंटरफ़ेस (यूआई) को ChromeOS से भी हटा दिया गया है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    () => void