หน้านี้ได้รับการแปลโดย Cloud Translation API

chrome.input.ime

คำอธิบาย

ใช้ chrome.input.ime API เพื่อใช้งาน IME ที่กำหนดเองสำหรับ Chrome OS ซึ่งจะช่วยให้ส่วนขยายสามารถจัดการการกดแป้นพิมพ์ ตั้งค่าการเรียบเรียง และจัดการหน้าต่างที่รอพิจารณา

สิทธิ์

input

คุณต้องประกาศสิทธิ์ "input" ในไฟล์ Manifest ของส่วนขยายเพื่อใช้ Input.ime API เช่น

{
  "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 ขึ้นไป

รหัสของปุ่มในหน้าต่างอำนวยความสะดวก

ค่าแจกแจง

"addToDictionary"

AssistiveWindowProperties

Chrome เวอร์ชัน 85 ขึ้นไป

คุณสมบัติของหน้าต่างความช่วยเหลือพิเศษ

พร็อพเพอร์ตี้

announceString

string ไม่บังคับ

สตริงสำหรับ ChromeVox ที่จะประกาศ
ประเภท
มองเห็นได้

boolean

ตั้งค่าเป็น "จริง" เพื่อแสดง AssistiveWindow ตั้งค่า "เท็จ" เป็นซ่อน

AssistiveWindowType

Chrome เวอร์ชัน 85 ขึ้นไป

ประเภทหน้าต่างอำนวยความสะดวก

ค่า

AutoCapitalizeType

Chrome 69 ขึ้นไป

ประเภทการใช้อักษรตัวพิมพ์ใหญ่อัตโนมัติของช่องข้อความ

ค่าแจกแจง

InputContext

อธิบายบริบทของอินพุต

พร็อพเพอร์ตี้

autoCapitalize

AutoCapitalizeType

Chrome 69 ขึ้นไป

ประเภทการใช้อักษรตัวพิมพ์ใหญ่อัตโนมัติของช่องข้อความ
autoComplete

boolean

ฟิลด์ข้อความต้องการการเติมข้อความอัตโนมัติหรือไม่
autoCorrect

boolean

ช่องข้อความต้องการให้แก้ไขอัตโนมัติหรือไม่
contextID

ตัวเลข

ใช้เพื่อระบุเป้าหมายของการดำเนินการช่องข้อความ รหัสนี้จะใช้ไม่ได้ทันทีที่มีการเรียก onBlur
shouldDoLearning

boolean

Chrome 68 ขึ้นไป

ควรใช้ข้อความที่ป้อนในช่องข้อความเพื่อปรับปรุงคำแนะนำในการพิมพ์สำหรับผู้ใช้หรือไม่
spellCheck

boolean

ฟิลด์ข้อความต้องการตรวจสอบการสะกดหรือไม่
ประเภท

InputContextType

ประเภทค่าการแก้ไขช่องข้อความนี้ (ข้อความ, ตัวเลข, URL ฯลฯ)

InputContextType

Chrome 44 ขึ้นไป

ประเภทค่าการแก้ไขช่องข้อความนี้ (ข้อความ, ตัวเลข, URL ฯลฯ)

ค่าแจกแจง

"tel"

"url"

"null"

KeyboardEvent

ดู http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

พร็อพเพอร์ตี้

altKey

บูลีน ไม่บังคับ

มีการกดแป้น ALT หรือไม่
altgrKey

บูลีน ไม่บังคับ

Chrome เวอร์ชัน 79 ขึ้นไป

มีการกดแป้น ALTGR หรือไม่
capsLock

บูลีน ไม่บังคับ

CAPS_LOCK เปิดใช้งานอยู่หรือไม่
รหัส

string

ค่าของคีย์จริงที่มีการกด ค่าดังกล่าวจะไม่ได้รับผลกระทบจากรูปแบบแป้นพิมพ์ปัจจุบันหรือสถานะของตัวปรับแต่ง
ctrlKey

บูลีน ไม่บังคับ

มีการกดแป้น Ctrl หรือไม่
extensionId

string ไม่บังคับ

รหัสส่วนขยายของผู้ส่งเหตุการณ์สำคัญนี้
แป้น

string

ค่าของคีย์ที่กด
keyCode

ตัวเลข ไม่บังคับ

KeyCode สำหรับ HTML ที่เลิกใช้งานแล้วซึ่งเป็นโค้ดตัวเลขที่ขึ้นอยู่กับระบบและการติดตั้งใช้งานจะระบุตัวระบุที่ไม่มีการแก้ไขซึ่งเชื่อมโยงกับแป้นที่กด
requestId

string ไม่บังคับ

(เลิกใช้งาน) รหัสของคำขอ โปรดใช้พารามิเตอร์ requestId จากเหตุการณ์ onKeyEvent แทน
shiftKey

บูลีน ไม่บังคับ

มีการกดแป้น SHIFT หรือไม่
ประเภท

KeyboardEventType

กดปุ่มเดียวหรือปุ่มลง

KeyboardEventType

Chrome 44 ขึ้นไป

ค่าแจกแจง

MenuItem

รายการในเมนูที่วิธีการป้อนข้อมูลใช้เพื่อโต้ตอบกับผู้ใช้จากเมนูภาษา

พร็อพเพอร์ตี้

เลือกไว้

บูลีน ไม่บังคับ

ระบุว่ารายการนี้ควรวาดด้วยเช็ค
เปิดใช้อยู่

บูลีน ไม่บังคับ

บ่งบอกว่ารายการนี้เปิดใช้งาน
id

string

สตริงที่จะส่งไปยังโค้ดเรียกกลับที่อ้างอิง MenuItem นี้
ป้ายกำกับ

string ไม่บังคับ

ข้อความแสดงในเมนูสำหรับรายการนี้
รูปแบบ

MenuItemStyle ไม่บังคับ

ประเภทของรายการในเมนู
มองเห็นได้

บูลีน ไม่บังคับ

บ่งบอกว่ารายการนี้มองเห็นได้

MenuItemStyle

Chrome 44 ขึ้นไป

ประเภทของรายการในเมนู ระบบจะถือว่าปุ่มตัวเลือกระหว่างตัวคั่นต่างๆ อยู่เป็นกลุ่ม

ค่าแจกแจง

MenuParameters

Chrome เวอร์ชัน 88 ขึ้นไป

พร็อพเพอร์ตี้

engineID

string

รหัสของเครื่องมือที่จะใช้
items

MenuItem[]

MenuItem ที่จะเพิ่มหรืออัปเดต ระบบจะเพิ่มแท็กตามลำดับที่มีอยู่ในอาร์เรย์

MouseButton

Chrome 44 ขึ้นไป

ปุ่มเมาส์ที่มีการคลิก

ค่าแจกแจง

ScreenType

Chrome 44 ขึ้นไป

ประเภทหน้าจอที่เปิดใช้งาน IME

ค่าแจกแจง

UnderlineStyle

Chrome 44 ขึ้นไป

ประเภทของการขีดเส้นใต้เพื่อแก้ไขกลุ่มนี้

ค่าแจกแจง

"noUnderline"

WindowPosition

Chrome 44 ขึ้นไป

ตำแหน่งที่จะแสดงหน้าต่างตัวเลือก หากตั้งค่าเป็น "เคอร์เซอร์" หน้าต่างจะเลื่อนตามเคอร์เซอร์ หากตั้งค่าเป็น "composition" หน้าต่างจะถูกล็อกไว้ที่จุดเริ่มต้นของการเขียนข้อความ

ค่าแจกแจง

วิธีการ

clearComposition()

สัญญา

chrome.input.ime.clearComposition(
  parameters: object,
  callback?: function,
)

ล้างการเรียบเรียงปัจจุบัน หากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่ จะไม่สำเร็จ

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่จะล้างการเรียบเรียง
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

commitText()

สัญญา

chrome.input.ime.commitText(
  parameters: object,
  callback?: function,
)

ยืนยันข้อความที่ระบุกับอินพุตปัจจุบัน

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่จะดำเนินการกับข้อความ
- ข้อความ
  
  string
  
  ข้อความที่จะยืนยัน
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

deleteSurroundingText()

สัญญา

chrome.input.ime.deleteSurroundingText(
  parameters: object,
  callback?: function,
)

ลบข้อความรอบเครื่องหมาย Caret

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่ข้อความรอบข้างจะถูกลบ
- engineID
  
  string
  
  รหัสของเครื่องมือที่ได้รับเหตุการณ์
- length
  
  ตัวเลข
  
  จำนวนอักขระที่จะลบ
- ออฟเซ็ต
  
  ตัวเลข
  
  ออฟเซ็ตจากตำแหน่งเคอร์เซอร์ข้อความที่จะเริ่มต้นการลบ ค่านี้อาจเป็นลบได้
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
()=>void
```

การคืนสินค้า

Promise<void>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

hideInputView()

chrome.input.ime.hideInputView()

ซ่อนหน้าต่างมุมมองการป้อนข้อมูล ซึ่งระบบจะแสดงป๊อปอัปโดยอัตโนมัติ หากหน้าต่างมุมมองอินพุตซ่อนอยู่ ฟังก์ชันนี้จะไม่ดำเนินการใดๆ

keyEventHandled()

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

บ่งบอกว่ามีการจัดการเหตุการณ์สำคัญที่ onKeyEvent ได้รับ ควรเรียกสิ่งนี้ก็ต่อเมื่อ Listener onKeyEvent ไม่พร้อมกัน

พารามิเตอร์

requestId

string

รหัสคำขอของเหตุการณ์ที่จัดการ ซึ่งควรมาจาก keyEvent.requestId
การตอบกลับ

boolean

จริง หากมีการจัดการการกดแป้นพิมพ์ เท็จ หากไม่เป็นเช่นนั้น

sendKeyEvents()

สัญญา

chrome.input.ime.sendKeyEvents(
  parameters: object,
  callback?: function,
)

ส่งเหตุการณ์สําคัญ แป้นพิมพ์เสมือนต้องใช้ฟังก์ชันนี้ เมื่อผู้ใช้กดแป้นบนแป้นพิมพ์เสมือน ฟังก์ชันนี้จะใช้เพื่อเผยแพร่เหตุการณ์นั้นไปยังระบบ

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่จะส่งเหตุการณ์สำคัญ หรือ 0 เพื่อส่งเหตุการณ์สำคัญไปยังช่องที่ไม่ใช่อินพุต
- keyData
  
  KeyboardEvent[]
  
  ข้อมูลเกี่ยวกับเหตุการณ์สําคัญ
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
()=>void
```

การคืนสินค้า

Promise<void>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setAssistiveWindowButtonHighlighted()

คำมั่นสัญญา Chrome เวอร์ชัน 86 ขึ้นไป

chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
)

