org.bluez.LEAdvertisingManager1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus Show documentation
Show all versions of bluez-dbus Show documentation
Java native bluetooth library which uses bluez via dbus (linux only)
package org.bluez;
import java.util.Map;
import org.bluez.exceptions.BluezAlreadyExistsException;
import org.bluez.exceptions.BluezDoesNotExistException;
import org.bluez.exceptions.BluezInvalidArgumentsException;
import org.bluez.exceptions.BluezInvalidLengthException;
import org.bluez.exceptions.BluezNotPermittedException;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;
/**
* File generated - 2020-06-18.
* Based on bluez Documentation: advertising-api.txt.
*
* Service: org.bluez
* Interface: org.bluez.LEAdvertisingManager1
*
* Object path:
* /org/bluez/{hci0,hci1,...}
*
* Supported properties:
*
* byte ActiveInstances
*
* Number of active advertising instances.
*
* byte SupportedInstances
*
* Number of available advertising instances.
*
* array{string} SupportedIncludes
*
* List of supported system includes.
*
* Possible values: "tx-power"
* "appearance"
* "local-name"
*
* array{string} SupportedSecondaryChannels [Experimental]
*
* List of supported Secondary channels. Secondary
* channels can be used to advertise with the
* corresponding PHY.
*
* Possible values: "1M"
* "2M"
* "Coded"
*
*/
public interface LEAdvertisingManager1 extends DBusInterface {
/**
* From bluez documentation:
*
* Registers an advertisement object to be sent over the LE
* Advertising channel. The service must be exported
* under interface LEAdvertisement1.
*
* InvalidArguments error indicates that the object has
* invalid or conflicting properties.
*
* InvalidLength error indicates that the data
* provided generates a data packet which is too long.
*
* The properties of this object are parsed when it is
* registered, and any changes are ignored.
*
* If the same object is registered twice it will result in
* an AlreadyExists error.
*
* If the maximum number of advertisement instances is
* reached it will result in NotPermitted error.
*
*
* @param _advertisement advertisement
* @param _options options
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezAlreadyExistsException when item already exists
* @throws BluezInvalidLengthException on BluezInvalidLengthException
* @throws BluezNotPermittedException on BluezNotPermittedException
*/
void RegisterAdvertisement(DBusPath _advertisement, Map> _options) throws BluezInvalidArgumentsException, BluezAlreadyExistsException, BluezInvalidLengthException, BluezNotPermittedException;
/**
* From bluez documentation:
*
* This unregisters an advertisement that has been
* previously registered. The object path parameter must
* match the same value that has been used on registration.
*
*
* @param _advertisement advertisement
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezDoesNotExistException when item does not exist
*/
void UnregisterAdvertisement(DBusPath _advertisement) throws BluezInvalidArgumentsException, BluezDoesNotExistException;
}