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
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_ASH_COMPONENTS_PHONEHUB_NOTIFICATION_ACCESS_SETUP_OPERATION_H_
#define CHROMEOS_ASH_COMPONENTS_PHONEHUB_NOTIFICATION_ACCESS_SETUP_OPERATION_H_
#include <optional>
#include <ostream>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
namespace ash::phonehub {
// Implements the notification access setup flow. This flow involves:
// (1) Creating a connection to the phone if one does not already exist.
// (2) Sending a message to the phone which asks it to begin the setup flow;
// upon receipt of the message, the phone displays a UI which asks the
// user to enable notification access for Phone Hub.
// (3) Waiting for the user to complete the flow; once the flow is complete, the
// phone sends a message back to this device which indicates that
// notification access has been granted.
//
// If an instance of this class exists, the flow continues until the status
// changes to a "final" status (i.e., a success or a fatal error). To cancel the
// ongoing setup operation, simply delete the instance of this class.
class NotificationAccessSetupOperation {
public:
// Note: Numerical values should not be changed because they must stay in
// sync with multidevice_notification_access_setup_dialog.js, with the
// exception of NOT_STARTED, which has a value of 0. Also, these values are
// persisted to logs. Entries should not be renumbered and numeric values
// should never be reused. If entries are added, kMaxValue should be updated.
enum class Status {
// Connecting to the phone in order to set up notification access.
kConnecting = 1,
// No connection was able to be made to the phone within the expected time
// period.
kTimedOutConnecting = 2,
// A connection to the phone was successful, but it unexpectedly became
// disconnected before the setup flow could complete.
kConnectionDisconnected = 3,
// A connection to the phone has succeeded, and a message has been sent to
// the phone to start the notification access opt-in flow. However, the user
// has not yet completed the flow phone-side.
kSentMessageToPhoneAndWaitingForResponse = 4,
// The user has completed the phone-side opt-in flow.
kCompletedSuccessfully = 5,
// The user's phone is prohibited from granting notification access (e.g.,
// the user could be using a Work Profile).
kProhibitedFromProvidingAccess = 6,
kMaxValue = kProhibitedFromProvidingAccess
};
// Returns true if the provided status is the final one for this operation,
// indicating either success or failure.
static bool IsFinalStatus(Status status);
class Delegate {
public:
virtual ~Delegate() = default;
// Called when status of the setup flow has changed.
virtual void OnNotificationStatusChange(Status new_status) = 0;
};
NotificationAccessSetupOperation(const NotificationAccessSetupOperation&) =
delete;
NotificationAccessSetupOperation& operator=(
const NotificationAccessSetupOperation&) = delete;
virtual ~NotificationAccessSetupOperation();
private:
friend class MultideviceFeatureAccessManager;
NotificationAccessSetupOperation(Delegate* delegate,
base::OnceClosure destructor_callback);
void NotifyNotificationStatusChanged(Status new_status);
std::optional<Status> current_status_;
const base::TimeTicks start_timestamp_ = base::TimeTicks::Now();
const raw_ptr<Delegate> delegate_;
base::OnceClosure destructor_callback_;
};
std::ostream& operator<<(std::ostream& stream,
NotificationAccessSetupOperation::Status status);
} // namespace ash::phonehub
#endif // CHROMEOS_ASH_COMPONENTS_PHONEHUB_NOTIFICATION_ACCESS_SETUP_OPERATION_H_
|
