chrome.input.ime

توضیحات

از chrome.input.ime API برای پیاده سازی یک IME سفارشی برای سیستم عامل Chrome استفاده کنید. این به برنامه افزودنی شما اجازه می‌دهد تا با زدن کلید، ترکیب بندی را تنظیم کرده و پنجره نامزد را مدیریت کند.

مجوزها

input

برای استفاده از input.ime API باید مجوز «ورودی» را در مانیفست افزونه اعلام کنید. به عنوان مثال: 

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

در دسترس بودن

فقط ChromeOS

نمونه ها

کد زیر یک 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

"لغو"

"افزودن دیکشنری"

AssistiveWindowProperties

Chrome 85+

ویژگی های پنجره کمکی

خواص

  • announceString

    رشته اختیاری

    رشته هایی برای ChromeVox برای اعلام.

  • نوع

    "لغو"

  • قابل مشاهده است

    بولی

    مقدار true را برای نمایش AssistiveWindow تنظیم می کند، false را برای پنهان کردن تنظیم می کند.

AssistiveWindowType

Chrome 85+

نوع پنجره کمکی

ارزش

"لغو"

AutoCapitalizeType

Chrome 69+

نوع بزرگ‌نویسی خودکار فیلد متن.

Enum

"شخصیت ها"

"کلمات"

"جملات"

InputContext

یک متن ورودی را توصیف می کند

خواص

  • خودکار بزرگ کردن

    AutoCapitalizeType

    Chrome 69+

    نوع بزرگ‌نویسی خودکار فیلد متن.

  • تکمیل خودکار

    بولی

    آیا فیلد متنی می‌خواهد تکمیل خودکار شود.

  • تصحیح خودکار

    بولی

    آیا فیلد نوشتاری تصحیح خودکار می‌خواهد.

  • contextID

    شماره

    این برای تعیین اهداف عملیات میدان متنی استفاده می شود. این شناسه به محض فراخوانی onBlur نامعتبر می شود.

  • shouldDoLearning

    بولی

    Chrome 68+

    اینکه آیا متن وارد شده در قسمت متن باید برای بهبود پیشنهادهای تایپ برای کاربر استفاده شود یا خیر.

  • غلط املایی

    بولی

    آیا فیلد متنی می‌خواهد املا را بررسی کند.

  • نوع مقداری که این فیلد متنی ویرایش می کند (متن، شماره، URL و غیره)

InputContextType

Chrome 44+

نوع مقداری که این فیلد متنی ویرایش می کند (متن، شماره، URL و غیره)

Enum

"متن"

"جستجو"

"تل"

"url"

"ایمیل"

"تعداد"

"رمز عبور"

"تهی"

KeyboardEvent

به http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent مراجعه کنید

خواص

  • altKey

    بولی اختیاری

    خواه کلید ALT فشار داده شود یا نه.

  • altgrKey

    بولی اختیاری

    Chrome 79+

    خواه کلید ALTGR فشار داده شود یا نه.

  • capsLock

    بولی اختیاری

    CAPS_LOCK فعال است یا خیر.

  • کد

    رشته

    مقدار کلید فیزیکی در حال فشار دادن این مقدار تحت تأثیر چیدمان فعلی صفحه کلید یا وضعیت اصلاح کننده قرار نمی گیرد.

  • ctrlKey

    بولی اختیاری

    این که آیا کلید CTRL فشار داده شده است یا نه.

  • شناسه extension

    رشته اختیاری

    شناسه برنامه افزودنی فرستنده این رویداد کلیدی.

  • کلید

    رشته

    مقدار کلید در حال فشردن

  • کد کلید

    شماره اختیاری

    کد کلید HTML منسوخ، که کد عددی وابسته به سیستم و پیاده‌سازی است و نشان دهنده شناسه اصلاح نشده مرتبط با کلید فشرده شده است.

  • درخواست شناسه

    رشته اختیاری

    (منسوخ شده) شناسه درخواست. به جای آن از پارامتر requestId از رویداد onKeyEvent استفاده کنید.

  • shiftKey

    بولی اختیاری

    اینکه آیا کلید SHIFT فشار داده شده است یا نه.

  • یکی از keyup یا keydown.

KeyboardEventType

Chrome 44+

Enum

"کلید آپ"

"کلید داون"

MenuItem

یک آیتم منو که توسط یک روش ورودی برای تعامل با کاربر از منوی زبان استفاده می شود.