ไฮไลต์/เลิกไฮไลต์ปุ่มในหน้าต่างอำนวยความสะดวก

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- announceString
  
  string ไม่บังคับ
  
  ข้อความที่จะให้โปรแกรมอ่านหน้าจออ่าน
- buttonID
  
  AssistiveWindowButton
  
  รหัสของปุ่ม
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่เป็นเจ้าของหน้าต่างความช่วยเหลือพิเศษ
- ไฮไลต์ไว้
  
  boolean
  
  ควรไฮไลต์ปุ่มไหม
- windowType
  
  ประเภทหน้าต่างที่ปุ่มอยู่
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
()=>void
```

การคืนสินค้า

Promise<void>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setAssistiveWindowProperties()

คำมั่นสัญญา Chrome เวอร์ชัน 85 ขึ้นไป

chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
)

แสดง/ซ่อนหน้าต่างความช่วยเหลือพร้อมคุณสมบัติที่ระบุ

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่เป็นเจ้าของหน้าต่างความช่วยเหลือพิเศษ
- พร็อพเพอร์ตี้
  
  AssistiveWindowProperties
  
  คุณสมบัติของหน้าต่างความช่วยเหลือพิเศษ
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setCandidates()

สัญญา

chrome.input.ime.setCandidates(
  parameters: object,
  callback?: function,
)

ตั้งค่ารายชื่อผู้สมัครปัจจุบัน การทำงานล้มเหลวหากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- ผู้สมัคร
  
  ออบเจ็กต์[]
  
  รายชื่อผู้สมัครที่จะแสดงในหน้าต่างผู้สมัคร
  - คำอธิบายประกอบ
    
    string ไม่บังคับ
    
    ข้อความเพิ่มเติมที่อธิบายผู้สมัคร
  - ตัวเลือก
    
    string
    
    ผู้สมัคร
  - id
    
    ตัวเลข
    
    รหัสของผู้สมัคร
  - ป้ายกำกับ
    
    string ไม่บังคับ
    
    สตริงสั้นๆ ที่แสดงถัดจากตัวเลือก ซึ่งมักจะเป็นแป้นพิมพ์ลัดหรือดัชนี
  - parentId
    
    ตัวเลข ไม่บังคับ
    
    รหัสสำหรับเพิ่มคำที่แนะนำเหล่านี้
  - การใช้งาน
    
    ออบเจ็กต์ ไม่บังคับ
    
    การใช้งานหรือคำอธิบายรายละเอียดของคำ
    
    body
    
    string
    
    สตริงเนื้อหาของคำอธิบายรายละเอียด
    
    title
    
    string
    
    สตริงชื่อของคำอธิบายรายละเอียด
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่เป็นเจ้าของหน้าต่างที่รอการพิจารณา
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setCandidateWindowProperties()

สัญญา

chrome.input.ime.setCandidateWindowProperties(
  parameters: object,
  callback?: function,
)

ตั้งค่าพร็อพเพอร์ตี้ของหน้าต่างตัวเลือก การทำงานล้มเหลวหากส่วนขยายไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- engineID
  
  string
  
  รหัสของเครื่องมือที่จะตั้งค่าพร็อพเพอร์ตี้
- พร็อพเพอร์ตี้
  
  ออบเจ็กต์
  - auxiliaryText
    
    string ไม่บังคับ
    
    ข้อความจะแสดงที่ด้านล่างของหน้าต่างที่รอการพิจารณา
  - auxiliaryTextVisible
    
    บูลีน ไม่บังคับ
    
    "จริง" เพื่อแสดงข้อความเสริม "เท็จ" เพื่อซ่อนข้อความ
  - currentCandidateIndex
    
    ตัวเลข ไม่บังคับ
    
    Chrome เวอร์ชัน 84 ขึ้นไป
    
    ดัชนีของผู้สมัครที่เลือกไว้ในปัจจุบันจากผู้สมัครทั้งหมด
  - cursorVisible
    
    บูลีน ไม่บังคับ
    
    "จริง" เพื่อแสดงเคอร์เซอร์ "เท็จ" เพื่อซ่อนเคอร์เซอร์
  - pageSize
    
    ตัวเลข ไม่บังคับ
    
    จำนวนตัวเลือกที่จะแสดงต่อ 1 หน้า
  - totalCandidates
    
    ตัวเลข ไม่บังคับ
    
    Chrome เวอร์ชัน 84 ขึ้นไป
    
    จำนวนผู้สมัครทั้งหมดในช่วงเวลาของผู้สมัคร
  - แนวตั้ง
    
    บูลีน ไม่บังคับ
    
    จริง หากหน้าต่างตัวเลือกควรแสดงในแนวตั้ง หรือ "เท็จ" เพื่อทำให้เป็นแนวนอน
  - มองเห็นได้
    
    บูลีน ไม่บังคับ
    
    "จริง" เพื่อแสดงหน้าต่างผู้สมัคร "เท็จ" หากซ่อนไว้
  - windowPosition
    
    WindowPosition ไม่บังคับ
    
    ตำแหน่งที่จะแสดงหน้าต่างตัวเลือก
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setComposition()

สัญญา

chrome.input.ime.setComposition(
  parameters: object,
  callback?: function,
)

กำหนดองค์ประกอบปัจจุบัน หากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่ จะไม่สำเร็จ

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่จะจัดข้อความการเรียบเรียง
- เคอร์เซอร์
  
  ตัวเลข
  
  ตำแหน่งในข้อความของเคอร์เซอร์
- กลุ่มเป้าหมายที่คล้ายกัน
  
  object[] ไม่บังคับ
  
  รายการกลุ่มและประเภทที่เกี่ยวข้อง
  - สิ้นสุด
    
    ตัวเลข
    
    ดัชนีของอักขระที่จะสิ้นสุดส่วนนี้หลังจากนั้น
  - เริ่มต้น
    
    ตัวเลข
    
    ดัชนีของอักขระเพื่อเริ่มส่วนนี้ที่
  - รูปแบบ
    
    UnderlineStyle
    
    ประเภทของการขีดเส้นใต้เพื่อแก้ไขกลุ่มนี้
- selectionEnd
  
  ตัวเลข ไม่บังคับ
  
  ตําแหน่งในข้อความที่การเลือกสิ้นสุด
- selectionStart
  
  ตัวเลข ไม่บังคับ
  
  ตําแหน่งในข้อความที่การเลือกเริ่มต้น
- ข้อความ
  
  string
  
  ข้อความที่จะตั้งค่า
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setCursorPosition()

สัญญา

chrome.input.ime.setCursorPosition(
  parameters: object,
  callback?: function,
)

กำหนดตำแหน่งของเคอร์เซอร์ในหน้าต่างตัวเลือก รายการนี้จะไม่ดำเนินการหากส่วนขยายนี้ไม่ได้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

พารามิเตอร์

ออบเจ็กต์
- candidateID
  
  ตัวเลข
  
  รหัสของผู้สมัครที่จะเลือก
- contextID
  
  ตัวเลข
  
  รหัสของบริบทที่เป็นเจ้าของหน้าต่างที่รอการพิจารณา
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean)=>void
```
- สำเร็จ
  
  boolean

