chrome.input.ime

ब्यौरा

Chrome OS के लिए कस्टम IME लागू करने के लिए, chrome.input.ime एपीआई का इस्तेमाल करें. इससे आपके एक्सटेंशन को कीस्ट्रोक को हैंडल करने, कंपोज़िशन सेट करने, और सुझाव वाली विंडो को मैनेज करने की अनुमति मिलती है.

अनुमतियां

input

उपलब्धता

सिर्फ़ ChromeOS के लिए

मेनिफ़ेस्ट

input.ime API का इस्तेमाल करने के लिए, आपको एक्सटेंशन मेनिफ़ेस्ट में "input" अनुमति का एलान करना होगा. उदाहरण के लिए:

{
  "name": "My extension",
  ...
  "permissions": [
    "input"
  ],
  ...
}

उदाहरण

नीचे दिया गया कोड, एक ऐसा IME बनाता है जो टाइप किए गए अक्षरों को अपर केस में बदलता है.

var context_id = -1;

chrome.input.ime.onFocus.addListener(function(context) {
  context_id = context.contextID;
});

chrome.input.ime.onKeyEvent.addListener(
  function(engineID, keyData) {
    if (keyData.type == "keydown" && keyData.key.match(/^[a-z]$/)) {
      chrome.input.ime.commitText({"contextID": context_id,
                                    "text": keyData.key.toUpperCase()});
      return true;
    } else {
      return false;
    }
  }
);

टाइप

AssistiveWindowButton

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

सहायक विंडो में मौजूद बटन का आईडी.

Enum

"undo"

"addToDictionary"

AssistiveWindowProperties

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

सहायता करने वाली विंडो की प्रॉपर्टी.

प्रॉपर्टी

  • announceString

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

    ChromeVox के लिए स्ट्रिंग, ताकि वह उनका एलान कर सके.

  • टाइप

    "undo"

  • दिख रहा है

    बूलियन

    AssistiveWindow को दिखाने के लिए, इस विकल्प को 'सही है' पर सेट करें. इसे छिपाने के लिए, 'गलत है' पर सेट करें.

AssistiveWindowType

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

सहायता करने वाली विंडो का टाइप.

मान

"undo"

AutoCapitalizeType

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

टेक्स्ट फ़ील्ड में शब्दों को अपने-आप कैपिटल करने की सुविधा.

Enum

"characters"

"words"

"sentences"

InputContext

इनपुट कॉन्टेक्स्ट के बारे में बताता है

प्रॉपर्टी

  • autoCapitalize

    AutoCapitalizeType

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

    टेक्स्ट फ़ील्ड में शब्दों को अपने-आप कैपिटल करने की सुविधा.

  • autoComplete

    बूलियन

    टेक्स्ट फ़ील्ड को अपने-आप पूरा होने की सुविधा चाहिए या नहीं.

  • autoCorrect

    बूलियन

    इससे पता चलता है कि टेक्स्ट फ़ील्ड में अपने-आप सही होने की सुविधा चाहिए या नहीं.

  • contextID

    संख्या

    इसका इस्तेमाल, टेक्स्ट फ़ील्ड के टारगेट तय करने के लिए किया जाता है. onBlur को कॉल करने के तुरंत बाद, यह आईडी अमान्य हो जाता है.

  • shouldDoLearning

    बूलियन

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

    क्या टेक्स्ट फ़ील्ड में डाले गए टेक्स्ट का इस्तेमाल, उपयोगकर्ता के लिए टाइपिंग के सुझावों को बेहतर बनाने के लिए किया जाना चाहिए.

  • spellCheck

    बूलियन

    इससे पता चलता है कि टेक्स्ट फ़ील्ड में स्पेलिंग की जांच करनी है या नहीं.

  • टाइप

    InputContextType

    यह टेक्स्ट फ़ील्ड किस तरह की वैल्यू में बदलाव करता है (टेक्स्ट, संख्या, यूआरएल वगैरह)

InputContextType

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

