getForecast static method
- required List<
WeatherDurationCoordinates> coords, - void onComplete(
- GemError error,
- List<
LocationForecast> locationForecasts
- CoverageGeometry coverageGeometry = CoverageGeometry.none,
Retrieves weather forecast for coordinates at specified future times.
The duration in each WeatherDurationCoordinates specifies the time offset into the future for which the forecast is requested.
Parameters
coords: List of coordinates with duration offsets for forecast requests.onComplete: Callback invoked when the operation completes. The callback is called with:- GemError.success and non-empty LocationForecast list on success.
- GemError.invalidInput and empty list if the coordinates list is empty.
- GemError.resourceMissing and empty list if internal engine resource is missing.
- GemError.outOfRange and empty list if number of coordinates exceeds maxCoordinatesPerRequest.
- Other GemError values and empty list on other errors.
coverageGeometry: Pass CoverageGeometry.polygons to also receive the coverage polygons of the returned weather warnings (see Warning.coverage); with CoverageGeometry.none (default) Warning.coverage stays empty. The forecast warnings are always returned (evaluated per route point at that point's ETA); only their coverage geometry is optional.
Returns
- ProgressListener: Progress listener for tracking the operation.
Also see:
- maxCoordinatesPerRequest — Maximum number of coordinates allowed per request.
Implementation
static ProgressListener getForecast({
required List<WeatherDurationCoordinates> coords,
void Function(GemError, List<LocationForecast> locationForecasts)?
onComplete,
CoverageGeometry coverageGeometry = CoverageGeometry.none,
}) {
for (final WeatherDurationCoordinates coord in coords) {
if (coord.coordinates.latitude.abs() > 90 ||
coord.coordinates.longitude.abs() > 180) {
onComplete?.call(GemError.invalidInput, <LocationForecast>[]);
return EventDrivenProgressListener();
}
}
final LocationForecastList result = LocationForecastList();
final EventDrivenProgressListener listener = EventDrivenProgressListener();
GemKitPlatform.instance.registerEventHandler(listener.id, listener);
listener.registerOnCompleteWithData((
int err,
String hint,
Map<dynamic, dynamic> json,
) {
GemKitPlatform.instance.unregisterEventHandler(listener.id);
if (err == 0) {
onComplete?.call(GemErrorExtension.fromCode(err), result.json);
result.dispose();
} else {
onComplete?.call(GemErrorExtension.fromCode(err), <LocationForecast>[]);
}
});
final OperationResult resultString = staticMethod(
'Weather',
'getForecast',
args: <String, dynamic>{
'coords': coords,
'result': result.id,
'listener': listener.id,
'geometry': coverageGeometry.id,
},
);
final GemError errCode = GemErrorExtension.fromCode(resultString['result']);
if (errCode != GemError.success) {
onComplete?.call(errCode, <LocationForecast>[]);
}
return listener;
}