blob: 11c32cfc6cecf1d621ca482ec568814593b9758a [file] [log] [blame]
Dennis Tu22628562023-01-31 22:47:11 +00001/*
2 * Copyright 2023 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package androidx.appactions.interaction.capabilities.core
18
19/**
20 * Interface to be implemented for creating SessionT instances.
21 */
Dennis Tu4685efe2023-03-01 23:10:15 +000022fun interface SessionFactory<SessionT> {
Dennis Tu22628562023-01-31 22:47:11 +000023 /**
Dennis Tu4685efe2023-03-01 23:10:15 +000024 * Implement this method to create session for handling assistant requests.
Dennis Tu308d0d92023-02-03 07:41:47 +000025 *
26 * @param hostProperties only applicable while used with AppInteractionService. Contains the
27 * dimensions of the UI area. Null when used without AppInteractionService.
28 *
Dennis Tu22628562023-01-31 22:47:11 +000029 * @return A new SessionT instance for handling a task.
30 */
31 fun createSession(
Dennis Tu308d0d92023-02-03 07:41:47 +000032 hostProperties: HostProperties?,
Dennis Tu22628562023-01-31 22:47:11 +000033 ): SessionT
34}