summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/precall/PreCallAction.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/com/android/dialer/precall/PreCallAction.java')
-rw-r--r--java/com/android/dialer/precall/PreCallAction.java46
1 files changed, 46 insertions, 0 deletions
diff --git a/java/com/android/dialer/precall/PreCallAction.java b/java/com/android/dialer/precall/PreCallAction.java
new file mode 100644
index 000000000..9434694a4
--- /dev/null
+++ b/java/com/android/dialer/precall/PreCallAction.java
@@ -0,0 +1,46 @@
+/*
+ * 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.dialer.precall;
+
+import android.support.annotation.MainThread;
+import com.android.dialer.callintent.CallIntentBuilder;
+
+/**
+ * An action to perform before the call is made. The action should inspect and modify the {@link
+ * CallIntentBuilder} to generate full information for the call. For example, showing a dialog to
+ * select the phone account on a multi-SIM device, ask if RTT should be enabled, or rewrite the
+ * number for roaming calls.
+ */
+public interface PreCallAction {
+
+ /**
+ * Runs the action. Should block on the main thread until the action is finished. If the action is
+ * not instantaneous, {@link PreCallCoordinator#startPendingAction()} should be called to release
+ * the thread and continue later.
+ */
+ @MainThread
+ void run(PreCallCoordinator coordinator);
+
+ /**
+ * Called when the UI is being paused when a {@link PreCallCoordinator.PendingAction} is started,
+ * and the action is going to be discarded. If the action is showing a dialog the dialog should be
+ * dismissed. The action should not retain state, a new instance of the action will be re-run when
+ * the UI is resumed.
+ */
+ @MainThread
+ void onDiscard();
+}