Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 68943be0 authored by Matt Pietal's avatar Matt Pietal
Browse files

Controls API - Update template docs

Add more clarity around which control template to select.

Fixes: 150630500
Test: manual
Change-Id: I215e485e1cf81aae7e2c6c8b469945069136aad8
parent 70f970f8
Loading
Loading
Loading
Loading
+7 −0
Original line number Diff line number Diff line
@@ -789,6 +789,13 @@ public final class Control implements Parcelable {
        }

        /**
         * Set the {@link ControlTemplate} to define the primary user interaction
         *
         * Devices may support a variety of user interactions, and all interactions cannot be
         * represented with a single {@link ControlTemplate}. Therefore, the selected template
         * should be most closely aligned with what the expected primary device action will be.
         * Any secondary interactions can be done via the {@link #setAppIntent(PendingIntent)}.
         *
         * @param controlTemplate instance of {@link ControlTemplate}, that defines how the
         *                        {@link Control} will behave and what interactions are
         *                        available to the user