IAdvertiser

​

Interface IAdvertiser

interface IAdvertiser

Extends com.amazon.apmf.IStandard Interfaces for performing BLE advertisement operations.

​

Methods

​

makeSettingBuilder()

IAdvertisementSettingsBuilder* makeSettingBuilder()

Make BLE advertisement settings builder. Make an instance of IAdvertisementSettingsBuilder.

​

Returns

IAdvertisementSettingsBuilder* Returns pointer to this IAdvertisementSettingsBuilder.

​

Throws

• OutOfMemoryError — if making an instance of IAdvertisementSettingsBuilder failed.

---

​

makePayloadBuilder()

IAdvertisementPayloadBuilder* makePayloadBuilder()

Make BLE advertisement payload builder. Make an instance of IAdvertisementPayloadBuilder. This represents the data to be advertised as well as the scan response data for active scans. Users can also utilize this interface to construct scan response data, which can be configured as the ‘scanResponse’ parameter in startAdvertisingWithScanResponse.

​

Returns

IAdvertisementPayloadBuilder* Returns pointer to this IAdvertisementPayloadBuilder

​

Throws

• OutOfMemoryError — if making an instance of IAdvertisementPayloadBuilder failed.

---

​

startAdvertising()

void startAdvertising(IAdvertisementSettings* advSettings, IAdvertisementPayload* advData, IAdvertisementListener* advListener)

Request the advertiser to start an advertisement. Triggers advertisingStateChanged. API is non-blocking. Privilege: com.amazon.bluetooth.privilege.advertise

​

Parameters

advSettings

IAdvertisementSettings* — Required Advertisement setting instance that is created by IAdvertisementSettingsBuilder.

advData

IAdvertisementPayload* — Required Advertisement data payload instance that is created by IAdvertisementPayloadBuilder structure.

advListener

IAdvertisementListener* — Required The required instance of IAdvertisementListener for handling advertising states change.

​

Throws

• InvalidArgumentError — if the provided arguments are invalid.
• TimeoutError — if the client registration status change does not occur within the expected time of 1 second.

Various other errors defined in bluetooth-errors.idl.inc might be raised from low-level APIs.

---

​

startAdvertisingWithScanResponse()

void startAdvertisingWithScanResponse(IAdvertisementSettings* advSettings, IAdvertisementPayload* advData, IAdvertisementPayload* scanResponse, IAdvertisementListener* advListener)

Request the advertiser to start an advertisement with scan response data. Triggers advertisingStateChanged. Privilege: com.amazon.bluetooth.privilege.advertise

​

Parameters

advSettings

IAdvertisementSettings* — Required Advertisement settings instance that is created by IAdvertisementSettingsBuilder.

advData

IAdvertisementPayload* — Required Advertisement data payload instance that is created by IAdvertisementPayloadBuilder.

scanResponse

IAdvertisementPayload* — Required Payload instance that is created by IAdvertisementPayloadBuilder to be sent as a scan response.

advListener

IAdvertisementListener* — Required An instance of IAdvertisementListener required for handling advertising state changes.

​

Throws

• InvalidArgumentError — if the provided arguments are invalid.
• TimeoutError — if the client registration status change does not occur within the expected time.

Various other errors defined in bluetooth-errors.idl.inc might be raised from low-level APIs.

---

​

stopAdvertising()

void stopAdvertising()

Request the advertiser to stop the ongoing BLE advertisement. Triggers advertisingStateChanged. Privilege: com.amazon.bluetooth.privilege.advertise

​

Throws

• NullPointerError — if an empty advertisement instance handle is received.

Various other errors defined in bluetooth-errors.idl.inc might be raised from low-level APIs.

---