Stay organized with collections
Save and categorize content based on your preferences.
PeriodicAdvertisingParameters.Builder
public
static
final
class
PeriodicAdvertisingParameters.Builder
extends Object
Summary
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
Builder
public Builder ()
Public methods
setIncludeTxPower
public PeriodicAdvertisingParameters.Builder setIncludeTxPower (boolean includeTxPower)
Whether the transmission power level should be included in the periodic packet.
| Parameters |
|---|
includeTxPower |
boolean |
setInterval
public PeriodicAdvertisingParameters.Builder setInterval (int interval)
Set advertising interval for periodic advertising, in 1.25ms unit. Valid values are from
80 (100ms) to 65519 (81.89875s). Value from range [interval, interval+20ms] will be
picked as the actual value.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# PeriodicAdvertisingParameters.Builder\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nPeriodicAdvertisingParameters.Builder\n=====================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/bluetooth/le/PeriodicAdvertisingParameters.Builder \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nPeriodicAdvertisingParameters.Builder\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.bluetooth.le.PeriodicAdvertisingParameters.Builder |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nSummary\n-------\n\n| ### Public constructors ||\n|----------------------------------------------------------------------------------------------------|---|\n| ` `[Builder](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder#Builder())`() ` |\n\n| ### Public methods ||\n|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[PeriodicAdvertisingParameters](/reference/android/bluetooth/le/PeriodicAdvertisingParameters) | ` `[build](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder#build())`() ` Build the [AdvertisingSetParameters](/reference/android/bluetooth/le/AdvertisingSetParameters) object. |\n| ` `[PeriodicAdvertisingParameters.Builder](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder) | ` `[setIncludeTxPower](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder#setIncludeTxPower(boolean))`(boolean includeTxPower) ` Whether the transmission power level should be included in the periodic packet. |\n| ` `[PeriodicAdvertisingParameters.Builder](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder) | ` `[setInterval](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder#setInterval(int))`(int interval) ` Set advertising interval for periodic advertising, in 1.25ms unit. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### Builder\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Builder ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### build\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic PeriodicAdvertisingParameters build ()\n```\n\nBuild the [AdvertisingSetParameters](/reference/android/bluetooth/le/AdvertisingSetParameters) object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------------------------------------------------------------|--------|\n| [PeriodicAdvertisingParameters](/reference/android/bluetooth/le/PeriodicAdvertisingParameters) | \u003cbr /\u003e |\n\n### setIncludeTxPower\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic PeriodicAdvertisingParameters.Builder setIncludeTxPower (boolean includeTxPower)\n```\n\nWhether the transmission power level should be included in the periodic packet.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|------------------|------------------|\n| `includeTxPower` | `boolean` \u003cbr /\u003e |\n\n| Returns ||\n|----------------------------------------------------------------------------------------------------------------|--------|\n| [PeriodicAdvertisingParameters.Builder](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder) | \u003cbr /\u003e |\n\n### setInterval\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic PeriodicAdvertisingParameters.Builder setInterval (int interval)\n```\n\nSet advertising interval for periodic advertising, in 1.25ms unit. Valid values are from\n80 (100ms) to 65519 (81.89875s). Value from range \\[interval, interval+20ms\\] will be\npicked as the actual value.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|------------|--------------|\n| `interval` | `int` \u003cbr /\u003e |\n\n| Returns ||\n|----------------------------------------------------------------------------------------------------------------|--------|\n| [PeriodicAdvertisingParameters.Builder](/reference/android/bluetooth/le/PeriodicAdvertisingParameters.Builder) | \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------|-----------------------------|\n| [IllegalArgumentException](/reference/java/lang/IllegalArgumentException) | If the interval is invalid. |"]]
