diff --git a/docs/classes/CiaoService.html b/docs/classes/CiaoService.html index efd77ac..cbca00a 100644 --- a/docs/classes/CiaoService.html +++ b/docs/classes/CiaoService.html @@ -1,4 +1,4 @@ -CiaoService | @homebridge/ciao - v1.1.5
+CiaoService | @homebridge/ciao - v1.1.6
  • Preparing search index...
    • -
  • The search index is not available
@homebridge/ciao - v1.1.5
+
  • The search index is not available
    • @homebridge/ciao - v1.1.6
    @@ -33,8 +33,8 @@

    Hierarchy

    • CiaoService
    +
  • Defined in CiaoService.ts:203
    • +
  • Defined in CiaoService.ts:276
    • @@ -75,7 +75,7 @@

    advertise

    Returns Promise<void>

    +
  • Defined in CiaoService.ts:412

    • destroy

    +
  • Defined in CiaoService.ts:450

    • end

    +
  • Defined in CiaoService.ts:430

    • getFQDN

    +
  • Defined in CiaoService.ts:460

    • getHostname

    +
  • Defined in CiaoService.ts:481

    • getLowerCasedSubtypePTRs

      @@ -130,7 +130,7 @@

      getLowerCasedSubtypePTRsReturns undefined | string[]

      Array of subtype pointers (undefined if no subtypes are specified).

    +
  • Defined in CiaoService.ts:474

    • getPort

    +
  • Defined in CiaoService.ts:489

    • getTypePTR

    +
  • Defined in CiaoService.ts:467

    • updatePort

    +
  • Defined in CiaoService.ts:588

    • updateTxt

    +
  • Defined in CiaoService.ts:528
    • @@ -219,7 +219,7 @@

    updatePort
  • updateTxt

    • -
    @@ -29,7 +29,7 @@

    Implements

    +
  • Defined in Responder.ts:69
    • @@ -60,7 +60,7 @@
    options: Returns CiaoService

    The newly created CiaoService instance can be used to advertise and manage the created service.

    +
  • Defined in Responder.ts:173

    • getAnnouncedServices

    +
  • Defined in Responder.ts:228

    • shutdown

      @@ -84,7 +84,7 @@

      Returns Promise< (or immediately if any other users have a reference to this Responder instance).

    +
  • Defined in Responder.ts:196
    • @@ -105,7 +105,7 @@

    getAnnouncedServices
  • shutdown

    • -
    @@ -22,7 +22,7 @@

    Enumeration ProtocolConst

    +
  • Defined in index.ts:37
    • @@ -39,12 +39,12 @@

    Enumeration Members

    TCP

    TCP: "tcp"
    +
  • Defined in index.ts:38

    • UDP

    UDP: "udp"
    +
  • Defined in index.ts:39
    • @@ -64,7 +64,7 @@

    TCP
  • UDP

    • -
    @@ -19,7 +19,7 @@

    Enumeration ServiceEventConst

    Events thrown by a CiaoService

    +
  • Defined in CiaoService.ts:159
    • @@ -43,7 +43,7 @@

    HOSTNAME_CHANGED

    +
  • Defined in CiaoService.ts:175

    • NAME_CHANGED

    NAME_CHANGED: "name-change"
    @@ -53,7 +53,7 @@

    NAME_CHANGED

    +
  • Defined in CiaoService.ts:166
    • @@ -73,7 +73,7 @@

    HOSTNAME_CHANGED
  • NAME_CHANGED

    • -
    @@ -21,7 +21,7 @@

    Enumeration ServiceTypeConst

    A service name must not be longer than 15 characters (RFC 6763 7.2).

    +
  • Defined in CiaoService.ts:31
    • @@ -52,82 +52,82 @@

    Enumeration Members

    AIRDROP

    AIRDROP: "airdrop"
    +
  • Defined in CiaoService.ts:33

    • AIRPLAY

    AIRPLAY: "airplay"
    +
  • Defined in CiaoService.ts:34

    • AIRPORT

    AIRPORT: "airport"
    +
  • Defined in CiaoService.ts:35

    • COMPANION_LINK

    COMPANION_LINK: "companion-link"
    +
  • Defined in CiaoService.ts:36

    • DACP

    DACP: "dacp"
    +
  • Defined in CiaoService.ts:37

    • DNS_SD

    DNS_SD: "dns-sd"
    +
  • Defined in CiaoService.ts:47

    • HAP

    HAP: "hap"
    +
  • Defined in CiaoService.ts:38

    • HOMEKIT

    HOMEKIT: "homekit"
    +
  • Defined in CiaoService.ts:39

    • HTTP

    HTTP: "http"
    +
  • Defined in CiaoService.ts:40

    • HTTP_ALT

    HTTP_ALT: "http_alt"
    +
  • Defined in CiaoService.ts:41

    • IPP

    IPP: "ipp"
    +
  • Defined in CiaoService.ts:42

    • IPPS

    IPPS: "ipps"
    +
  • Defined in CiaoService.ts:43

    • PRINTER

    PRINTER: "printer"
    +
  • Defined in CiaoService.ts:48

    • RAOP

    RAOP: "raop"
    +
  • Defined in CiaoService.ts:44

    • TOUCH_ABLE

    TOUCH_ABLE: "touch-able"
    +
  • Defined in CiaoService.ts:46

    • scanner

    scanner: "scanner"
    +
  • Defined in CiaoService.ts:45
    • @@ -161,7 +161,7 @@

    TOUCH_ABLE
  • scanner

    • -
    @@ -33,7 +33,7 @@
    Optional Returns Responder

    A Responder instance for the given options. Might be shared with others using the same options.

    +
  • Defined in index.ts:51
    • @@ -47,7 +47,7 @@

    Member Visibility

    Theme

    -
    -

    @homebridge/ciao - v1.1.5

    +

    @homebridge/ciao - v1.1.6

    @homebridge/ciao

    NPM-Version NPM-Version Beta NPM-Downloads @@ -123,7 +123,7 @@

    MTU
  • Notice on native mDNS responders

    • -
    @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in MDNSServer.ts:132
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in MDNSServer.ts:146

    • Optional interface

    interface?: string | string[]
    @@ -55,7 +55,7 @@

    Optional

    +
  • Defined in MDNSServer.ts:140
    • @@ -75,7 +75,7 @@

    disableIpv6
  • interface

    • -
    @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in CiaoService.ts:54
    • @@ -52,7 +52,7 @@

    OptionalrestrictedAddresses.

    +
  • Defined in CiaoService.ts:115

    • Optional domain

    domain?: string
    @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in CiaoService.ts:93

    • Optional hostname

    hostname?: string
    @@ -69,14 +69,14 @@

    Optional

    +
  • Defined in CiaoService.ts:83

    • name

    name: string

    Instance name of the service

    +
  • Defined in CiaoService.ts:58

    • Optional port

    port?: number
    @@ -84,14 +84,14 @@

    Optional

    +
  • Defined in CiaoService.ts:72

    • Optional protocol

    protocol?: Protocol

    The protocol the service uses. Default is TCP.

    +
  • Defined in CiaoService.ts:77

    • Optional restrictedAddresses

    restrictedAddresses?: string[]
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in CiaoService.ts:109

    • Optional subtypes

    subtypes?: string[]
    @@ -114,21 +114,21 @@

    OptionalServiceType for some known examples.

    +
  • Defined in CiaoService.ts:67

    • Optional txt

    txt?: ServiceTxt

    If defined, a txt record will be published with the given service.

    +
  • Defined in CiaoService.ts:87

    • type

    type: string

    Type of the service.

    +
  • Defined in CiaoService.ts:62
    • @@ -156,7 +156,7 @@

    txt
  • type

    • -
    -

    @homebridge/ciao - v1.1.5

    +

    @homebridge/ciao - v1.1.6

    Index

    @@ -57,7 +57,7 @@

    Member Visibility

    Theme

    -
    @@ -17,7 +17,7 @@

    Type alias ResponderOptions

    ResponderOptions: {} & MDNSServerOptions
    +
  • Defined in Responder.ts:52
    • @@ -31,7 +31,7 @@

    Member Visibility

    Theme

    -
    @@ -20,7 +20,7 @@

    Type alias ServiceTxt

    which get advertised on the network.

    +
  • Defined in CiaoService.ts:123
    • @@ -34,7 +34,7 @@

    Member Visibility

    Theme

    -
    @@ -40,7 +40,7 @@
    Optional Returns Responder

    A Responder instance for the given options. Might be shared with others using the same options.

    +
  • Defined in index.ts:55
    • @@ -54,7 +54,7 @@

    Member Visibility

    Theme

    -