การคืนสินค้า

Promise<boolean>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

setMenuItems()

สัญญา

chrome.input.ime.setMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

เพิ่มรายการเมนูที่มีให้ลงในเมนูภาษาเมื่อเปิดใช้งาน IME นี้

พารามิเตอร์

พารามิเตอร์

MenuParameters
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
()=>void
```

การคืนสินค้า

Promise<void>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

updateMenuItems()

สัญญา

chrome.input.ime.updateMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

อัปเดตสถานะของ MenuItems ที่ระบุ

พารามิเตอร์

พารามิเตอร์

MenuParameters
Callback

ฟังก์ชัน ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
()=>void
```

การคืนสินค้า

Promise<void>

Chrome 111 ขึ้นไป

Manifest V3 ขึ้นไปรองรับคำสัญญา แต่จะใช้โค้ดเรียกกลับเพื่อความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 ฟีเจอร์ในการเรียกใช้ฟังก์ชันเดียวกันได้ คำสัญญาจะยุติด้วยประเภทเดียวกันกับที่ส่งไปยังโค้ดเรียกกลับ

กิจกรรม

onActivate

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

ระบบจะส่งเหตุการณ์นี้เมื่อเปิดใช้งาน IME เพื่อส่งสัญญาณว่า IME จะได้รับเหตุการณ์ onKeyPress

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string,screen: ScreenType)=>void
```
- engineID
  
  string
- หน้าจอ
  
  ScreenType

onAssistiveWindowButtonClicked

Chrome เวอร์ชัน 85 ขึ้นไป

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

ระบบจะส่งเหตุการณ์นี้เมื่อมีการคลิกปุ่มในหน้าต่างอำนวยความสะดวก

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(details: object)=>void
```
- รายละเอียด
  
  ออบเจ็กต์
  - buttonID
    
    AssistiveWindowButton
    
    รหัสของปุ่มที่คลิก
  - windowType
    
    AssistiveWindowType
    
    ประเภทของหน้าต่างความช่วยเหลือพิเศษ

