react-native-beacons-manager/typings/react-native-beacons-manager.d.ts

React-Native library for detecting beacons (iOS and Android)

declare module 'react-native-beacons-manager' {

  export interface BeaconRegion {
    identifier: string,
    uuid: string,
    minor?: number,
    major?: number
  };

  ///////////////////////////////////////////////////////
  // android only
  ///////////////////////////////////////////////////////

  const ARMA_RSSI_FILTER: string;
  const RUNNING_AVG_RSSI_FILTER: string

  function setHardwareEqualityEnforced(
    flag: boolean
  ): void;

  function detectIBeacons(): void;

  function detectAltBeacons(): void;

  function detectEstimotes(): void;

  function detectEddystoneUID(): void;

  function detectEddystoneURL(): void;

  function detectEddystoneTLM(): void;

  function detectCustomBeaconLayout(
    parser: number
  ): void;

  function setBackgroundScanPeriod(
    period: number
  ): void;

  function setBackgroundBetweenScanPeriod(
    period: number
  ): void;

  function setForegroundScanPeriod(
    period: number
  ): void;

  function setRssiFilter(
    filterType: number,
    avgModifier: number
  ): void;

  function getRangedRegions(): Promise<any>;

  function getMonitoredRegions(): Promise<Array<BeaconRegion>>;

  function checkTransmissionSupported(): Promise<number>;

  ///////////////////////////////////////////////////////
  // common iOS and Android
  ///////////////////////////////////////////////////////

  function startMonitoringForRegion(
    region: BeaconRegion
  ): Promise<any>;

  function startRangingBeaconsInRegion(
    regionId: string,
    beaconsUUID?: string
  ): Promise<any>;

  function stopMonitoringForRegion(
    region: BeaconRegion
  ): Promise<any>;

  function stopRangingBeaconsInRegion(
    regionId: string,
    beaconsUUID?: string
  ): Promise<any>;


}