यह टेक्स्ट फ़ील्ड किस तरह की वैल्यू में बदलाव करता है (टेक्स्ट, संख्या, यूआरएल वगैरह)

Enum

"text"

"search"

"tel"

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent पर जाएं

प्रॉपर्टी

  • altKey

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

    इससे पता चलता है कि ALT बटन दबाया गया है या नहीं.

  • altgrKey

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

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

    इससे पता चलता है कि ALTGR बटन दबाया गया है या नहीं.

  • capsLock

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

    CAPS_LOCK चालू है या नहीं.

  • कोड

    स्ट्रिंग

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

  • ctrlKey

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

    इससे पता चलता है कि CTRL बटन दबाया गया है या नहीं.

  • extensionId

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

    इस कीइवेंट को भेजने वाले एक्सटेंशन का आईडी.

  • बटन

    स्ट्रिंग

    दबाए जा रहे बटन की वैल्यू

  • keyCode

    number ज़रूरी नहीं

    यह एचटीएमएल का पुराना keyCode है. यह सिस्टम और लागू करने के तरीके पर निर्भर करता है. यह एक संख्यात्मक कोड होता है, जो दबाई गई कुंजी से जुड़े आइडेंटिफ़ायर को दिखाता है.

  • requestId

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

    (अब सेवा में नहीं है) अनुरोध का आईडी. इसके बजाय, onKeyEvent इवेंट के requestId पैरामीटर का इस्तेमाल करें.

  • shiftKey

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

    इससे पता चलता है कि SHIFT बटन दबाया गया है या नहीं.

  • टाइप

    KeyboardEventType

    keyup या keydown में से कोई एक.

KeyboardEventType

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

Enum

"keyup"

"keydown"

MenuItem

यह एक मेन्यू आइटम है. इसका इस्तेमाल इनपुट मेथड, भाषा मेन्यू से उपयोगकर्ता के साथ इंटरैक्ट करने के लिए करता है.

प्रॉपर्टी

  • सही का निशान लगाया गया

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

    इससे पता चलता है कि इस आइटम को सही के निशान के साथ दिखाया जाना चाहिए.

  • चालू किया गया

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

    इससे पता चलता है कि यह आइटम चालू है.

  • आईडी

    स्ट्रिंग

    यह एक स्ट्रिंग है, जिसे इस MenuItem का रेफ़रंस देने वाले कॉलबैक में पास किया जाएगा.

  • लेबल

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

    इस आइटम के लिए मेन्यू में दिखाया गया टेक्स्ट.

  • शैली

    MenuItemStyle optional

    मेन्यू आइटम का टाइप.

  • दिख रहा है

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

    इससे पता चलता है कि यह आइटम दिख रहा है.

MenuItemStyle

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

मेन्यू आइटम का टाइप. सेपरेटर के बीच मौजूद रेडियो बटन को ग्रुप किया गया माना जाता है.

Enum

"check"

"radio"

"separator"

MenuParameters

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

प्रॉपर्टी

  • engineID

    स्ट्रिंग

    इस्तेमाल किए जाने वाले इंजन का आईडी.

  • आइटम

    MenuItem[]

    जोड़ने या अपडेट करने के लिए MenuItems. इन्हें ऐरे में मौजूद क्रम के हिसाब से जोड़ा जाएगा.

MouseButton

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

माउस के किन बटन पर क्लिक किया गया.

Enum

"left"

"middle"

"right"

ScreenType

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

स्क्रीन का टाइप, जिस पर IME चालू है.

Enum

"normal"

"login"

"lock"

"secondary-login"

UnderlineStyle

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

इस सेगमेंट में बदलाव करने के लिए, अंडरलाइन का टाइप.

Enum

"underline"

"doubleUnderline"

"noUnderline"

WindowPosition

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

उम्मीदवार विंडो कहां दिखानी है. 'कर्सर' पर सेट होने पर, विंडो कर्सर के साथ-साथ चलती है. अगर इसे 'composition' पर सेट किया जाता है, तो विंडो को कंपोज़िशन की शुरुआत में लॉक कर दिया जाता है.

