AnnouncementGenerator
Responsible for generating announcements.
Important: This is a Public Preview API. It may be changed or removed at any time.
Types
Link copied to clipboard
data class GenerateParams( val announcements: List<Announcement>, val distanceToNextInstruction: Distance, val destinationArrivalStatus: DestinationArrivalStatus, val announcementLanguage: String)
Content copied to clipboard
Parameters for announcement generators, e.g.: distance to next instruction in meters, or list of all possible announcements.
Functions
Link copied to clipboard
open fun findAnnouncement(generateParams: AnnouncementGenerator.GenerateParams): Announcement?
Content copied to clipboard
Finds an Announcement if there is one that should be generated.
Link copied to clipboard
open fun generate(generateParams: AnnouncementGenerator.GenerateParams): GuidanceAnnouncement
Content copied to clipboard
Generates a GuidanceAnnouncement.
Link copied to clipboard
open fun hasAnnouncement(generateParams: AnnouncementGenerator.GenerateParams): Boolean
Content copied to clipboard
Checks if there is a proper Announcement.
Link copied to clipboard
open fun hasArrived(generateParams: AnnouncementGenerator.GenerateParams): Boolean
Content copied to clipboard
Checks if the destination is reached.
Link copied to clipboard
open fun shouldGenerate(generateParams: AnnouncementGenerator.GenerateParams): Boolean
Content copied to clipboard
Checks if a GuidanceAnnouncement should be generated.
Link copied to clipboard
Return supported type of an Announcement.