Interface ILocation<TEvent, TMobile>

Since

0.1

Device.Location allows capturing location change events on the device. In Android, Permissions#location permission must be taken on run time for 23 api level and above.

Example

import Timer    from '@smartface/native/timer';
    import Location from '@smartface/native/device/location';

    Location.start(Location.Android.Priority.HIGH_ACCURACY);
    Location.onLocationChanged = function(event) {
        console.log("Location latitude: " + event.latitude + "  Longitude: " + event.longitude);
    };

    Timer.setTimeout({
        delay: 30000,
        task: function() { Location.stop() }
    });

Type Parameters

TEvent extends string = LocationEvents
TMobile extends MobileOSProps<ILocationIOSProps, ILocationAndroidProps> = MobileOSProps<ILocationIOSProps, ILocationAndroidProps>

Hierarchy

default<TEvent | LocationEvents, TMobile>
- ILocation

Index

Properties

`Protected` _nativeObject

_nativeObject: any

iOS

iOS: { AuthorizationStatus: typeof PermissionIOSAuthorizationStatus }

Type declaration

AuthorizationStatus: typeof PermissionIOSAuthorizationStatus

Android

Android: { Priority: typeof LocationAndroidPriority; SettingsStatusCodes: typeof LocationAndroidSettingsStatusCodes }

Type declaration

Priority: typeof LocationAndroidPriority
SettingsStatusCodes: typeof LocationAndroidSettingsStatusCodes

Accessors

nativeObject

get nativeObject(): any
Returns any
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Inherited from NativeEventEmitterComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Inherited from NativeEventEmitterComponent.android
- Defined in core/native-mobile-component.ts:52

Methods

`Protected` `Abstract` createNativeObject

createNativeObject(params?: Partial<Record<string, any>>): any
Executed before everything. This should return nativeObject since it will be assinged directly to nativeObject.
Parameters
- Optional params: Partial<Record<string, any>>
Returns any
Inherited from NativeEventEmitterComponent.createNativeObject
- Defined in core/native-component.ts:33

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeEventEmitterComponent.preConstruct
- Defined in core/native-event-emitter-component.ts:27

`Protected` addAndroidProps

addAndroidProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

start