Enum

"cursor"

"composition"

तरीके

clearComposition()

प्रॉमिस 
chrome.input.ime.clearComposition(
  parameters: object,
  callback?: function,
): Promise<boolean>

मौजूदा कंपोज़िशन को मिटाता है. अगर इस एक्सटेंशन के पास चालू IME का मालिकाना हक नहीं है, तो यह फ़ंक्शन काम नहीं करेगा.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जहां कंपोज़िशन को हटाया जाएगा

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

commitText()

प्रॉमिस 
chrome.input.ime.commitText(
  parameters: object,
  callback?: function,
): Promise<boolean>

यह फ़ंक्शन, दिए गए टेक्स्ट को मौजूदा इनपुट में जोड़ता है.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जहां टेक्स्ट को सेव किया जाएगा

    • टेक्स्ट

      स्ट्रिंग

      वह टेक्स्ट जिसे सेव करना है

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

deleteSurroundingText()

प्रॉमिस 
chrome.input.ime.deleteSurroundingText(
  parameters: object,
  callback?: function,
): Promise<void>

इस निर्देश से, कैरेट के आस-पास मौजूद टेक्स्ट मिट जाता है.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जहां आस-पास का टेक्स्ट मिटाया जाएगा.

    • engineID

      स्ट्रिंग

      इवेंट पाने वाले इंजन का आईडी.

    • लंबाई

      संख्या

      मिटाए जाने वाले वर्णों की संख्या

    • ऑफ़सेट

      संख्या

      कैरट की पोज़िशन से वह ऑफ़सेट जहां से मिटाना शुरू होगा. यह वैल्यू नेगेटिव हो सकती है.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 111+

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

hideInputView()

chrome.input.ime.hideInputView(): void

यह इनपुट व्यू विंडो को छिपाता है. यह विंडो, सिस्टम की ओर से अपने-आप पॉप-अप होती है. अगर इनपुट व्यू विंडो पहले से ही छिपी हुई है, तो यह फ़ंक्शन कुछ नहीं करेगा.

keyEventHandled()

chrome.input.ime.keyEventHandled(
  requestId: string,
  response: boolean,
): void

इससे पता चलता है कि onKeyEvent से मिले मुख्य इवेंट को हैंडल किया गया है. इस फ़ंक्शन को सिर्फ़ तब कॉल किया जाना चाहिए, जब onKeyEvent लिसनर एसिंक्रोनस हो.

पैरामीटर

  • requestId

    स्ट्रिंग

    जिस इवेंट को हैंडल किया गया है उसका अनुरोध आईडी. यह keyEvent.requestId से मिलना चाहिए

  • जवाब

    बूलियन

    अगर कीस्ट्रोक को हैंडल किया गया था, तो वैल्यू 'सही' के तौर पर सेट होगी, नहीं तो यह 'गलत' के तौर पर सेट होगी

sendKeyEvents()

प्रॉमिस 
chrome.input.ime.sendKeyEvents(
  parameters: object,
  callback?: function,
): Promise<void>

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

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जहां मुख्य इवेंट भेजे जाएंगे या इनपुट फ़ील्ड के अलावा किसी अन्य जगह पर मुख्य इवेंट भेजने के लिए शून्य.

    • keyData

      KeyboardEvent[]

      मुख्य इवेंट का डेटा.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 111+

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

setAssistiveWindowButtonHighlighted()

Promise Chrome 86 या इसके बाद के वर्शन 
chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
): Promise<void>

यह कुकी, ऐक्सेसिबिलिटी विंडो में मौजूद किसी बटन को हाइलाइट/अनहाइलाइट करती है.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • announceString

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

      स्क्रीनरीडर के लिए टेक्स्ट, ताकि वह उसे बोलकर सुना सके.

    • बटन का आईडी

    • contextID

      संख्या

      सहायता विंडो के मालिक के कॉन्टेक्स्ट का आईडी.

    • हाइलाइट की गई

      बूलियन

      बटन को हाइलाइट किया जाना चाहिए या नहीं.

    • windowType

      "undo"

      बटन जिस विंडो टाइप का हिस्सा है.

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 111+

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