خواص

  • بررسی شد

    بولی اختیاری

    نشان می دهد که این مورد باید با چک کشیده شود.

  • فعال شد

    بولی اختیاری

    نشان می دهد که این مورد فعال است.

  • شناسه

    رشته

    رشته ای که به تماس هایی که به این آیتم منو ارجاع می دهند ارسال می شود.

  • برچسب زدن

    رشته اختیاری

    متن در منوی این مورد نمایش داده می شود.

  • سبک

    MenuItemStyle اختیاری است

    نوع آیتم منو

  • قابل مشاهده است

    بولی اختیاری

    نشان می دهد که این مورد قابل مشاهده است.

MenuItemStyle

Chrome 44+

نوع آیتم منو دکمه های رادیویی بین جداکننده ها به صورت گروهی در نظر گرفته می شوند.

Enum

"بررسی"

"رادیو"

"جداکننده"

MenuParameters

Chrome 88+

خواص

  • شناسه موتور

    رشته

    شناسه موتور مورد استفاده

  • موارد

    آیتم منو []

    آیتم های منو برای افزودن یا به روز رسانی. آنها به ترتیبی که در آرایه وجود دارند اضافه می شوند.

MouseButton

Chrome 44+

کدام دکمه های ماوس کلیک شد.

Enum

"چپ"

"وسط"

"درست"

ScreenType

Chrome 44+

نوع صفحه ای که تحت آن IME فعال می شود.

Enum

"عادی"

"ورود به سیستم"

"قفل"

"ثانویه-ورود"

UnderlineStyle

Chrome 44+

نوع خط زیر برای اصلاح این بخش.

Enum

"زیر خط بکش"

"Double Underline"

"بدون زیر خط"

WindowPosition

Chrome 44+

محل نمایش پنجره نامزد. اگر روی "مکان نما" تنظیم شود، پنجره از مکان نما پیروی می کند. اگر روی "ترکیب" تنظیم شود، پنجره به ابتدای ترکیب قفل می شود.

Enum

"مکان نما"

"ترکیب"

روش ها

clearComposition()

قول بده
chrome.input.ime.clearComposition(
  parameters: object,
  callback?: function,
)

ترکیب فعلی را پاک کنید. اگر این برنامه افزودنی دارای IME فعال نباشد، این کار انجام نمی شود.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه ای که ترکیب پاک می شود

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

commitText()

قول بده
chrome.input.ime.commitText(
  parameters: object,
  callback?: function,
)

متن ارائه شده را به ورودی فعلی متعهد می کند.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه ای که متن در آن متعهد خواهد شد

    • متن

      رشته

      متن به تعهد

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

deleteSurroundingText()

قول بده
chrome.input.ime.deleteSurroundingText(
  parameters: object,
  callback?: function,
)

متن اطراف کارت را حذف می کند.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه ای که متن اطراف آن حذف خواهد شد.

    • شناسه موتور

      رشته

      شناسه موتور دریافت کننده رویداد.

    • طول

      شماره

      تعداد کاراکترهایی که باید حذف شوند

    • جبران

      شماره

      انحراف از موقعیت Caret که در آن حذف شروع می شود. این مقدار می تواند منفی باشد.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

hideInputView()

chrome.input.ime.hideInputView()

پنجره نمای ورودی را پنهان می کند که به طور خودکار توسط سیستم ظاهر می شود. اگر پنجره نمای ورودی قبلاً پنهان باشد، این تابع هیچ کاری انجام نمی دهد.

keyEventHandled()

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

نشان می دهد که رویداد کلیدی دریافت شده توسط onKeyEvent مدیریت می شود. این فقط در صورتی باید فراخوانی شود که شنونده onKeyEvent ناهمزمان باشد.

پارامترها

  • درخواست شناسه

    رشته

    درخواست شناسه رویدادی که رسیدگی شد. این باید از keyEvent.requestId باشد

  • پاسخ

    بولی

    درست است اگر ضربه زدن به کلید انجام شود، نادرست است اگر نه

sendKeyEvents()

قول بده
chrome.input.ime.sendKeyEvents(
  parameters: object,
  callback?: function,
)

رویدادهای کلیدی را ارسال می کند. انتظار می رود این عملکرد توسط کیبوردهای مجازی استفاده شود. هنگامی که کلید(های) روی صفحه کلید مجازی توسط کاربر فشار داده می شود، از این تابع برای انتشار آن رویداد به سیستم استفاده می شود.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه ای که رویدادهای کلیدی در آن ارسال خواهند شد، یا صفر برای ارسال رویدادهای کلیدی به فیلد غیر ورودی.

    • داده های کلیدی

      رویداد کیبورد []

      داده های مربوط به رویداد کلیدی

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setAssistiveWindowButtonHighlighted()

