cpp_client_telemetry/lib/include/mat/IDeviceInformation.hpp at 8fd88df4fc0277e721c1c7cf97087a111c9b92be · microsoft/cpp_client_telemetry · GitHub

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
//
// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
#ifndef IDEVICEINFORMATION_HPP
#define IDEVICEINFORMATION_HPP

#include "pal/PAL.hpp"

#include "Enums.hpp"
#include "IInformationProvider.hpp"

#include <string>

// Property Name
#define STORAGE_SIZE "StorageSize"
#define POWER_SOURCE "PowerSource"

using namespace MAT;

namespace PAL_NS_BEGIN {

    class IDeviceInformation : public IInformationProvider
    {
    public:

        virtual ~IDeviceInformation() {}

        /// <summary>
        /// Gets the unique ID of the current device
        /// </summary>
        /// <returns>The unique ID of the current device</returns>
        virtual std::string const& GetDeviceId() const = 0;

        /// <summary>
        /// Gets the manufacturer of the current device
        /// </summary>
        /// <returns>The manufacturer of the current device</returns>
        virtual std::string const& GetManufacturer() const = 0;

        /// <summary>
        /// Gets the model of the current device
        /// </summary>
        /// <returns>The model of the current device</returns>
        virtual std::string const& GetModel() const = 0;

        /// <summary>
        /// The OS achitecture type, such as "x86" or "x64".
        /// </summary>
        /// <returns>OS architecture</returns>
        virtual OsArchitectureType GetOsArchitectureType() const = 0;

        /// <summary>
        /// Gets the power source the device is currently using.
        /// </summary>
        /// <returns>Source of power the device is using</returns>
        virtual PowerSource GetPowerSource() const = 0;

        /// <summary>
        /// Gets the device ticket.
        /// </summary>
        /// <returns>Device ticket</returns>
        virtual std::string GetDeviceTicket() const = 0;
    };

} PAL_NS_END

#endif