io.github.hapjava.services.Service Maven / Gradle / Ivy
Show all versions of hap Show documentation
package io.github.hapjava.services;
import io.github.hapjava.characteristics.Characteristic;
import java.util.List;
/**
* Interface for a Service offered by an accessory.
*
* @author Andy Lintner
*/
public interface Service {
/**
* Characteristics are the variables offered for reading, updating, and eventing by the Service
* over the HomeKit protocol.
*
* It is important to maintain the order of this list and not change its contents between
* invocations, or a pairing error will result.
*
* @return the list of Characteristics.
*/
List getCharacteristics();
/**
* The type is a UUID that uniquely identifies the type of Service offered. Apple defines several
* types for standard Services, however UUIDs outside this range are allowed for custom Services.
*
* @return A string representation of the UUID, with hexadecimal digits in the format
* ########-####-####-####-############.
*/
String getType();
/**
* List of all the services to which the service links
*
* @return the list of linked services.
*/
List getLinkedServices();
/**
* Add linked services
*
* @param service linked service
*/
void addLinkedService(Service service);
}