blob: 54cffdac639959556671289d344227eab1c9129e [file] [log] [blame]
Eric Erfaniand5e47f62017-03-15 14:41:07 -07001/*
2 * Copyright (C) 2017 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.voicemail;
18
19import android.content.Context;
20import android.provider.VoicemailContract.Voicemails;
21import android.support.annotation.Nullable;
22import android.telecom.PhoneAccountHandle;
23import android.telephony.TelephonyManager;
24import java.util.List;
25
26/** Public interface for the voicemail module */
27public interface VoicemailClient {
28
29 /**
30 * Broadcast to tell the client to upload local database changes to the server. Since the dialer
31 * UI and the client are in the same package, the {@link
32 * android.content.Intent#ACTION_PROVIDER_CHANGED} will always be a self-change even if the UI is
33 * external to the client.
34 */
35 String ACTION_UPLOAD = "com.android.voicemailomtp.VoicemailClient.ACTION_UPLOAD";
36
37 /**
38 * Appends the selection to ignore voicemails from non-active OMTP voicemail package. In OC there
39 * can be multiple packages handling OMTP voicemails which represents the same source of truth.
40 * These packages should mark their voicemails as {@link Voicemails#IS_OMTP_VOICEMAIL} and only
41 * the voicemails from {@link TelephonyManager#getVisualVoicemailPackageName()} should be shown.
42 * For example, the user synced voicemails with DialerA, and then switched to DialerB, voicemails
43 * from DialerA should be ignored as they are no longer current. Voicemails from {@link
44 * #OMTP_VOICEMAIL_BLACKLIST} will also be ignored as they are voicemail source only valid pre-OC.
45 */
46 void appendOmtpVoicemailSelectionClause(
47 Context context, StringBuilder where, List<String> selectionArgs);
Eric Erfanianfc37b022017-03-21 10:11:17 -070048
49 /**
50 * Appends the selection to ignore voicemail status from non-active OMTP voicemail package. The
51 * {@link android.provider.VoicemailContract.Status#SOURCE_TYPE} is checked against a list of
52 * known OMTP types. Voicemails from {@link #OMTP_VOICEMAIL_BLACKLIST} will also be ignored as
53 * they are voicemail source only valid pre-OC.
54 *
55 * @see #appendOmtpVoicemailSelectionClause(Context, StringBuilder, List)
56 */
57 void appendOmtpVoicemailStatusSelectionClause(
58 Context context, StringBuilder where, List<String> selectionArgs);
59
Eric Erfaniand5e47f62017-03-15 14:41:07 -070060 /**
61 * @return the class name of the {@link android.preference.PreferenceFragment} for voicemail
62 * settings, or {@code null} if dialer cannot control voicemail settings. Always return {@code
63 * null} before OC.
64 */
65 @Nullable
66 String getSettingsFragment();
67
68 boolean isVoicemailArchiveEnabled(Context context, PhoneAccountHandle phoneAccountHandle);
69
70 void setVoicemailArchiveEnabled(
71 Context context, PhoneAccountHandle phoneAccountHandle, boolean value);
72}