setAssistiveWindowProperties()

Promise Chrome 85 या इसके बाद के वर्शन 
chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
): Promise<boolean>

दी गई प्रॉपर्टी के साथ, सहायता करने वाली विंडो को दिखाता/छिपाता है.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      सहायता विंडो के मालिक के कॉन्टेक्स्ट का आईडी.

    • प्रॉपर्टी

      AssistiveWindowProperties

      सहायता करने वाली विंडो की प्रॉपर्टी.

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

setCandidates()

प्रॉमिस 
chrome.input.ime.setCandidates(
  parameters: object,
  callback?: function,
): Promise<boolean>

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

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • उम्मीदवार

      object[]

      उम्मीदवार विंडो में दिखाए जाने वाले उम्मीदवारों की सूची

      • मेटा जानकारी

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

        कैंडिडेट के बारे में जानकारी देने वाला अतिरिक्त टेक्स्ट

      • उपयुक्त कीवर्ड/टारगेटिंग सेटिंग

        स्ट्रिंग

        उम्मीदवार

      • आईडी

        संख्या

        उम्मीदवार का आईडी

      • लेबल

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

        उम्मीदवार के बगल में दिखने वाली छोटी स्ट्रिंग. यह अक्सर शॉर्टकट कुंजी या इंडेक्स होती है

      • parentId

        number ज़रूरी नहीं

        इस आईडी के तहत इन उम्मीदवारों को जोड़ना है

      • इस्तेमाल

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

        शब्द के इस्तेमाल या उसके बारे में जानकारी.

        • body

          स्ट्रिंग

          पूरी जानकारी के ब्यौरे की मुख्य स्ट्रिंग.

        • title

          स्ट्रिंग

          ज़्यादा जानकारी के ब्यौरे का टाइटल स्ट्रिंग.

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जिसके पास कैंडिडेट विंडो का मालिकाना हक है.

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

setCandidateWindowProperties()

प्रॉमिस 
chrome.input.ime.setCandidateWindowProperties(
  parameters: object,
  callback?: function,
): Promise<boolean>

इससे कैंडिडेट विंडो की प्रॉपर्टी सेट की जाती हैं. अगर एक्सटेंशन के पास चालू IME का मालिकाना हक नहीं है, तो यह फ़ंक्शन काम नहीं करता

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • engineID

      स्ट्रिंग

      उस इंजन का आईडी जिस पर प्रॉपर्टी सेट करनी हैं.

    • प्रॉपर्टी

      ऑब्जेक्ट

      • auxiliaryText

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

        उम्मीदवार की विंडो में सबसे नीचे दिखने वाला टेक्स्ट.

      • auxiliaryTextVisible

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

        सहायक टेक्स्ट दिखाने के लिए, इसे सही पर सेट करें. इसे छिपाने के लिए, इसे गलत पर सेट करें.

      • currentCandidateIndex

        number ज़रूरी नहीं

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

        कुल उम्मीदवारों में से, चुने गए मौजूदा उम्मीदवार का इंडेक्स.

      • cursorVisible

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

        कर्सर दिखाने के लिए, True पर सेट करें. कर्सर छिपाने के लिए, False पर सेट करें.

      • pageSize

        number ज़रूरी नहीं

        हर पेज पर दिखाए जाने वाले उम्मीदवारों की संख्या.

      • totalCandidates

        number ज़रूरी नहीं

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

        उम्मीदवार विंडो के लिए उम्मीदवारों की कुल संख्या.

      • वर्टिकल

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

        अगर उम्मीदवार की विंडो को वर्टिकल रेंडर करना है, तो इसे सही पर सेट करें. अगर इसे हॉरिज़ॉन्टल रेंडर करना है, तो इसे गलत पर सेट करें.

      • दिख रहा है

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

        कैंडिडेट विंडो दिखाने के लिए, सही वैल्यू सेट करें. इसे छिपाने के लिए, गलत वैल्यू सेट करें.

      • windowPosition

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

        उम्मीदवार विंडो कहां दिखानी है.

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

