1/*
2 * Copyright (C) 2014 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 com.android.incallui;
18
19import android.telecom.InCallService;
20
21/**
22 * Interface implemented by In-Call components that maintain a reference to the Telecomm API
23 * {@code InCallService} object. Clarifies the expectations associated with the relevant method
24 * calls.
25 */
26public interface InCallServiceListener {
27
28    /**
29     * Called once at {@code InCallService} startup time with a valid instance. At
30     * that time, there will be no existing {@code Call}s.
31     *
32     * @param inCallService The {@code InCallService} object.
33     */
34    void setInCallService(InCallService inCallService);
35
36    /**
37     * Called once at {@code InCallService} shutdown time. At that time, any {@code Call}s
38     * will have transitioned through the disconnected state and will no longer exist.
39     */
40    void clearInCallService();
41}
42