start(priority?: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER", interval?: number): void
Starts capturing.For Android, need to define interval & priority which need to be decided wisely; HIGH_ACCURACY, LOW_POWER , NO_POWER or BALANCED. iOS will ignore this priority.

Method
start

Android

Ios

Static

Since
0.1
Parameters
- Optional priority: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"
- Optional interval: number
Returns void
- Defined in device/location/location.ts:185

stop

stop(): void
Stops capturing.

Method
stop

Android

Ios

Static

Since
0.1

Returns void
- Defined in device/location/location.ts:195

getLastKnownLocation

getLastKnownLocation(onSuccess: ((e: { latitude: number; longitude: number }) => void), onFailure: (() => void)): void
Gets last known location. The onFailure function will be triggered if no location data has ever been retrieved or unexpected error occurred.

Method
getLastKnownLocation

Android

Ios

Static

Since
4.0.2
Parameters
- onSuccess: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
- onFailure: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in device/location/location.ts:230

getCurrentLocation

getCurrentLocation(shouldRequestPreciseLocation?: boolean, priority?: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"): Promise<GetCurrentLocationArgs>
Gets location latitude and longitude. Handles permissions by itself.

Returns
It either returns the permission result if permission is denied. If successful, it will return

See
- https://developer.android.com/training/location/permissions#types-of-access
- https://developer.android.com/training/location/change-location-settings#location-request
Example
```
import Location from '@smartface/native/device/location';

Location.getLocation()
    .then(location => {
        let requestOptions = {
            'url': 'http://maps.googleapis.com/maps/api/geocode/json?latlng=' + location.latitude + ',' + location.longitude + '&sensor=true',
            'method': 'GET'
        };
    })
    .catch(e => {
        // e is in the type of PermissionResult
        console.log("Location cannot be retrieved");
    });
```
Parameters
- Optional shouldRequestPreciseLocation: boolean
  
  Android only. When set to true, it will request for precise location. When set to false, it will request for approximate location only
- Optional priority: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"
  
  Sets the priority of the location request. Defaults to BALANCED
Returns Promise<GetCurrentLocationArgs>
- Defined in device/location/location.ts:262

on

on(eventName: "locationChanged", callback: ((e: { latitude: number; longitude: number }) => void)): (() => void)
Parameters
- eventName: "locationChanged"
- callback: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in device/location/location.ts:264
on(eventName: "locationChanged", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "locationChanged"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in device/location/location.ts:265

off

off(eventName: "locationChanged", callback: ((e: { latitude: number; longitude: number }) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in device/location/location.ts:267
off(eventName: "locationChanged", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in device/location/location.ts:268

emit

emit(eventName: "locationChanged", e: { latitude: number; longitude: number }): void
Parameters
- eventName: "locationChanged"
- e: { latitude: number; longitude: number }
  - latitude: number
  - longitude: number
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in device/location/location.ts:270
emit(eventName: "locationChanged", ...args: any[]): void
Parameters
- eventName: "locationChanged"
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in device/location/location.ts:271

once

once(eventName: "locationChanged", callback: ((e: { latitude: number; longitude: number }) => void)): (() => void)
Parameters
- eventName: "locationChanged"
- callback: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in device/location/location.ts:273
once(eventName: "locationChanged", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "locationChanged"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in device/location/location.ts:274

prependListener

prependListener(eventName: "locationChanged", callback: ((e: { latitude: number; longitude: number }) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in device/location/location.ts:276
prependListener(eventName: "locationChanged", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in device/location/location.ts:277

prependOnceListener

prependOnceListener(eventName: "locationChanged", callback: ((e: { latitude: number; longitude: number }) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((e: { latitude: number; longitude: number }) => void)
  - - (e: { latitude: number; longitude: number }): void
    - Parameters
      
      e: { latitude: number; longitude: number }
      
      latitude: number
      
      longitude: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in device/location/location.ts:279
prependOnceListener(eventName: "locationChanged", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "locationChanged"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in device/location/location.ts:280

Events

onLocationChanged

onLocationChanged: ((e: { latitude: number; longitude: number }) => void)

Type declaration

- (e: { latitude: number; longitude: number }): void
- Callback to capture location events.
  
  onLocationChanged
  
  Deprecated
  
  Android
  
  Ios
  
  Since
  0.1
  
  Example
```
import Location from '@smartface/native/device/location';

Location.on(Location.Events.LocationChanged, (params) => {
    console.info('onLocationChanged', params);
});
```
  Parameters
  - e: { latitude: number; longitude: number }
    - latitude: number
    - longitude: number
  Returns void

Interface ILocation<TEvent, TMobile>

Since

Example

Type Parameters

TEvent extends string = LocationEvents

TMobile extends MobileOSProps<ILocationIOSProps, ILocationAndroidProps> = MobileOSProps<ILocationIOSProps, ILocationAndroidProps>

Hierarchy

Index

Properties

Accessors

Methods

Events

Properties

Protected _nativeObject

iOS

Type declaration

AuthorizationStatus: typeof PermissionIOSAuthorizationStatus

Android

Type declaration

Priority: typeof LocationAndroidPriority

SettingsStatusCodes: typeof LocationAndroidSettingsStatusCodes

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

Methods

Protected Abstract createNativeObject

Parameters

Optional params: Partial<Record<string, any>>

Returns any

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Protected addAndroidProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

Protected addIOSProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

start

Method

Android

Ios

Static

Since

Parameters

Optional priority: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"

Optional interval: number

Returns void

stop

Method

Android

Ios

Static

Since

Returns void

getLastKnownLocation

Method

Android

Ios

Static

Since

Parameters

onSuccess: ((e: { latitude: number; longitude: number }) => void)

Parameters

e: { latitude: number; longitude: number }

latitude: number

longitude: number

Returns void

onFailure: (() => void)

Returns void

`Protected` _nativeObject

`Protected` `Abstract` createNativeObject

`Optional` params: Partial<Record<string, any>>

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Optional` priority: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"

`Optional` interval: number

`Optional` shouldRequestPreciseLocation: boolean

`Optional` priority: "HIGH_ACCURACY" | "BALANCED" | "LOW_POWER" | "NO_POWER"

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]