BeaconState
Stay organized with collections
Save and categorize content based on your preferences.
State of nearby beacon devices.
Nested Class Summary
interface
Information from one beacon.
class
The type of beacon to match.
Public Methods
Get the list of all beacons that are nearby.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 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 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eBeaconState\u003c/code\u003e provides information about the state of nearby beacon devices.\u003c/p\u003e\n"],["\u003cp\u003eIt includes nested classes: \u003ccode\u003eBeaconInfo\u003c/code\u003e for individual beacon details and \u003ccode\u003eTypeFilter\u003c/code\u003e for defining beacon types to match.\u003c/p\u003e\n"],["\u003cp\u003eThe primary method is \u003ccode\u003egetBeaconInfo()\u003c/code\u003e, which returns a list of nearby beacons as \u003ccode\u003eBeaconState.BeaconInfo\u003c/code\u003e objects.\u003c/p\u003e\n"]]],["`BeaconState` provides information about nearby beacon devices. It offers a method, `getBeaconInfo()`, which retrieves a list of `BeaconInfo` objects, each representing data from a single beacon. `BeaconState.TypeFilter` is a nested class used to specify the types of beacons to be matched. The core functionality is centered on accessing the list of nearby beacons and their respective information through `getBeaconInfo()`.\n"],null,["# BeaconState\n\npublic interface **BeaconState** \nState of nearby beacon devices. \n\n### Nested Class Summary\n\n|-----------|---|---|------------------------------|\n| interface | [BeaconState.BeaconInfo](/android/reference/com/google/android/gms/awareness/state/BeaconState.BeaconInfo) || Information from one beacon. |\n| class | [BeaconState.TypeFilter](/android/reference/com/google/android/gms/awareness/state/BeaconState.TypeFilter) || The type of beacon to match. |\n\n### Public Method Summary\n\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [List](//developer.android.com/reference/java/util/List.html)\\\u003c[BeaconState.BeaconInfo](/android/reference/com/google/android/gms/awareness/state/BeaconState.BeaconInfo)\\\u003e | [getBeaconInfo](/android/reference/com/google/android/gms/awareness/state/BeaconState#getBeaconInfo())() Get the list of all beacons that are nearby. |\n\nPublic Methods\n--------------\n\n#### public abstract [List](//developer.android.com/reference/java/util/List.html)\\\u003c[BeaconState.BeaconInfo](/android/reference/com/google/android/gms/awareness/state/BeaconState.BeaconInfo)\\\u003e\n**getBeaconInfo** ()\n\nGet the list of all beacons that are nearby. \n\n##### Returns\n\n- list of [BeaconState.BeaconInfo](/android/reference/com/google/android/gms/awareness/state/BeaconState.BeaconInfo)."]]