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

ค่าแจกแจง

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

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

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

FileStatusInfo

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

  • ข้อผิดพลาด

    สตริง ไม่บังคับ

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

  • fileEntry

    รายการ

    รายการใดรายการหนึ่งที่ระบุไว้แต่เดิมเพื่อรับ getFileStatuses

  • สถานะ

    FileStatus

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

ServiceInfo

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

  • คำอธิบาย

    สตริง

  • รัฐ

    ServiceStatus

ServiceStatus

ค่าแจกแจง

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

"กำลังทำงาน"
บริการซิงค์พร้อมใช้งาน

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

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

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

StorageInfo

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

  • quotaBytes

    ตัวเลข

  • usageBytes

    ตัวเลข

SyncAction

ค่าแจกแจง

"added"

"updated"

"deleted"

SyncDirection

ค่าแจกแจง

"local_to_remote"

"remote_to_local"

เมธอด

getConflictResolutionPolicy()

Promise 
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
): Promise<ConflictResolutionPolicy>

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

พารามิเตอร์

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

  • Chrome 117 ขึ้นไป

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

getFileStatus()

Promise 
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
): Promise<FileStatus>

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

พารามิเตอร์

  • fileEntry

    รายการ

  • callback

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

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

    (status: FileStatus) => void

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

  • Promise<FileStatus>

    Chrome 117 ขึ้นไป

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

getFileStatuses()

Promise 
chrome.syncFileSystem.getFileStatuses(
  fileEntries: object[],
  callback?: function,
): Promise<FileStatusInfo[]>

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

พารามิเตอร์

  • fileEntries

    object[]

  • callback

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

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

    (status: FileStatusInfo[]) => void

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

  • Promise<FileStatusInfo[]>

    Chrome 117 ขึ้นไป

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

getServiceStatus()

Promise 
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
): Promise<ServiceStatus>

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

พารามิเตอร์

  • callback

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

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

    (status: ServiceStatus) => void

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

  • Promise<ServiceStatus>

    Chrome 117 ขึ้นไป

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

getUsageAndQuota()

Promise 
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
): Promise<StorageInfo>

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

พารามิเตอร์

  • fileSystem

    DOMFileSystem

  • callback

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

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

    (info: StorageInfo) => void

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

  • Promise<StorageInfo>

    Chrome 117 ขึ้นไป

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

requestFileSystem()

Promise 
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
): Promise<DOMFileSystem>

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

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

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

พารามิเตอร์

  • callback

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

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

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

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

  • Promise<DOMFileSystem>

    Chrome 117 ขึ้นไป

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

setConflictResolutionPolicy()

Promise 
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
): Promise<void>

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

พารามิเตอร์

  • callback

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

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

    () => void

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

  • Promise<void>

    Chrome 117 ขึ้นไป

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

กิจกรรม

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