Package org.bluez

Interface LEAdvertisingManager1

  • All Superinterfaces:
    org.freedesktop.dbus.interfaces.DBusInterface
    public interface LEAdvertisingManager1
extends org.freedesktop.dbus.interfaces.DBusInterface
    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"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void RegisterAdvertisement​(org.freedesktop.dbus.DBusPath _advertisement, Map<String,​org.freedesktop.dbus.types.Variant<?>> _options)
      From bluez documentation:

      Registers an advertisement object to be sent over the LE
      Advertising channel.
      void UnregisterAdvertisement​(org.freedesktop.dbus.DBusPath _advertisement)
      From bluez documentation:

      This unregisters an advertisement that has been
      previously registered.

      • Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface

        getObjectPath, isRemote

    • Method Detail

      • RegisterAdvertisement

        void RegisterAdvertisement​(org.freedesktop.dbus.DBusPath _advertisement,
                           Map<String,​org.freedesktop.dbus.types.Variant<?>> _options)
                    throws BluezInvalidArgumentsException,
                           BluezAlreadyExistsException,
                           BluezInvalidLengthException,
                           BluezNotPermittedException
        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.

        Parameters:
        _advertisement - advertisement
        _options - options
        Throws:
        BluezInvalidArgumentsException - when argument is invalid
        BluezAlreadyExistsException - when item already exists
        BluezInvalidLengthException - on BluezInvalidLengthException
        BluezNotPermittedException - on BluezNotPermittedException