Promise Chrome 86+
chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
)

یک دکمه را در یک پنجره کمکی برجسته می کند / برجسته نمی کند.

پارامترها

  • پارامترها

    شی

    • announceString

      رشته اختیاری

      متنی که اسکرین خوان اعلام می کند.

    • شناسه دکمه

      AssistiveWindowButton

      شناسه دکمه

    • contextID

      شماره

      شناسه زمینه مالک پنجره کمکی.

    • برجسته شده است

      بولی

      اینکه آیا دکمه باید برجسته شود یا خیر.

    • نوع پنجره

      "لغو"

      نوع پنجره ای که دکمه به آن تعلق دارد.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setAssistiveWindowProperties()

Promise Chrome 85+
chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
)

یک پنجره کمکی با ویژگی های داده شده را نشان می دهد/پنهان می کند.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه مالک پنجره کمکی.

    • ویژگی های پنجره کمکی

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setCandidates()

قول بده
chrome.input.ime.setCandidates(
  parameters: object,
  callback?: function,
)

لیست نامزد فعلی را تنظیم می کند. اگر این افزونه مالک IME فعال نباشد، این کار انجام نمی‌شود

پارامترها

  • پارامترها

    شی

    • نامزدها

      شیء[]

      لیست کاندیداهایی که در پنجره نامزد نمایش داده می شوند

      • حاشیه نویسی

        رشته اختیاری

        متن اضافی در توصیف نامزد

      • نامزد

        رشته

        نامزد

      • شناسه

        شماره

        شناسه نامزد

      • برچسب زدن

        رشته اختیاری

        رشته کوتاه در کنار نامزد نمایش داده می شود، اغلب کلید میانبر یا نمایه

      • شناسه والدین

        شماره اختیاری

        شناسه برای اضافه کردن این نامزدها در زیر

      • استفاده

        شی اختیاری

        استفاده یا شرح جزئیات کلمه.

        • بدن

          رشته

          رشته بدنه شرح جزئیات.

        • عنوان

          رشته

          رشته عنوان توضیحات جزئیات.

    • contextID

      شماره

      شناسه زمینه ای که دارای پنجره نامزد است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setCandidateWindowProperties()

قول بده
chrome.input.ime.setCandidateWindowProperties(
  parameters: object,
  callback?: function,
)

ویژگی های پنجره کاندید را تنظیم می کند. اگر برنامه افزودنی مالک IME فعال نباشد، این کار انجام نمی‌شود

پارامترها

  • پارامترها

    شی

    • شناسه موتور

      رشته

      شناسه موتور برای تنظیم خصوصیات.

    • خواص

      شی

      • متن کمکی

        رشته اختیاری

        متنی که در پایین پنجره نامزد نشان داده شده است.

      • auxiliaryTextVisible

        بولی اختیاری

        درست برای نمایش متن کمکی، غلط برای پنهان کردن آن.

      • CurrentCandidateIndex

        شماره اختیاری

        Chrome 84+

        شاخص نامزد منتخب فعلی از کل نامزدها.

      • مکان نما قابل مشاهده

        بولی اختیاری

        درست برای نشان دادن مکان نما، نادرست برای پنهان کردن آن.

      • اندازه صفحه

        شماره اختیاری

        تعداد نامزدها برای نمایش در هر صفحه.

      • کل کاندیدها

        شماره اختیاری

        Chrome 84+

        تعداد کل نامزدها برای پنجره کاندیدا.

      • عمودی

        بولی اختیاری

        درست است اگر پنجره کاندید باید عمودی باشد، غلط است تا افقی شود.

      • قابل مشاهده است

        بولی اختیاری

        درست برای نمایش پنجره Candidate، غلط برای پنهان کردن آن.

      • موقعیت پنجره

        WindowPosition اختیاری است

        محل نمایش پنجره نامزد.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setComposition()

قول بده
chrome.input.ime.setComposition(
  parameters: object,
  callback?: function,
)

ترکیب فعلی را تنظیم کنید. اگر این برنامه افزودنی دارای IME فعال نباشد، این کار انجام نمی شود.

