IAdvertisementSettingsBuilder

​

Interface IAdvertisementSettingsBuilder

interface IAdvertisementSettingsBuilder

Extends com.amazon.apmf.IStandard Advertisement settings builder

​

Methods

​

interval()

IAdvertisementSettingsBuilder* interval(AdvertisementInterval* advInterval)

Set advertisement interval.

​

Parameters

advInterval

AdvertisementInterval* — Required New advertisement interval to set.

​

Returns

IAdvertisementSettingsBuilder* Returns pointer to this IAdvertisementSettingsBuilder.

---

​

connectable()

IAdvertisementSettingsBuilder* connectable(bool connectable)

Set connectable.

​

Parameters

connectable

bool — Required Boolean value to set, default: false.

​

Returns

IAdvertisementSettingsBuilder* Returns pointer to this IAdvertisementSettingsBuilder.

---

​

timeoutInMilliseconds()

IAdvertisementSettingsBuilder* timeoutInMilliseconds(i32 milliseconds)

Set timeout in milliseconds when this advertisement should be stopped.

​

Parameters

milliseconds

i32 — Required Timeout in milliseconds.

​

Returns

IAdvertisementSettingsBuilder* Returns pointer to this IAdvertisementSettingsBuilder.

​

Throws

• InvalidArgumentError — when milliseconds set to negative number.

---

​

advertisementType()

IAdvertisementSettingsBuilder* advertisementType(AdvertisementType* advType)

Set property to configure advertisement connectability or directability.

​

Parameters

advType

AdvertisementType* — Required Advertisement type.

​

Returns

IAdvertisementSettingsBuilder* Returns pointer to this IAdvertisementSettingsBuilder.

---

​

build()

IAdvertisementSettings* build()

Build and return current advertisement settings instance.

​

Returns

IAdvertisementSettings* Returns pointer to IAdvertisementSettings.

​

Throws

• OutOfMemoryError — when making internal IAdvertisementSettings failed.

---