chrome.notifications

ब्यौरा

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

अनुमतियां

notifications

टाइप

NotificationBitmap

NotificationButton

प्रॉपर्टी

  • iconUrl

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

    Chrome 59 के बाद से काम नहीं करता

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

  • title

    स्ट्रिंग

NotificationItem

प्रॉपर्टी

  • मैसेज

    स्ट्रिंग

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

  • title

    स्ट्रिंग

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

NotificationOptions

प्रॉपर्टी

  • appIconMaskUrl

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

    Chrome 59 के बाद से काम नहीं करता

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

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

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

  • बटन

    NotificationButton[] optional

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

  • contextMessage

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

    सूचना के कॉन्टेंट के लिए, कम वेट वाला फ़ॉन्ट इस्तेमाल किया गया है.

  • eventTime

    number ज़रूरी नहीं

    सूचना से जुड़ा टाइमस्टैंप.यह टाइमस्टैंप, epoch के बाद के मिलीसेकंड में होता है. उदाहरण के लिए, 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+

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

  • साइलेंट

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

    Chrome 70 या इसके बाद के वर्शन

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

  • title

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

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

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

  • टाइप

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

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

PermissionLevel

Enum

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

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

TemplateType

Enum

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

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

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

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

तरीके

clear()

प्रॉमिस 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

इससे चुनी गई सूचना खारिज हो जाती है.

पैरामीटर

  • notificationId

    स्ट्रिंग

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (wasCleared: boolean) => void

    • wasCleared

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 116 और इसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

create()

प्रॉमिस 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

यह कुकी, सूचना बनाती है और उसे दिखाती है.

पैरामीटर

  • notificationId

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

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

    Chrome 42 से पहले, notificationId पैरामीटर ज़रूरी है.

  • विकल्प

    NotificationOptions

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (notificationId: string) => void

    • notificationId

      स्ट्रिंग

रिटर्न

  • Promise<string>

    Chrome 116 और इसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

getAll()

प्रॉमिस 
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (notifications: object) => void

    • नोटिफ़िकेशन

      ऑब्जेक्ट

रिटर्न

  • Promise<object>

    Chrome 116 और इसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

getPermissionLevel()

प्रॉमिस 
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (level: PermissionLevel) => void

रिटर्न

  • Promise<PermissionLevel>

    Chrome 116 और इसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

update()

प्रॉमिस 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

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

पैरामीटर

  • notificationId

    स्ट्रिंग

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

  • विकल्प

    NotificationOptions

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

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

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

    (wasUpdated: boolean) => void

    • wasUpdated

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 116 और इसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और इसके बाद के वर्शन के लिए काम करते हैं. अन्य प्लैटफ़ॉर्म को कॉलबैक का इस्तेमाल करना होगा.

इवेंट

onButtonClicked

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

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

    • notificationId

      स्ट्रिंग

    • buttonIndex

      संख्या

onClicked

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

उपयोगकर्ता ने सूचना के बटन वाले हिस्से के बाहर क्लिक किया.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (notificationId: string) => void

    • notificationId

      स्ट्रिंग

onClosed

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

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

    • notificationId

      स्ट्रिंग

    • byUser

      बूलियन

onPermissionLevelChanged

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (level: PermissionLevel) => void

onShowSettings

Chrome 65 से बंद कर दिया गया है
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

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

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    () => void