Trait/Object

org.scalajs.dom

ServiceWorkerGlobalScope

Related Docs: object ServiceWorkerGlobalScope | package dom

Permalink

trait ServiceWorkerGlobalScope extends EventTarget with WorkerGlobalScope

The ServiceWorkerGlobalScope interface of the ServiceWorker API represents the global execution context of a service worker.

Developers should keep in mind that the ServiceWorker.state is not persisted across the termination/restart cycle, so each event handler should assume it's being invoked with a bare, default global state.

Once successfully registered, a service worker can and will be terminated when idle to conserve memory and processor power. An active service worker is automatically restarted to respond to events, such as ServiceWorkerGlobalScope.onfetch or ServiceWorkerGlobalScope.onmessage.

Additionally, synchronous requests are not allowed from within a service worker — only asynchronous requests, like those initiated via the fetch() method, can be used.

Annotations
@JSType() @native()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServiceWorkerGlobalScope
  2. WorkerGlobalScope
  3. WindowOrWorkerGlobalScope
  4. WindowTimers
  5. WindowBase64
  6. EventTarget
  7. Object
  8. Any
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addEventListener[T <: Event](type: String, listener: Function1[T, _], options: EventListenerOptions): Unit

    Permalink

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

    This implementation accepts a settings object of type EventListenerOptions.

    Definition Classes
    EventTarget
  5. def addEventListener[T <: Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit

    Permalink

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

    Definition Classes
    EventTarget
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def atob(encodedString: String): String

    Permalink

    Decodes a string of data which has been encoded using base-64 encoding.

    Decodes a string of data which has been encoded using base-64 encoding.

    Definition Classes
    WindowBase64
  8. def btoa(rawString: String): String

    Permalink

    Creates a base-64 encoded ASCII string from a "string" of binary data.

    Creates a base-64 encoded ASCII string from a "string" of binary data.

    Definition Classes
    WindowBase64
  9. def caches: UndefOr[CacheStorage]

    Permalink

    Returns the CacheStorage object associated with the current context.

    Returns the CacheStorage object associated with the current context. This object enables functionality such as storing assets for offline use, and generating custom responses to requests.

    Definition Classes
    WindowOrWorkerGlobalScope
  10. def clearInterval(handle: Int): Unit

    Permalink

    Cancels repeated action which was set up using setInterval.

    Cancels repeated action which was set up using setInterval.

    Definition Classes
    WindowTimers
  11. def clearTimeout(handle: Int): Unit

    Permalink

    Clears the delay set by window.setTimeout().

    Clears the delay set by window.setTimeout().

    Definition Classes
    WindowTimers
  12. def clients: Clients

    Permalink

    Returns the Clients object associated with the service worker.

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def close(): Unit

    Permalink

    The close() method of the WorkerGlobalScope interface discards any tasks queued in the WorkerGlobalScope's event loop, effectively closing this particular scope.

    The close() method of the WorkerGlobalScope interface discards any tasks queued in the WorkerGlobalScope's event loop, effectively closing this particular scope.

    Definition Classes
    WorkerGlobalScope
  15. def createImageBitmap(image: CreateImageBitmapInput, sx: Double, sy: Double, sw: Double, sh: Double, options: CreateImageBitmapOptions): Promise[ImageBitmap]

    Permalink
    Definition Classes
    WindowOrWorkerGlobalScope
  16. def createImageBitmap(image: CreateImageBitmapInput, sx: Double, sy: Double, sw: Double, sh: Double): Promise[ImageBitmap]

    Permalink
    Definition Classes
    WindowOrWorkerGlobalScope
  17. def createImageBitmap(image: CreateImageBitmapInput, options: CreateImageBitmapOptions): Promise[ImageBitmap]

    Permalink
    Definition Classes
    WindowOrWorkerGlobalScope
  18. def createImageBitmap(image: CreateImageBitmapInput): Promise[ImageBitmap]

    Permalink

    Accepts a variety of different image sources, and returns a Promise which resolves to an ImageBitmap.

    Accepts a variety of different image sources, and returns a Promise which resolves to an ImageBitmap. Optionally the source is cropped to the rectangle of pixels originating at (sx, sy) with width sw, and height sh.

    Definition Classes
    WindowOrWorkerGlobalScope
  19. def crossOriginIsolated: Boolean

    Permalink

    Returns a boolean value that indicates whether a SharedArrayBuffer can be sent via a Window.postMessage() call.

    Returns a boolean value that indicates whether a SharedArrayBuffer can be sent via a Window.postMessage() call.

    Definition Classes
    WindowOrWorkerGlobalScope
  20. def dispatchEvent(evt: Event): Boolean

    Permalink

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order.

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

    Definition Classes
    EventTarget
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def fetch(info: RequestInfo, init: RequestInit = js.native): Promise[Response]

    Permalink

    Starts the process of fetching a resource from the network.

    Starts the process of fetching a resource from the network.

    Definition Classes
    WindowOrWorkerGlobalScope
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  28. def importScripts(urls: Array[String]): Unit

    Permalink

    The importScripts() method of the WorkerGlobalScope interface imports one or more scripts into the worker's scope.

    The importScripts() method of the WorkerGlobalScope interface imports one or more scripts into the worker's scope.

    Definition Classes
    WorkerGlobalScope
  29. def indexedDB: UndefOr[IDBFactory]

    Permalink

    Provides a mechanism for applications to asynchronously access capabilities of indexed databases.

    Provides a mechanism for applications to asynchronously access capabilities of indexed databases.

    Definition Classes
    WindowOrWorkerGlobalScope
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  32. def isSecureContext: Boolean

    Permalink

    Returns a boolean indicating whether the current context is secure or not.

    Returns a boolean indicating whether the current context is secure or not.

    Definition Classes
    WindowOrWorkerGlobalScope
  33. def location: WorkerLocation

    Permalink

    The location read-only property of the WorkerGlobalScope interface returns the WorkerLocation associated with the worker.

    The location read-only property of the WorkerGlobalScope interface returns the WorkerLocation associated with the worker. It is a specific location object, mostly a subset of the Location for browsing scopes, but adapted to workers.

    Definition Classes
    WorkerGlobalScope
  34. def navigator: WorkerNavigator

    Permalink

    The navigator read-only property of the WorkerGlobalScope interface returns the WorkerNavigator associated with the worker.

    The navigator read-only property of the WorkerGlobalScope interface returns the WorkerNavigator associated with the worker. It is a specific navigator object, mostly a subset of the Navigator for browsing scopes, but adapted to workers.

    Definition Classes
    WorkerGlobalScope
  35. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  36. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. var onError: Function1[ErrorEvent, _]

    Permalink

    The onerror property of the WorkerGlobalScope interface represents an EventHandler to be called when the error event occurs and bubbles through the Worker.

    The onerror property of the WorkerGlobalScope interface represents an EventHandler to be called when the error event occurs and bubbles through the Worker.

    Definition Classes
    WorkerGlobalScope
  39. var onactivate: Function1[ExtendableEvent, _]

    Permalink

    An event handler fired whenever an activate event occurs (when the service worker activates).

    An event handler fired whenever an activate event occurs (when the service worker activates). This happens after installation, when the page to be controlled by the service worker refreshes.

  40. var onfetch: Function1[FetchEvent, _]

    Permalink

    An event handler fired whenever a fetch event occurs — when a fetch() is called.

  41. var oninstall: Function1[ExtendableEvent, _]

    Permalink

    An event handler fired whenever an install event occurs — when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.

  42. var onlanguagechange: Function1[Event, _]

    Permalink

    The onlanguagechange property of the WorkerGlobalScope interface represents an EventHandler to be called when the languagechange event occurs and bubbles through the Worker.

    The onlanguagechange property of the WorkerGlobalScope interface represents an EventHandler to be called when the languagechange event occurs and bubbles through the Worker.

    Definition Classes
    WorkerGlobalScope
  43. var onmessage: Function1[MessageEvent, _]

    Permalink

    An event handler fired whenever a message event occurs — when incoming messages are received.

    An event handler fired whenever a message event occurs — when incoming messages are received. Controlled pages can use the MessagePort.postMessage method to send messages to service workers. The service worker can optionally send a response back via the MessagePort exposed in event.data.port, corresponding to the controlled page.

  44. var onoffline: Function1[Event, _]

    Permalink

    The onoffline property of the WorkerGlobalScope interface represents an EventHandler to be called when the offline event occurs and bubbles through the Worker.

    The onoffline property of the WorkerGlobalScope interface represents an EventHandler to be called when the offline event occurs and bubbles through the Worker.

    Definition Classes
    WorkerGlobalScope
  45. var ononline: Function1[Event, _]

    Permalink

    The ononline property of the WorkerGlobalScope interface represents an EventHandler to be called when the online event occurs and bubbles through the Worker.

    The ononline property of the WorkerGlobalScope interface represents an EventHandler to be called when the online event occurs and bubbles through the Worker.

    Definition Classes
    WorkerGlobalScope
  46. var onpush: Function1[PushEvent, _]

    Permalink

    The ServiceWorkerGlobalScope.onpush event of the ServiceWorkerGlobalScope interface is fired whenever a push message is received by a service worker via a push server.

  47. var onpushsubscriptionchange: Function1[PushEvent, _]

    Permalink

    The ServiceWorkerGlobalScope.onpushsubscriptionchange event of the ServiceWorkerGlobalScope interface is fired whenever a push subscription has been invalidated (or is about to become so).

    The ServiceWorkerGlobalScope.onpushsubscriptionchange event of the ServiceWorkerGlobalScope interface is fired whenever a push subscription has been invalidated (or is about to become so). This offers an opportunity to resubscribe in order to continue receiving push messages, if desired. This might happen if, for example, the push service sets an expiration time a subscription.

  48. def origin: String

    Permalink

    Returns the origin of the global scope, serialized as a string.

    Returns the origin of the global scope, serialized as a string.

    Definition Classes
    WindowOrWorkerGlobalScope
  49. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  50. def queueMicrotask(function: Function0[Any]): Unit

    Permalink

    Enqueues a microtask—a short function to be executed after execution of the JavaScript code completes and control isn't being returned to a JavaScript caller, but before handling callbacks and other tasks.

    Enqueues a microtask—a short function to be executed after execution of the JavaScript code completes and control isn't being returned to a JavaScript caller, but before handling callbacks and other tasks.

    This lets your code run without interfering with other, possibly higher priority, code, but before the browser runtime regains control, potentially depending upon the work you need to complete.

    Definition Classes
    WindowOrWorkerGlobalScope
  51. def registration: ServiceWorkerRegistration

    Permalink

    The registration read-only property of the ServiceWorkerGlobalScope interface returns a reference to the ServiceWorkerRegistration object, which represents the service worker's registration.

  52. def removeEventListener[T <: Event](type: String, listener: Function1[T, _], options: EventListenerOptions): Unit

    Permalink

    Removes the event listener previously registered with EventTarget.addEventListener.

    Removes the event listener previously registered with EventTarget.addEventListener.

    This implementation accepts a settings object of type EventListenerOptions.

    Definition Classes
    EventTarget
  53. def removeEventListener[T <: Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit

    Permalink

    Removes the event listener previously registered with EventTarget.addEventListener.

    Removes the event listener previously registered with EventTarget.addEventListener.

    Definition Classes
    EventTarget
  54. def self: ServiceWorkerGlobalScope.this.type

    Permalink

    The self read-only property of the WorkerGlobalScope interface returns a reference to the WorkerGlobalScope itself.

    The self read-only property of the WorkerGlobalScope interface returns a reference to the WorkerGlobalScope itself. Most of the time it is a specific scope like DedicatedWorkerGlobalScope, SharedWorkerGlobalScope, or ServiceWorkerGlobalScope.

    Definition Classes
    WorkerGlobalScope
  55. def setInterval(handler: Function0[Any], timeout: Double): Int

    Permalink

    Calls a function or executes a code snippet repeatedly, with a fixed time delay between each call to that function.

    Calls a function or executes a code snippet repeatedly, with a fixed time delay between each call to that function.

    Definition Classes
    WindowTimers
  56. def setTimeout(handler: Function0[Any], timeout: Double): Int

    Permalink

    Calls a function or executes a code snippet after a specified delay.

    Calls a function or executes a code snippet after a specified delay.

    Definition Classes
    WindowTimers
  57. def skipWaiting(): Promise[Unit]

    Permalink

    Forces the waiting service worker to become the active service worker.

    Forces the waiting service worker to become the active service worker. This method can be used with Clients.claim to ensure that updates to the underlying service worker take effect immediately for both the current client and all other active clients.

  58. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  59. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  60. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  61. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  62. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from WorkerGlobalScope

Inherited from WindowOrWorkerGlobalScope

Inherited from WindowTimers

Inherited from WindowBase64

Inherited from EventTarget

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped