Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Reference.md

This commit is contained in:
HomeSpan 2022-04-10 09:13:49 -05:00 committed by GitHub
parent c2a43eca55
commit 02184fe005
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Reference.md
View File

@ -190,12 +190,14 @@ This is a **base class** from which all HomeSpan Services are derived, and shoul
The following methods are supported: The following methods are supported:
* `SpanService *setPrimary()` * `SpanService *setPrimary()`
* specifies that this is the primary Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation. * specifies that this is the primary Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation
* example: `(new Service::Fan)->setPrimary();` * example: `(new Service::Fan)->setPrimary();`
* note though this functionality is defined by Apple in HAP-R2, it seems to have been deprecated and no longer serves any purpose or has any affect on the Home App
* `SpanService *setHidden()` * `SpanService *setHidden()`
* specifies that this is hidden Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation. * specifies that this is hidden Service for the Accessory. Returns a pointer to the Service itself so that the method can be chained during instantiation.
* note this does not seem to have any affect on the Home App. Services marked as hidden still appear as normal * example: `(new Service::Fan)->setHidden();`
* note though this functionality is defined by Apple in HAP-R2, it seems to have been deprecated and no longer serves any purpose or has any affect on the Home App
* `SpanService *addLink(SpanService *svc)` * `SpanService *addLink(SpanService *svc)`
* adds *svc* as a Linked Service. Returns a pointer to the calling Service itself so that the method can be chained during instantiation. * adds *svc* as a Linked Service. Returns a pointer to the calling Service itself so that the method can be chained during instantiation.