setComposition()

प्रॉमिस 
chrome.input.ime.setComposition(
  parameters: object,
  callback?: function,
): Promise<boolean>

मौजूदा कंपोज़िशन सेट करें. अगर इस एक्सटेंशन के पास चालू IME का मालिकाना हक नहीं है, तो यह फ़ंक्शन काम नहीं करेगा.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जहां कंपोज़िशन टेक्स्ट सेट किया जाएगा

    • कर्सर

      संख्या

      कर्सर की जगह.

    • मिलते-जुलते सेगमेंट

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

      सेगमेंट और उनसे जुड़े टाइप की सूची.

      • खत्म करें

        संख्या

        यह उस वर्ण का इंडेक्स होता है जिसके बाद इस सेगमेंट को खत्म करना है.

      • शुरू करें

        संख्या

        वह इंडेक्स जहां से यह सेगमेंट शुरू करना है

      • शैली

        UnderlineStyle

        इस सेगमेंट में बदलाव करने के लिए, अंडरलाइन का टाइप.

    • selectionEnd

      number ज़रूरी नहीं

      टेक्स्ट में वह जगह जहां चुना गया टेक्स्ट खत्म होता है.

    • selectionStart

      number ज़रूरी नहीं

      टेक्स्ट में वह जगह जहां से टेक्स्ट चुना जाना शुरू होता है.

    • टेक्स्ट

      स्ट्रिंग

      सेट करने के लिए टेक्स्ट

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

setCursorPosition()

प्रॉमिस 
chrome.input.ime.setCursorPosition(
  parameters: object,
  callback?: function,
): Promise<boolean>

कैंडिडेट विंडो में कर्सर की पोज़िशन सेट करता है. अगर इस एक्सटेंशन के पास चालू IME का मालिकाना हक नहीं है, तो यह विकल्प काम नहीं करेगा.

पैरामीटर

  • पैरामीटर

    ऑब्जेक्ट

    • candidateID

      संख्या

      चुनने के लिए उम्मीदवार का आईडी.

    • contextID

      संख्या

      उस कॉन्टेक्स्ट का आईडी जिसके पास कैंडिडेट विंडो का मालिकाना हक है.

  • कॉलबैक

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

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

    (success: boolean) => void

    • सफलता

      बूलियन

रिटर्न

  • Promise<boolean>

    Chrome 111+

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

setMenuItems()

प्रॉमिस 
chrome.input.ime.setMenuItems(
  parameters: MenuParameters,
  callback?: function,
): Promise<void>

जब यह IME चालू होता है, तब यह उपलब्ध कराए गए मेन्यू आइटम को भाषा मेन्यू में जोड़ता है.

पैरामीटर

  • पैरामीटर

    MenuParameters

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 111+

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

updateMenuItems()

प्रॉमिस 
chrome.input.ime.updateMenuItems(
  parameters: MenuParameters,
  callback?: function,
): Promise<void>

इससे तय किए गए MenuItems की स्थिति अपडेट होती है

पैरामीटर

  • पैरामीटर

    MenuParameters

  • कॉलबैक

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

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

    () => void

रिटर्न

  • Promise<void>

    Chrome 111+

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

इवेंट

onActivate

chrome.input.ime.onActivate.addListener(
  callback: function,
)

जब IME चालू होता है, तब इस इवेंट को भेजा जाता है. इससे पता चलता है कि IME को onKeyPress इवेंट मिलेंगे.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string, screen: ScreenType) => void

    • engineID

      स्ट्रिंग

    • स्क्रीन

      ScreenType

onAssistiveWindowButtonClicked

Chrome 85 या इसके बाद का वर्शन 
chrome.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

यह इवेंट तब भेजा जाता है, जब किसी ऐक्सेसिबिलिटी विंडो में मौजूद बटन पर क्लिक किया जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (details: object) => void

    • विवरण

      ऑब्जेक्ट

      • क्लिक किए गए बटन का आईडी.

      • windowType

        AssistiveWindowType

        सहायता करने वाली विंडो का टाइप.

