chrome.syncFileSystem

คำอธิบาย

ใช้ chrome.syncFileSystem API เพื่อบันทึกและซิงค์ข้อมูลใน Google ไดรฟ์ API นี้ไม่ได้มีไว้สําหรับการเข้าถึงเอกสารของผู้ใช้ที่เก็บไว้ใน Google ไดรฟ์ มอบพื้นที่เก็บข้อมูลที่ซิงค์ได้สำหรับแต่ละแอปโดยเฉพาะสำหรับการใช้งานแบบออฟไลน์และการแคช เพื่อให้ข้อมูลเดียวกันนั้นพร้อมใช้งานบนไคลเอ็นต์ที่ต่างกัน อ่านจัดการข้อมูลเพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ API นี้

สิทธิ์

syncFileSystem

ประเภท

ConflictResolutionPolicy

ค่าแจกแจง

"last_write_win"

"manual"

FileInfo

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

  • การดำเนินการ

    SyncAction ไม่บังคับ

    การดำเนินการซิงค์ที่ดำเนินการเพื่อเรียกเหตุการณ์ onFileStatusChanged ค่าการดำเนินการอาจเป็น 'added', 'updated' หรือ 'deleted' มีผลก็ต่อเมื่อสถานะเป็น 'synced'

  • direction

    SyncDirection ไม่บังคับ

    ทิศทางการซิงค์สําหรับเหตุการณ์ onFileStatusChanged ค่าทิศทางการซิงค์อาจเป็น 'local_to_remote' หรือ 'remote_to_local' ใช้เมื่อสถานะเป็น 'synced' เท่านั้น

  • fileEntry

    รายการ

    fileEntryสำหรับไฟล์เป้าหมายที่สถานะมีการเปลี่ยนแปลง มีข้อมูลชื่อและเส้นทางของไฟล์ที่ซิงค์ เมื่อลบไฟล์ ข้อมูล fileEntry จะยังคงอยู่ แต่ไฟล์จะไม่มีอยู่อีกต่อไป

  • สถานะ

    FileStatus

    สถานะไฟล์ที่เกิดขึ้นหลังจากเหตุการณ์ onFileStatusChanged ค่าสถานะอาจเป็น 'synced', 'pending' หรือ 'conflicting'

FileStatus

ค่าแจกแจง

"ซิงค์แล้ว"
ไม่ขัดแย้งกันและไม่มีการเปลี่ยนแปลงภายในเครื่องที่รอดำเนินการ

"pending"
มีการเปลี่ยนแปลงในเครื่องที่รอดำเนินการอย่างน้อย 1 รายการที่ยังไม่ได้ซิงค์

"conflicting"
ไฟล์ขัดแย้งกับเวอร์ชันระยะไกลและต้องแก้ไขด้วยตนเอง

FileStatusInfo

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

  • ข้อผิดพลาด

    string ไม่บังคับ

    ข้อผิดพลาดที่ไม่บังคับซึ่งจะแสดงก็ต่อเมื่อมีปัญหาในการเรียก FileStatus สำหรับไฟล์ที่ระบุ

  • fileEntry

    รายการ

    รายการใดรายการหนึ่งที่ให้ไว้กับ getFileStatuses เดิม

  • สถานะ

    FileStatus

    ค่าสถานะอาจเป็น 'synced', 'pending' หรือ 'conflicting'

ServiceInfo

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

  • คำอธิบาย

    สตริง

  • รัฐ

    ServiceStatus

ServiceStatus

ค่าแจกแจง

"initializing"
บริการซิงค์กำลังเริ่มต้น (เช่น การกู้คืนข้อมูลจากฐานข้อมูล ตรวจสอบการเชื่อมต่อและการตรวจสอบสิทธิ์กับบริการ เป็นต้น)

"กำลังทำงาน"
บริการการซิงค์เริ่มทำงานแล้ว

"authentication_required"
บริการซิงค์ไม่ได้ซิงค์ไฟล์เนื่องจากผู้ใช้ต้องตรวจสอบสิทธิ์บริการระยะไกลเพื่อดำเนินการต่อ

"temporary_unavailable"
บริการซิงค์ไม่ซิงค์ข้อมูลไฟล์เนื่องจากบริการระยะไกลไม่พร้อมใช้งาน (ชั่วคราว) เนื่องจากมีข้อผิดพลาดที่กู้คืนได้ เช่น เครือข่ายออฟไลน์อยู่ บริการระยะไกลใช้งานไม่ได้หรือเข้าถึงไม่ได้ ฯลฯ คุณควรระบุรายละเอียดเพิ่มเติมตามพารามิเตอร์ description ใน OnServiceInfoUpdated (ซึ่งอาจมีรายละเอียดเฉพาะบริการ)

"disable"
บริการซิงค์ถูกปิดใช้งานและเนื้อหาจะไม่มีการซิงค์ (เช่น กรณีนี้อาจเกิดขึ้นเมื่อผู้ใช้ไม่มีบัญชีในบริการระยะไกลหรือบริการซิงค์มีข้อผิดพลาดที่กู้คืนไม่ได้)

