summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/duo/Duo.java
blob: 85fe9fbc163626ed63d87cc0701e243421928237 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * 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.duo;

import android.content.Context;
import android.content.Intent;
import android.support.annotation.DrawableRes;
import android.support.annotation.MainThread;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.StringRes;
import android.telecom.Call;
import android.telecom.PhoneAccountHandle;
import com.google.auto.value.AutoValue;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.ListenableFuture;
import java.util.List;

/** Interface for Duo video call integration. */
@SuppressWarnings("Guava")
public interface Duo {

  /** @return true if the Duo integration is enabled on this device. */
  boolean isEnabled(@NonNull Context context);

  /** @return true if Duo is installed on this device. */
  boolean isInstalled(@NonNull Context context);

  /**
   * @return true if Duo is installed and the user has gone through the set-up flow confirming their
   *     phone number.
   */
  boolean isActivated(@NonNull Context context);

  /** @return true if the parameter number is reachable on Duo. */
  @MainThread
  boolean isReachable(@NonNull Context context, @Nullable String number);

  /**
   * @return true if the number supports upgrading a voice call to a Duo video call. Returns {@code
   *     null} if result is unknown.
   */
  @MainThread
  Optional<Boolean> supportsUpgrade(
      @NonNull Context context,
      @Nullable String number,
      @Nullable PhoneAccountHandle phoneAccountHandle);

  /** Starts a task to update the reachability of the parameter numbers asynchronously. */
  @MainThread
  ListenableFuture<ImmutableMap<String, ReachabilityData>> updateReachability(
      @NonNull Context context, @NonNull List<String> numbers);

  /**
   * Clears the current reachability data and starts a task to load the latest reachability data
   * asynchronously.
   */
  @MainThread
  void reloadReachability(@NonNull Context context);

  /**
   * Get the {@link PhoneAccountHandle} used by duo calls in the connection service and call log.
   */
  Optional<PhoneAccountHandle> getPhoneAccountHandle();

  boolean isDuoAccount(PhoneAccountHandle phoneAccountHandle);

  boolean isDuoAccount(String componentName);

  /**
   * @return an Intent to start a Duo video call with the parameter number. Must be started using
   *     startActivityForResult.
   */
  @MainThread
  Optional<Intent> getCallIntent(@NonNull String number);

  /** @return an Intent to setup duo. Must be started using startActivityForResult. */
  Optional<Intent> getActivateIntent();

  /**
   * @return an Intent to invite the parameter number to use duo. Must be started using
   *     startActivityForResult.
   */
  Optional<Intent> getInviteIntent(String number);

  Optional<Intent> getInstallDuoIntent();

  /** Requests upgrading the parameter ongoing call to a Duo video call. */
  @MainThread
  void requestUpgrade(@NonNull Context context, Call call);

  /** Registers a listener for reachability data changes. */
  @MainThread
  void registerListener(@NonNull DuoListener listener);

  /** Unregisters a listener for reachability data changes. */
  @MainThread
  void unregisterListener(@NonNull DuoListener listener);

  /** The string resource to use for outgoing Duo call entries in call details. */
  @StringRes
  @MainThread
  int getOutgoingCallTypeText();

  /** The string resource to use for incoming Duo call entries in call details. */
  @StringRes
  @MainThread
  int getIncomingCallTypeText();

  /** The ID of the drawable resource of a Duo logo. */
  @DrawableRes
  @MainThread
  int getLogo();

  /** Reachability information for a number. */
  @AutoValue
  abstract class ReachabilityData {
    public enum Status {
      UNKNOWN,

      /**
       * The number is callable. Apps should further look up “AUDIO_CALLABLE” and “VIDEO_CALLABLE”
       * keys for supported modes.
       */
      CALL,

      /** The number is not callable. Apps can send an invite to the contact via INVITE intent. */
      INVITE,

      /**
       * Neither Tachystick nor Duo is registered. Apps should show “setup” icon and send REGISTER
       * intent to.
       */
      SETUP,

      /**
       * Indicates that the number is callable but user needs to set up (Tachystick/Duo) before
       * calling.
       */
      SETUP_AND_CALL
    }

    public abstract Status status();

    public abstract String number();

    public abstract boolean audioCallable();

    public abstract boolean videoCallable();

    public abstract boolean supportsUpgrade();

    public static ReachabilityData create(
        Status status,
        String number,
        boolean audioCallable,
        boolean videoCallable,
        boolean supportsUpgrade) {
      return new AutoValue_Duo_ReachabilityData(
          status, number, audioCallable, videoCallable, supportsUpgrade);
    }
  }
}