1 files changed, 125 insertions, 0 deletions
diff --git a/java/com/android/voicemail/VoicemailClient.java b/java/com/android/voicemail/VoicemailClient.java
new file mode 100644
index 000000000..97b824b27
--- /dev/null
+++ b/java/com/android/voicemail/VoicemailClient.java
@@ -0,0 +1,125 @@
+/*
+ * Copyright (C) 2017 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+package com.android.voicemail;
+
+import android.content.Context;
+import android.content.Intent;
+import android.provider.VoicemailContract.Voicemails;
+import android.support.annotation.Nullable;
+import android.telecom.PhoneAccountHandle;
+import android.telephony.TelephonyManager;
+import java.util.List;
+
+/** Public interface for the voicemail module */
+public interface VoicemailClient {
+
+  /**
+   * Whether the voicemail module is enabled (OS has support and not disabled by flags, etc.). This
+   * does not mean the carrier has support or user has enabled the feature.
+   */
+  boolean isVoicemailModuleEnabled();
+
+  /**
+   * Broadcast to tell the client to upload local database changes to the server. Since the dialer
+   * UI and the client are in the same package, the {@link
+   * android.content.Intent#ACTION_PROVIDER_CHANGED} will always be a self-change even if the UI is
+   * external to the client.
+   */
+  String ACTION_UPLOAD = "com.android.voicemail.VoicemailClient.ACTION_UPLOAD";
+
+  /** Common key for passing {@link PhoneAccountHandle} in bundles. */
+  String PARAM_PHONE_ACCOUNT_HANDLE = "phone_account_handle";
+
+  /**
+   * Broadcast from the client to inform the app to show a legacy voicemail notification. This
+   * broadcast is same as {@link TelephonyManager#ACTION_SHOW_VOICEMAIL_NOTIFICATION}.
+   */
+  String ACTION_SHOW_LEGACY_VOICEMAIL =
+      "com.android.voicemail.VoicemailClient.ACTION_SHOW_LEGACY_VOICEMAIL";
+
+  /**
+   * Whether the visual voicemail service is enabled for the {@code phoneAccountHandle}. "Enable"
+   * means the user "wants" to have this service on, and does not mean the service is actually
+   * functional(For example, the service is blocked on the carrier side. The service will be
+   * "enabled" but all it will do is show the error).
+   */
+  boolean isVoicemailEnabled(Context context, PhoneAccountHandle phoneAccountHandle);
+
+  /**
+   * Enable or disable visual voicemail service for the {@code phoneAccountHandle}. Setting to
+   * enabled will initiate provisioning and activation. Setting to disabled will initiate
+   * deactivation.
+   */
+  void setVoicemailEnabled(Context context, PhoneAccountHandle phoneAccountHandle, boolean enabled);
+
+  /**
+   * Appends the selection to ignore voicemails from non-active OMTP voicemail package. In OC there
+   * can be multiple packages handling OMTP voicemails which represents the same source of truth.
+   * These packages should mark their voicemails as {@link Voicemails#IS_OMTP_VOICEMAIL} and only
+   * the voicemails from {@link TelephonyManager#getVisualVoicemailPackageName()} should be shown.
+   * For example, the user synced voicemails with DialerA, and then switched to DialerB, voicemails
+   * from DialerA should be ignored as they are no longer current. Voicemails from {@link
+   * #OMTP_VOICEMAIL_BLACKLIST} will also be ignored as they are voicemail source only valid pre-OC.
+   */
+  void appendOmtpVoicemailSelectionClause(
+      Context context, StringBuilder where, List<String> selectionArgs);
+
+  /**
+   * Appends the selection to ignore voicemail status from non-active OMTP voicemail package. The
+   * {@link android.provider.VoicemailContract.Status#SOURCE_TYPE} is checked against a list of
+   * known OMTP types. Voicemails from {@link #OMTP_VOICEMAIL_BLACKLIST} will also be ignored as
+   * they are voicemail source only valid pre-OC.
+   *
+   * @see #appendOmtpVoicemailSelectionClause(Context, StringBuilder, List)
+   */
+  void appendOmtpVoicemailStatusSelectionClause(
+      Context context, StringBuilder where, List<String> selectionArgs);
+
+  /**
+   * @return the class name of the {@link android.preference.PreferenceFragment} for voicemail
+   *     settings, or {@code null} if dialer cannot control voicemail settings. Always return {@code
+   *     null} before OC.
+   */
+  @Nullable
+  String getSettingsFragment();
+
+  boolean isVoicemailArchiveEnabled(Context context, PhoneAccountHandle phoneAccountHandle);
+
+  /**
+   * @return if the voicemail archive feature is available on the current device. This depends on
+   *     whether the server side flag is turned on for the feature, and if the OS meets the
+   *     requirement for this feature.
+   */
+  boolean isVoicemailArchiveAvailable(Context context);
+
+  void setVoicemailArchiveEnabled(
+      Context context, PhoneAccountHandle phoneAccountHandle, boolean value);
+
+  /**
+   * @return an intent that will launch the activity to change the voicemail PIN. The PIN is used
+   *     when calling into the mailbox.
+   */
+  Intent getSetPinIntent(Context context, PhoneAccountHandle phoneAccountHandle);
+
+  /**
+   * Whether the client is activated and handling visual voicemail for the {@code
+   * phoneAccountHandle}. "Enable" is the intention to use VVM. For example VVM can be enabled but
+   * prevented from working because the carrier blocked it, or a connection problem is blocking the
+   * provisioning. Being "activated" means all setup are completed, and VVM is expected to work.
+   */
+  boolean isActivated(Context context, PhoneAccountHandle phoneAccountHandle);
+}