Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 5.87 KB

hs.wifi.watcher.md

File metadata and controls

63 lines (51 loc) · 5.87 KB
Raw

docs » hs.wifi.watcher

Watch for changes to the associated wifi network

API Overview

  • Constants - Useful values which cannot be changed
  • eventTypes
  • Constructors - API calls which return an object, typically one that offers API methods
  • new
  • Methods - API calls which can only be made on an object returned by a constructor
  • start
  • stop
  • watchingFor

API Documentation

Constants

eventTypes

Signature hs.wifi.watcher.eventTypes[]
Type Constant
Description A table containing the possible event types that this watcher can monitor for.

Constructors

new

Signature hs.wifi.watcher.new(fn) -> watcher
Type Constructor
Description Creates a new watcher for WiFi network events
Parameters
  • fn - A function that will be called when a WiFi event that is being monitored occurs. The function should expect 2 or 4 arguments as described in the notes below.
Returns
  • A hs.wifi.watcher object
Notes
  • For backwards compatibility, only "SSIDChange" is watched for by default, so existing code can continue to ignore the callback function arguments unless you add or change events with the hs.wifi.watcher:watchingFor.

Methods

start

Signature hs.wifi.watcher:start() -> watcher
Type Method
Description Starts the SSID watcher
Parameters
  • None
Returns
  • The hs.wifi.watcher object

stop

Signature hs.wifi.watcher:stop() -> watcher
Type Method
Description Stops the SSID watcher
Parameters
  • None
Returns
  • The hs.wifi.watcher object

watchingFor

| Signature | hs.wifi.watcher:watchingFor([messages]) -> watcher | current-value | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Get or set the specific types of wifi events to generate a callback for with this watcher. | | Parameters |

  • messages - an optional table of or list of strings specifying the types of events this watcher should invoke a callback for. You can specify multiple types of events to watch for. Defaults to { "SSIDChange" }.
| | Returns |
  • if a value is provided, returns the watcher object; otherwise returns the current values as a table of strings.
| | Notes |
  • the possible values for this method are described in hs.wifi.watcher.eventTypes.
  • the special string "all" specifies that all event types should be watched for.
|