onBlur

chrome.input.ime.onBlur.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (contextID: number) => void

    • contextID

      संख्या

onCandidateClicked

chrome.input.ime.onCandidateClicked.addListener(
  callback: function,
)

अगर इस एक्सटेंशन के पास चालू IME का मालिकाना हक है, तो यह इवेंट भेजा जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string, candidateID: number, button: MouseButton) => void

    • engineID

      स्ट्रिंग

    • candidateID

      संख्या

    • बटन

      MouseButton

onDeactivated

chrome.input.ime.onDeactivated.addListener(
  callback: function,
)

जब IME बंद हो जाता है, तब इस इवेंट को भेजा जाता है. इससे पता चलता है कि IME को अब onKeyPress इवेंट नहीं मिलेंगे.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string) => void

    • engineID

      स्ट्रिंग

onFocus

chrome.input.ime.onFocus.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (context: InputContext) => void

onInputContextUpdate

chrome.input.ime.onInputContextUpdate.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (context: InputContext) => void

onKeyEvent

chrome.input.ime.onKeyEvent.addListener(
  callback: function,
)

यह इवेंट तब ट्रिगर होता है, जब ऑपरेटिंग सिस्टम से कोई मुख्य इवेंट भेजा जाता है. अगर एक्सटेंशन के पास ऐक्टिव IME का मालिकाना हक है, तो इवेंट को एक्सटेंशन पर भेजा जाएगा. अगर इवेंट को हैंडल किया गया है, तो लिसनर फ़ंक्शन को सही वैल्यू दिखानी चाहिए. अगर इवेंट को हैंडल नहीं किया गया है, तो उसे गलत वैल्यू दिखानी चाहिए. अगर इवेंट का आकलन एसिंक्रोनस तरीके से किया जाएगा, तो इस फ़ंक्शन को undefined दिखाना होगा. साथ ही, IME को बाद में keyEventHandled() को नतीजे के साथ कॉल करना होगा.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string, keyData: KeyboardEvent, requestId: string) => boolean | undefined

    • engineID

      स्ट्रिंग

    • keyData

      KeyboardEvent

    • requestId

      स्ट्रिंग

    • returns

      boolean | undefined

onMenuItemActivated

chrome.input.ime.onMenuItemActivated.addListener(
  callback: function,
)

जब उपयोगकर्ता कोई मेन्यू आइटम चुनता है, तब इस फ़ंक्शन को कॉल किया जाता है

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string, name: string) => void

    • engineID

      स्ट्रिंग

    • नाम

      स्ट्रिंग

onReset

chrome.input.ime.onReset.addListener(
  callback: function,
)

इस इवेंट को तब भेजा जाता है, जब Chrome, टेक्स्ट डालने के चालू सेशन को बंद कर देता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string) => void

    • engineID

      स्ट्रिंग

onSurroundingTextChanged

chrome.input.ime.onSurroundingTextChanged.addListener(
  callback: function,
)

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

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

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

    (engineID: string, surroundingInfo: object) => void

    • engineID

      स्ट्रिंग

    • surroundingInfo

      ऑब्जेक्ट

      • एंकर

        संख्या

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

      • फ़ोकस

        संख्या

        चुने गए हिस्से के खत्म होने की जगह. अगर कोई टेक्स्ट नहीं चुना गया है, तो इस वैल्यू से कर्सर की पोज़िशन का पता चलता है.

      • ऑफ़सेट

        संख्या

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

        text की ऑफ़सेट पोज़िशन. text में कर्सर के आस-पास का टेक्स्ट शामिल होता है. इसलिए, ऑफ़सेट से text के पहले वर्ण की पक्की जगह का पता चलता है.

      • टेक्स्ट

        स्ट्रिंग

        कर्सर के आस-पास मौजूद टेक्स्ट. यह इनपुट फ़ील्ड में मौजूद टेक्स्ट का सिर्फ़ एक सबसेट है.