cordova-plugin-ibeacon.d.ts

// Type definitions for cordova-plugin-ibeacon v3.3.0
// Project: https://github.com/petermetz/cordova-plugin-ibeacon
// Definitions by: Markus Wagner <https://github.com/Ritzlgrmft/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path="../q/Q.d.ts" />

interface CordovaPlugins {
    locationManager: BeaconPlugin.LocationManager;
}

declare module BeaconPlugin {
	/**
	 * Beacon Plugin.
	 */
	export interface LocationManager {
		delegate: Delegate;
		BeaconRegion: BeaconRegion;
		onDomDelegateReady(): void;
		startMonitoringForRegion(region: Region): Q.Promise<void>;
		stopMonitoringForRegion(region: Region): Q.Promise<void>;
		requestStateForRegion(region: Region): Q.Promise<void>;
		startRangingBeaconsInRegion(region: Region): Q.Promise<void>;
		stopRangingBeaconsInRegion(region: Region): Q.Promise<void>;
		getAuthorizationStatus(): Q.Promise<PluginResult>;
		requestWhenInUseAuthorization(): Q.Promise<void>;
		requestAlwaysAuthorization(): Q.Promise<void>;
		getMonitoredRegions(): Q.Promise<Region[]>;
		getRangedRegions(): Q.Promise<Region[]>;
		isRangingAvailable(): Q.Promise<boolean>;
		isMonitoringAvailableForClass(region: Region): Q.Promise<boolean>;
		startAdvertising(region: Region, measuredPower: boolean): Q.Promise<void>;
		stopAdvertising(): Q.Promise<void>;
		isAdvertisingAvailable(): Q.Promise<boolean>;
		isAdvertising(): Q.Promise<boolean>;
		disableDebugLogs(): Q.Promise<void>;
		enableDebugNotifications(): Q.Promise<void>;
		disableDebugNotifications(): Q.Promise<void>;
		enableDebugLogs(): Q.Promise<void>;
		isBluetoothEnabled(): Q.Promise<boolean>;
		enableBluetooth(): Q.Promise<void>;
		disableBluetooth(): Q.Promise<void>;
		appendToDeviceLog(message: string): Q.Promise<string>;
	}

	export interface PluginResult {
		eventType: string;
		region: Region;
		beacons: Beacon[];
		authorizationStatus: string;
		state: string;
	}

	export interface Delegate {
		didDetermineStateForRegion(pluginResult: PluginResult): void;
		didStartMonitoringForRegion(pluginResult: PluginResult): void;
		didExitRegion(pluginResult: PluginResult): void;
		didEnterRegion(pluginResult: PluginResult): void;
		didRangeBeaconsInRegion(pluginResult: PluginResult): void;
		peripheralManagerDidStartAdvertising(pluginResult: PluginResult): void;
		peripheralManagerDidUpdateState(pluginResult: PluginResult): void;
		didChangeAuthorizationStatus(authorizationStatus: string): void;
		monitoringDidFailForRegionWithError(pluginResult: PluginResult): void;
	}

	export interface Region {
		identifier: string;
		new (identifier: string): Region;
	}

	export interface BeaconRegion extends Region {
		uuid: string;
		major: string;
		minor: string;
		notifyEntryStateOnDisplay: boolean;
		new (identifier: string, uuid: string, major?: number, minor?: number, notifyEntryStateOnDisplay?: boolean): BeaconRegion;
	}

	export interface CircularRegion extends Region {
		latitude: number;
		longitude: number;
		radius: number;
		new (identifier: string, latitude: number, longitude: number, radius: number): CircularRegion;
	}

	export interface Beacon {
		uuid: string;
		major: string;
		minor: string;
		proximity: string;
		tx: number;
		rssi: number;
		accuracy: number;
	}
}