import { PointDestination, RouteDestination, CourseInfo } from './coursetypes'; /** * @see [Course REST API](../../../docs/develop/rest-api/course_api.md) provides the following functions for use by plugins. * @category Course API */ export interface CourseApi { /** * Retrieves the current course information. * * @category Course API */ getCourse(): Promise; /** * Cancels navigation to the current point or route being followed. * * @category Course API */ clearDestination(): Promise; /** * Set course to a specified position / waypoint. * * @category Course API * * @param dest - Object containing destination position information. * */ setDestination(dest: (PointDestination & { arrivalCircle?: number; }) | null): Promise; /** * Follow a route in the specified direction and starting at the specified point. * * @param dest - Object containing route information. * * - returns: Resolved Promise on success. * * @category Course API */ activateRoute(dest: RouteDestination | null): Promise; } //# sourceMappingURL=course.d.ts.map