AnnouncementGenerator Protocol Reference
AnnouncementGenerator
public protocol AnnouncementGeneratorResponsible for generating announcements.
Important
This is a Public Preview API. It may be changed or removed at any time.-
Checks if a
GuidanceAnnouncementshould be generated.Declaration
Swift
func shouldGenerate(parameters: AnnouncementGenerationParams) -> BoolParameters
parametersannouncement generation parameters
Return Value
The check result,
trueif an announcement should be generated,falseotherwise. -
Generates a
GuidanceAnnouncement.Declaration
Swift
func generateAnnouncement(parameters: AnnouncementGenerationParams) throws -> GuidanceAnnouncementParameters
parametersAnnouncement generation parameters.
Return Value
Generated
GuidanceAnnouncementinstance that should be announced at the current point on the route.