Package io.github.hapjava.services.impl

Class LockMechanismService

java.lang.Object

io.github.hapjava.services.impl.LockMechanismService

All Implemented Interfaces:

Service

public class LockMechanismService
extends java.lang.Object

The Lock Mechanism Service describes the physical lock mechanism on a device.

Constructor Summary

Constructors

Constructor	Description
LockMechanismService(LockMechanismAccessory accessory)
LockMechanismService(LockCurrentStateCharacteristic lockCurrentState, LockTargetStateCharacteristic lockTargetState)

Method Summary

Modifier and Type	Method	Description
void	addCharacteristic(Characteristic characteristic)
void	addLinkedService(Service service)	Add linked services
void	addOptionalCharacteristic(NameCharacteristic name)
java.util.List<Characteristic>	getCharacteristics()	Characteristics are the variables offered for reading, updating, and eventing by the Service over the HomeKit protocol.
java.util.List<Service>	getLinkedServices()	List of all the services to which the service links
java.lang.String	getType()	The type is a UUID that uniquely identifies the type of Service offered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockMechanismService

public LockMechanismService(LockCurrentStateCharacteristic lockCurrentState,
                            LockTargetStateCharacteristic lockTargetState)

LockMechanismService

public LockMechanismService(LockMechanismAccessory accessory)

Method Detail

addOptionalCharacteristic

public void addOptionalCharacteristic(NameCharacteristic name)

getCharacteristics

public java.util.List<Characteristic> getCharacteristics()

Description copied from 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.

Specified by:

getCharacteristics in interface Service

Returns:

the list of Characteristics.

getType

public java.lang.String getType()

Description copied from interface: Service

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.

Specified by:

getType in interface Service

Returns:

A string representation of the UUID, with hexadecimal digits in the format ########-####-####-####-############.

getLinkedServices

public java.util.List<Service> getLinkedServices()

Description copied from interface: Service

List of all the services to which the service links

Specified by:

getLinkedServices in interface Service

Returns:

the list of linked services.

addCharacteristic

public void addCharacteristic(Characteristic characteristic)

addLinkedService

public void addLinkedService(Service service)

Description copied from interface: Service

Add linked services

Specified by:

addLinkedService in interface Service

Parameters:

service - linked service