Skip to content

PeriodicSyncEvent.md

Latest commit

 

History

History
41 lines (30 loc) · 1.71 KB

PeriodicSyncEvent.md

File metadata and controls

41 lines (30 loc) · 1.71 KB
Raw

PeriodicSyncEvent

Namespace: SpawnDev.SpawnJS.JSObjects
Inherits: ExtendableEvent
Source: JSObjects/PeriodicSyncEvent.cs
MDN Reference: PeriodicSyncEvent on MDN

The PeriodicSyncEvent interface of the Web Periodic Background Synchronization API provides a way to run tasks in the service worker with network connectivity. https://developer.mozilla.org/en-US/docs/Web/API/PeriodicSyncEvent

Constructors

Signature Description
PeriodicSyncEvent(SpawnJSObjectReference _ref) Deserialization constructor

Properties

Property Type Access Description
Tag string get Returns the developer-defined identifier for this PeriodicSyncEvent. Multiple tags can be used by the web app to run different periodic tasks at different frequencies.

Examples

SpawnDev.SpawnJS Mapping Note: The JavaScript examples below show the standard Web API usage. In SpawnDev.SpawnJS, the same API is available with C# conventions:

  • Properties and methods use PascalCase (e.g., readyState becomes ReadyState)
  • Events use ActionEvent with +=/-= (e.g., addEventListener("click", fn) becomes OnClick += handler)
  • Async methods return Task<T> instead of Promise<T>
  • Objects should be disposed with using statements
  • Access via JS.Get<PeriodicSyncEvent>(...) or constructor new PeriodicSyncEvent(...)
self.addEventListener("periodicsync", (event) => {
  if (event.tag === "get-latest-news") {
    event.waitUntil(fetchAndCacheLatestNews());
  }
});

See full example on MDN