onBlur

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

ระบบจะส่งเหตุการณ์นี้เมื่อโฟกัสออกจากกล่องข้อความ ซึ่งจะส่งไปยังส่วนขยายทั้งหมดที่ฟังเหตุการณ์นี้ และผู้ใช้เปิดใช้เอง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(contextID: number)=>void
```
- contextID
  
  ตัวเลข

onCandidateClicked

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

ระบบจะส่งเหตุการณ์นี้หากส่วนขยายนี้เป็นเจ้าของ IME ที่ใช้งานอยู่

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string,candidateID: number,button: MouseButton)=>void
```
- engineID
  
  string
- candidateID
  
  ตัวเลข
- ปุ่ม
  
  MouseButton

onDeactivated

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

ระบบจะส่งเหตุการณ์นี้เมื่อปิดใช้งาน IME โดยจะส่งสัญญาณว่า IME จะไม่ได้รับเหตุการณ์ onKeyPress อีกต่อไป

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string)=>void
```
- engineID
  
  string

onFocus

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

ระบบจะส่งเหตุการณ์นี้เมื่อโฟกัสเข้าสู่กล่องข้อความ ซึ่งจะส่งไปยังส่วนขยายทั้งหมดที่ฟังเหตุการณ์นี้ และผู้ใช้เปิดใช้เอง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(context: InputContext)=>void
```
- บริบท
  
  InputContext

