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
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_DBUS_NFC_TAG_CLIENT_H_
#define CHROMEOS_DBUS_NFC_TAG_CLIENT_H_
#include <map>
#include <string>
#include <vector>
#include "chromeos/chromeos_export.h"
#include "chromeos/dbus/dbus_client.h"
#include "chromeos/dbus/dbus_client_implementation_type.h"
#include "chromeos/dbus/nfc_client_helpers.h"
#include "chromeos/dbus/nfc_property_set.h"
#include "dbus/object_path.h"
#include "dbus/object_proxy.h"
#include "dbus/property.h"
namespace chromeos {
class NfcAdapterClient;
// NfcTagClient is used to communicate with objects representing remote NFC
// tags.
class CHROMEOS_EXPORT NfcTagClient : public DBusClient {
public:
// Structure of properties associated with an NFC tag.
struct Properties : public NfcPropertySet {
// The NFC tag type. Possible values are "Type 1", "Type 2", "Type 3",
// and "Type 4".
dbus::Property<std::string> type;
// The NFC tag radio protocol. Possible values are "Felica", "MIFARE",
// "Jewel", "ISO-DEP", and "NFC-DEP".
dbus::Property<std::string> protocol;
// List of object paths for NDEF Records associated with the NFC tag.
dbus::Property<std::vector<dbus::ObjectPath> > records;
// The current status of the tag's read mode.
dbus::Property<bool> read_only;
Properties(dbus::ObjectProxy* object_proxy,
const PropertyChangedCallback& callback);
virtual ~Properties();
};
// Interface for observing changes from a remote NFC tag.
class Observer {
public:
virtual ~Observer() {}
// Called when a remote NFC tag with the object path |object_path| is added
// to the set of known tags.
virtual void TagFound(const dbus::ObjectPath& object_path) {}
// Called when a remote NFC tag with the object path |object_path| is
// removed from the set of known tags.
virtual void TagLost(const dbus::ObjectPath& object_path) {}
// Called when the tag property with the name |property_name| on tag with
// object path |object_path| has acquired a new value.
virtual void TagPropertyChanged(const dbus::ObjectPath& object_path,
const std::string& property_name) {}
};
// TODO(armansito): Move this typedef to the NFC Record client, once
// implemented.
typedef std::map<std::string, std::string> RecordAttributes;
virtual ~NfcTagClient();
// Adds and removes observers for events on all remote NFC tags. Check the
// |object_path| parameter of observer methods to determine which tag is
// issuing the event.
virtual void AddObserver(Observer* observer) = 0;
virtual void RemoveObserver(Observer* observer) = 0;
// Obtain the properties for the NFC tag with object path |object_path|; any
// values should be copied if needed.
virtual Properties* GetProperties(const dbus::ObjectPath& object_path) = 0;
// Creates an NDEF record for the NFC tag with object path |object_path|
// using the parameters in |attributes|. |attributes| is a dictionary,
// containing the NFC Record properties which will be assigned to the
// resulting record object and written to the tag. The properties are defined
// by the NFC Record interface (see namespace "nfc_record" in
// third_party/cros_system_api/dbus/service_constants.h and
// NfcRecordClient::Properties). |attributes| should at least contain a
// "Type" plus any other properties associated with that type. For example:
//
// {
// "Type": "Text",
// "Encoding": "UTF-8",
// "Language": "en",
// "Representation": "Chrome OS rulez!"
// },
// {
// "Type": "URI",
// "URI": "http://www.chromium.org"
// },
// etc.
virtual void Write(
const dbus::ObjectPath& object_path,
const RecordAttributes& attributes,
const base::Closure& callback,
const nfc_client_helpers::ErrorCallback& error_callback) = 0;
// Creates the instance.
static NfcTagClient* Create(DBusClientImplementationType type,
NfcAdapterClient* adapter_client);
protected:
friend class NfcClientTest;
NfcTagClient();
private:
DISALLOW_COPY_AND_ASSIGN(NfcTagClient);
};
} // namespace chromeos
#endif // CHROMEOS_DBUS_NFC_TAG_CLIENT_H_
|
