Class LocationModule

Returns LocationModule

Returns Promise<GetCoordinateResponse>

The device's current latitude and longitude coordinates.

import { LocationModule, isSuccess, isErrorResponse } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Get current coordinates
const response = await location.getCoordinate();

// Handle the response
if (isSuccess(response)) {
  console.log('Coordinates:', response.result.lat, response.result.lng);
} else if (isErrorResponse(response)) {
  switch (response.status_code) {
    case 403:
      console.log('No permission to access location');
      // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
      break;
    default:
      console.error(`Error ${response.status_code}: ${response.error}`);
  }
} else {
  console.error('Unhandled response');
}
Copy

Returns Promise<GetCountryCodeResponse>

The ISO country code (e.g., 'SG', 'ID') based on the device's location.

import { LocationModule, isSuccess, isErrorResponse } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Get country code
const response = await location.getCountryCode();

// Handle the response
if (isSuccess(response)) {
  console.log('Country code:', response.result.countryCode);
} else if (isErrorResponse(response)) {
  switch (response.status_code) {
    case 403:
      console.log('No permission to access location');
      // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
      break;
    default:
      console.error(`Error ${response.status_code}: ${response.error}`);
  }
} else {
  console.error('Unhandled response');
}
Copy

Returns ObserveLocationChangeResponse

A BridgeStream that emits location updates as the device location changes. Use subscribe() to listen for updates, or await to get the first value only.

import { LocationModule, isSuccess, isErrorResponse } from '@grabjs/superapp-sdk';

// Initialize the location module
const location = new LocationModule();

// Subscribe to location changes
const subscription = location.observeLocationChange().subscribe({
  next: (response) => {
    if (isSuccess(response)) {
      console.log('Location updated:', response.result.lat, response.result.lng);
    } else if (isErrorResponse(response)) {
      switch (response.status_code) {
        case 403:
          console.log('No permission to access location');
          // Trigger IdentityModule.authorize() for scope 'mobile.geolocation', then reload via ScopeModule.reloadScopes() and try again
          break;
        default:
          console.error(`Error ${response.status_code}: ${response.error}`);
      }
    }
  },
  complete: () => console.log('Location stream completed')
});

// Later, to stop receiving updates:
subscription.unsubscribe();
Copy