onInputContextUpdate

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

ระบบจะส่งเหตุการณ์นี้เมื่อคุณสมบัติของ InputContext ปัจจุบันมีการเปลี่ยนแปลง เช่น ประเภท ซึ่งจะส่งไปยังส่วนขยายทั้งหมดที่ฟังเหตุการณ์นี้ และผู้ใช้เปิดใช้เอง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(context: InputContext)=>void
```
- บริบท
  
  InputContext

onKeyEvent

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

เริ่มทำงานเมื่อมีการส่งเหตุการณ์สำคัญจากระบบปฏิบัติการ ระบบจะส่งเหตุการณ์ไปยังส่วนขยายหากส่วนขยายนี้เป็นเจ้าของ IME ที่ใช้งานอยู่ ฟังก์ชัน Listener ควรคืนค่า true ถ้าเหตุการณ์ได้รับการจัดการเป็น false หากไม่เป็นเช่นนั้น หากเหตุการณ์จะได้รับการประเมินแบบไม่พร้อมกัน ฟังก์ชันนี้จะต้องแสดงผลแบบไม่ระบุ และ IME จะต้องเรียก keyEventHandled() พร้อมผลลัพธ์ในภายหลัง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string,keyData: KeyboardEvent,requestId: string)=>boolean|undefined
```
- engineID
  
  string
