Add Kotlin Flow extensions to maps-ktx and maps-v3-ktx

[arriolac]

Overview

This is a tracking bug for adding Kotlin Flow support to methods within the maps-ktx and maps-v3-ktx packages where applicable.

Background

Version 2.1.0 of the KTX library added support for Kotlin flow through the introduction of the method cameraEvents(). As a continuation to this work, this issue is for adding extension methods returning Kotlin flows for methods that can be modeled as such. For example, set listener methods (e.g. setOnCameraIdleListener(), setOnMapClickListener(), and so on) are good candidates.

Design

While cameraEvents() added support for Kotlin flow, this method wrapped several set listener methods and should be improved upon to aid in predictability for the Kotlin flow extension APIs. Specifically, wrapped methods should have a unique Kotlin flow API. In other words, the relationship between the extended method and the extension methods should be one-to-one, and not one-to-many. Since cameraEvents() does not comply to this design, it should be removed or marked as deprecated in favor of the API convention described here.

Method Naming

• The setOn prefix should be dropped as well as the Listener suffix. Additionally, Events should be added as a suffix
  • Examples:
    • setOnCameraIdleListener() → cameraIdleEvents()
    • setOnMapClickListener() → mapClickEvents()

Developing

• Pull requests should be done against the feature branch kotlin-flow
• Pull requests should be kept small (one or few extension methods only), as well as an update to the sample app (a nice-to-have)
• Refer to feat: Add camera specific flow events and deprecate cameraEvents(). #113 as an example

Classes to Extend

• GoogleMap
• StreetViewPanorama

Contributing

Thinking of contributing? Awesome! Leave a comment below on what you'd like to add/work on so it's accounted for or any feedback on the design if you have any.

[googlemaps-bot]

🎉 This issue has been resolved in version 3.1.0 🎉

The release is available on:

• v3.1.0
• GitHub release

Your semantic-release bot 📦🚀