CDPotion.Domain.ServiceWorker (cdpotion v0.1.4)

Summary

Types

description not provided :(

ServiceWorker error message.

ServiceWorker registration.

ServiceWorker version.

description not provided :(

description not provided :(

Functions

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) data: description not provided :(

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) tag: description not provided :(

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) tag: description not provided :(
  • (Required) last_chance: description not provided :(

Parameters:

  • (Required) version_id: description not provided :(

Parameters:

  • (Required) force_update_on_page_load: description not provided :(

Parameters:

  • (Required) scope_url: description not provided :(

Parameters:

  • (Required) scope_url: description not provided :(

Parameters:

  • (Required) version_id: description not provided :(

Parameters:

  • (Required) scope_url: description not provided :(

Parameters:

  • (Required) scope_url: description not provided :(

Types

Link to this type

registration_id()

@type registration_id() :: String.t()

description not provided :(

Link to this type

service_worker_error_message()

@type service_worker_error_message() :: %{
  columnNumber: integer(),
  errorMessage: String.t(),
  lineNumber: integer(),
  registrationId: registration_id(),
  sourceURL: String.t(),
  versionId: String.t()
}

ServiceWorker error message.

Link to this type

service_worker_registration()

@type service_worker_registration() :: %{
  isDeleted: boolean(),
  registrationId: registration_id(),
  scopeURL: String.t()
}

ServiceWorker registration.

Link to this type

service_worker_version()

@type service_worker_version() :: %{
  controlledClients: [CDPotion.Domain.Target.target_id()] | nil,
  registrationId: registration_id(),
  runningStatus: service_worker_version_running_status(),
  scriptLastModified: number() | nil,
  scriptResponseTime: number() | nil,
  scriptURL: String.t(),
  status: service_worker_version_status(),
  targetId: CDPotion.Domain.Target.target_id() | nil,
  versionId: String.t()
}

ServiceWorker version.

Link to this type

service_worker_version_running_status()

@type service_worker_version_running_status() ::
  :stopped | :starting | :running | :stopping

description not provided :(

Link to this type

service_worker_version_status()

@type service_worker_version_status() ::
  :new | :installing | :installed | :activating | :activated | :redundant

description not provided :(

Functions

Link to this function

deliver_push_message(origin, registration_id, data)

@spec deliver_push_message(
  String.t(),
  registration_id(),
  String.t()
) :: {String.t(), map()}

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) data: description not provided :(
@spec disable() :: {String.t(), map()}
Link to this function

dispatch_periodic_sync_event(origin, registration_id, tag)

@spec dispatch_periodic_sync_event(
  String.t(),
  registration_id(),
  String.t()
) :: {String.t(), map()}

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) tag: description not provided :(
Link to this function

dispatch_sync_event(origin, registration_id, tag, last_chance)

@spec dispatch_sync_event(
  String.t(),
  registration_id(),
  String.t(),
  boolean()
) :: {String.t(), map()}

Parameters:

  • (Required) origin: description not provided :(
  • (Required) registration_id: description not provided :(
  • (Required) tag: description not provided :(
  • (Required) last_chance: description not provided :(
@spec enable() :: {String.t(), map()}
Link to this function

inspect_worker(version_id)

@spec inspect_worker(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) version_id: description not provided :(
Link to this function

set_force_update_on_page_load(force_update_on_page_load)

@spec set_force_update_on_page_load(boolean()) :: {String.t(), map()}

Parameters:

  • (Required) force_update_on_page_load: description not provided :(
Link to this function

skip_waiting(scope_url)

@spec skip_waiting(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) scope_url: description not provided :(
Link to this function

start_worker(scope_url)

@spec start_worker(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) scope_url: description not provided :(
Link to this function

stop_all_workers()

@spec stop_all_workers() :: {String.t(), map()}
Link to this function

stop_worker(version_id)

@spec stop_worker(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) version_id: description not provided :(
Link to this function

unregister(scope_url)

@spec unregister(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) scope_url: description not provided :(
Link to this function

update_registration(scope_url)

@spec update_registration(String.t()) :: {String.t(), map()}

Parameters:

  • (Required) scope_url: description not provided :(