- keyData
  
  KeyboardEvent
- requestId
  
  string
- returns
  boolean|undefined

onMenuItemActivated

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

โทรออกเมื่อผู้ใช้เลือกรายการในเมนู

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string,name: string)=>void
```
- engineID
  
  string
- ชื่อ
  
  string

onReset

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

ระบบจะส่งเหตุการณ์นี้เมื่อ Chrome สิ้นสุดเซสชันการป้อนข้อความที่ดำเนินอยู่

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string)=>void
```
- engineID
  
  string

onSurroundingTextChanged

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

เรียกใช้เมื่อสตริงที่แก้ไขได้รอบๆ เครื่องหมาย Caret มีการเปลี่ยนแปลงหรือเมื่อมีการย้ายตำแหน่งเคอร์เซอร์ข้อความ ความยาวของข้อความจำกัดอยู่ที่ 100 อักขระสำหรับแต่ละทิศทาง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(engineID: string,surroundingInfo: object)=>void
```
- engineID
  
  string
- surroundingInfo
  
  ออบเจ็กต์
  - แท็ก Anchor
    
    ตัวเลข
    
    ตำแหน่งเริ่มต้นของส่วนที่เลือก ค่านี้แสดงถึงตำแหน่งเคอร์เซอร์ข้อความหากไม่มีการเลือก
  - โฟกัส
    
    ตัวเลข
    
    ตำแหน่งสิ้นสุดของส่วนที่เลือก ค่านี้แสดงถึงตำแหน่งเคอร์เซอร์ข้อความหากไม่มีการเลือก
  - ออฟเซ็ต
    
    ตัวเลข
    
    Chrome 46 ขึ้นไป
    
    ตำแหน่งออฟเซ็ตของ text เนื่องจาก text จะรวมเฉพาะบางส่วนของข้อความรอบๆ เคอร์เซอร์ ออฟเซ็ตจึงระบุตำแหน่งสัมบูรณ์ของอักขระตัวแรกของ text
  - ข้อความ
    
    string
    
    ข้อความรอบเคอร์เซอร์ ข้อความนี้เป็นเพียงชุดย่อยของข้อความทั้งหมดในช่องป้อนข้อมูล