پارامترها

  • پارامترها

    شی

    • contextID

      شماره

      شناسه زمینه ای که متن ترکیب در آن تنظیم خواهد شد

    • مکان نما

      شماره

      موقعیت در متن مکان نما.

    • بخش ها

      شی[] اختیاری

      فهرست بخش ها و انواع مرتبط با آنها

      • پایان

        شماره

        فهرست کاراکتر برای پایان دادن به این بخش پس از آن.

      • شروع کنید

        شماره

        فهرست کاراکتر برای شروع این بخش

      • نوع خط زیر برای اصلاح این بخش.

    • انتخاب پایان

      شماره اختیاری

      موقعیتی در متنی که انتخاب به آن ختم می شود.

    • انتخاب شروع

      شماره اختیاری

      موقعیتی در متن که انتخاب از آن شروع می شود.

    • متن

      رشته

      متن برای تنظیم

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setCursorPosition()

قول بده
chrome.input.ime.setCursorPosition(
  parameters: object,
  callback?: function,
)

موقعیت مکان نما را در پنجره نامزد تنظیم کنید. اگر این برنامه افزودنی دارای IME فعال نباشد، این کار ممنوع است.

پارامترها

  • پارامترها

    شی

    • شناسه داوطلب

      شماره

      شناسه کاندیدا برای انتخاب

    • contextID

      شماره

      شناسه زمینه ای که دارای پنجره نامزد است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (success: boolean) => void

    • موفقیت

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setMenuItems()

قول بده
chrome.input.ime.setMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

وقتی این IME فعال است، موارد منوی ارائه شده را به منوی زبان اضافه می کند.

پارامترها

  • پارامترها

    پارامترهای منو

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

updateMenuItems()

قول بده
chrome.input.ime.updateMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

وضعیت منوی آیتم های مشخص شده را به روز می کند

پارامترها

  • پارامترها

    پارامترهای منو

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 111+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

رویدادها

onActivate

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

این رویداد زمانی ارسال می شود که یک IME فعال شود. این سیگنال نشان می دهد که IME رویدادهای onKeyPress را دریافت خواهد کرد.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

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

onAssistiveWindowButtonClicked

Chrome 85+
chrome.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

این رویداد زمانی ارسال می شود که دکمه ای در یک پنجره کمکی کلیک شود.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (details: object) => void

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

    • شناسه موتور

      رشته

    • شناسه داوطلب

      شماره

onDeactivated

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

این رویداد زمانی ارسال می شود که یک IME غیرفعال شود. این نشان می دهد که IME دیگر رویدادهای onKeyPress را دریافت نخواهد کرد.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (engineID: string) => void

    • شناسه موتور

      رشته

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 فعال باشد، رویداد به برنامه افزودنی ارسال خواهد شد. اگر رویداد نادرست مدیریت شده باشد، تابع شنونده باید true را برگرداند. اگر رویداد به صورت ناهمزمان ارزیابی شود، این تابع باید تعریف نشده برگردد و IME باید بعداً keyEventHandled() را با نتیجه فراخوانی کند.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

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

    • شناسه موتور

      رشته

    • داده های کلیدی

      KeyboardEvent

    • درخواست شناسه

      رشته

    • برمی گرداند

      بولی | تعریف نشده

onMenuItemActivated

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

زمانی که کاربر یک آیتم منو را انتخاب می کند، فراخوانی می شود

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

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

    • شناسه موتور

      رشته

    • نام

      رشته

onReset

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

این رویداد زمانی ارسال می‌شود که Chrome جلسه ورودی متن جاری را پایان می‌دهد.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (engineID: string) => void

    • شناسه موتور

      رشته

onSurroundingTextChanged

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

هنگامی که رشته قابل ویرایش در اطراف کارت تغییر می کند یا زمانی که موقعیت کارت جابجا می شود، فراخوانی می شود. طول متن برای هر جهت عقب و جلو به 100 کاراکتر محدود شده است.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

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

    • شناسه موتور

      رشته

    • اطلاعات پیرامون

      شی

      • لنگر

        شماره

        موقعیت ابتدایی انتخاب. اگر انتخابی وجود نداشته باشد، این مقدار نشان دهنده موقعیت کارت است.

      • تمرکز کنید

        شماره

        موقعیت پایانی انتخاب. اگر انتخابی وجود نداشته باشد، این مقدار نشان دهنده موقعیت کارت است.

      • جبران

        شماره

        Chrome 46+

        موقعیت افست text از آنجایی که text فقط شامل زیرمجموعه ای از متن در اطراف مکان نما می شود، افست موقعیت مطلق اولین کاراکتر text را نشان می دهد.

      • متن

        رشته

        متن اطراف مکان نما. این فقط زیرمجموعه ای از تمام متن در قسمت ورودی است.