StorageInfo

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

  • quotaBytes

    ตัวเลข

  • usageBytes

    ตัวเลข

SyncAction

ค่าแจกแจง

"updated"

SyncDirection

ค่าแจกแจง

เมธอด

getConflictResolutionPolicy()

สัญญา 
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
)

รับนโยบายการแก้ปัญหาความขัดแย้งปัจจุบัน

พารามิเตอร์

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

  • Chrome 117 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getFileStatus()

สัญญา 
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
)

แสดงผล FileStatus สำหรับ fileEntry ที่ระบุ ค่าสถานะอาจเป็น 'synced', 'pending' หรือ 'conflicting' โปรดทราบว่าสถานะ 'conflicting' จะเกิดขึ้นก็ต่อเมื่อตั้งค่านโยบายการแก้ไขข้อขัดแย้งของบริการเป็น 'manual' เท่านั้น

พารามิเตอร์

  • fileEntry

    รายการ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (status: FileStatus) => void

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

  • Promise<FileStatus>

    Chrome 117 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getFileStatuses()

สัญญา 
chrome.syncFileSystem.getFileStatuses(
  fileEntries: object[],
  callback?: function,
)

แสดงผล FileStatus แต่ละรายการสำหรับอาร์เรย์ fileEntry ที่ระบุ โดยปกติจะเรียกใช้พร้อมกับผลลัพธ์จาก dirReader.readEntries()

พารามิเตอร์

  • fileEntries

    วัตถุ[]

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (status: FileStatusInfo[]) => void

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

  • Promise&lt;FileStatusInfo[]&gt;

    Chrome 117 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getServiceStatus()

สัญญา 
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
)

แสดงสถานะแบ็กเอนด์การซิงค์ปัจจุบัน

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (status: ServiceStatus) => void

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

  • Promise<ServiceStatus>

    Chrome 117 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getUsageAndQuota()

สัญญา 
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
)

แสดงผลการใช้งานปัจจุบันและโควต้าเป็นไบต์สําหรับพื้นที่เก็บข้อมูลไฟล์ 'syncable' ของแอป

พารามิเตอร์

  • fileSystem

    DOMFileSystem

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (info: StorageInfo) => void

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

  • Promise<StorageInfo>

    Chrome 117 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

requestFileSystem()

สัญญา 
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
)

แสดงผลระบบไฟล์ที่ซิงค์ได้ซึ่งสำรองข้อมูลโดย Google ไดรฟ์ อินสแตนซ์ DOMFileSystem ที่แสดงผลนั้นสามารถทำงานได้ในลักษณะเดียวกับระบบไฟล์ชั่วคราวและถาวร (โปรดดู http://dev.w3.org/2009/dap/file-system/file-dir-sys.html)

การเรียกคำสั่งนี้หลายครั้งจากแอปเดียวกันจะเป็นการคืนแฮนเดิลเดียวกันลงในระบบไฟล์เดียวกัน

โปรดทราบว่าการเรียกใช้นี้อาจไม่สำเร็จ เช่น ในกรณีที่ผู้ใช้ไม่ได้ลงชื่อเข้าใช้ Chrome หรือไม่มีการดำเนินการทางเครือข่าย ในการจัดการข้อผิดพลาดเหล่านี้ สิ่งสำคัญคือต้องตรวจสอบ chrome.runtime.lastError ใน Callback

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

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

  • สัญญา <DOMFileSystem>

    Chrome 117 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

setConflictResolutionPolicy()

สัญญา 
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
)

ตั้งค่านโยบายการแก้ไขข้อขัดแย้งเริ่มต้นสำหรับพื้นที่เก็บข้อมูลไฟล์ 'syncable' ของแอป โดยค่าเริ่มต้นระบบจะตั้งค่าเป็น 'last_write_win' เมื่อตั้งค่านโยบายการแก้ไขความขัดแย้งเป็น 'last_write_win' สำหรับความขัดแย้งของไฟล์ที่มีอยู่จะได้รับการแก้ไขโดยอัตโนมัติในครั้งต่อไปที่ไฟล์ได้รับการอัปเดต คุณเลือกให้ callback ได้เพื่อดูว่าคำขอประสบความสำเร็จหรือไม่

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

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

  • คำมั่นสัญญา<โมฆะ>

    Chrome 117 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onFileStatusChanged

chrome.syncFileSystem.onFileStatusChanged.addListener(
  callback: function,
)

เรียกใช้เมื่อบริการซิงค์ในเบื้องหลังอัปเดตไฟล์

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (detail: FileInfo) => void

    • รายละเอียด

      FileInfo

onServiceStatusChanged

chrome.syncFileSystem.onServiceStatusChanged.addListener(
  callback: function,
)

เรียกใช้เมื่อมีข้อผิดพลาดหรือการเปลี่ยนแปลงสถานะอื่นๆ ในแบ็กเอนด์การซิงค์ (เช่น เมื่อการซิงค์ถูกปิดใช้ชั่วคราวเนื่องจากข้อผิดพลาดเกี่ยวกับเครือข่ายหรือการตรวจสอบสิทธิ์)

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (detail: ServiceInfo) => void