File: push_notification_client.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (43 lines) | stat: -rw-r--r-- 1,667 bytes parent folder | download | duplicates (7)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PUSH_NOTIFICATION_PUSH_NOTIFICATION_CLIENT_H_
#define COMPONENTS_PUSH_NOTIFICATION_PUSH_NOTIFICATION_CLIENT_H_

#include <string>

#include "base/containers/flat_map.h"
#include "components/push_notification/push_notification_client_id.h"

namespace push_notification {

// Base class for PushNotificationService clients to. Each feature that uses the
// PushNotificationService must create its own PushNotificationClient and
// implement the OnMessageReceived functionality. PushNotificationClient must
// register with the PushNotificationService to begin receiving messages.
class PushNotificationClient {
 public:
  explicit PushNotificationClient(ClientId client_id) : client_id_(client_id) {}
  virtual ~PushNotificationClient() = default;

  // Returns the feature's `client_id_`.
  ClientId GetClientId() { return client_id_; }

  // Only called when the instance of the `message_data` matches the
  // `client_id_`.
  virtual void OnMessageReceived(
      base::flat_map<std::string, std::string> message_data) = 0;

 private:
  // The enum that is used to associate incoming push notifications to
  // their destination feature. This identifier is converted to a unique string
  // using `GetClientIdStr()`, this string must match the identifier used inside
  // the notification's payload when sending the notification to the push
  // notification server.
  const ClientId client_id_;
};

}  // namespace push_notification

#endif  // COMPONENTS_PUSH_NOTIFICATION_PUSH_NOTIFICATION_CLIENT_H_