Files
nearby/internal/platform/implementation/device_info.h
T
Francis Tsui 4301bc4fce Handle system standby
PiperOrigin-RevId: 949324299
2026-07-16 20:12:13 -07:00

106 lines
3.0 KiB
C++

// Copyright 2022 Google LLC
//
// 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
//
// https://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.
#ifndef PLATFORM_API_DEVICE_INFO_H_
#define PLATFORM_API_DEVICE_INFO_H_
#include <cstddef>
#include <cstdint>
#include <functional>
#include <optional>
#include <string>
#include "absl/strings/string_view.h"
#include "internal/base/file_path.h"
#include "internal/base/files.h"
namespace nearby {
namespace api {
class DeviceInfo {
public:
enum class ScreenStatus { kUndetermined = 0, kLocked, kUnlocked };
enum class DeviceType { kUnknown = 0, kPhone, kTablet, kLaptop };
enum class OsType {
kUnknown = 0,
kAndroid,
kChromeOs,
kIos,
kWindows,
kMacOS
};
enum class SuspendResumeEvent { kSuspend, kResume };
virtual ~DeviceInfo() = default;
// Gets device name.
virtual std::optional<std::string> GetOsDeviceName() const = 0;
virtual DeviceType GetDeviceType() const = 0;
virtual OsType GetOsType() const = 0;
// Gets known paths of current user.
virtual FilePath GetDownloadPath() const = 0;
virtual FilePath GetLocalAppDataPath(FilePath sub_path) const = 0;
virtual FilePath GetTemporaryPath() const = 0;
virtual FilePath GetLogPath() const = 0;
virtual std::optional<size_t> GetAvailableDiskSpaceInBytes(
const FilePath& path) const {
return Files::GetAvailableDiskSpaceInBytes(path);
};
// Monitor screen status
virtual bool IsScreenLocked() const = 0;
virtual void RegisterScreenLockedListener(
absl::string_view listener_name,
std::function<void(ScreenStatus)> callback) = 0;
virtual void UnregisterScreenLockedListener(
absl::string_view listener_name) = 0;
// Control device sleep
virtual bool PreventSleep() = 0;
virtual bool AllowSleep() = 0;
// Monitor suspend/resume events.
// Returns a listener id that can be used to unregister the listener.
virtual int64_t RegisterSuspendResumeListener(
std::function<void(SuspendResumeEvent)> callback) {
return 0;
}
virtual void UnregisterSuspendResumeListener(int64_t listener_id) {}
};
template <typename Sink>
void AbslStringify(Sink& sink, DeviceInfo::DeviceType device_type) {
switch (device_type) {
case DeviceInfo::DeviceType::kUnknown:
sink.Append("Unknown");
return;
case DeviceInfo::DeviceType::kPhone:
sink.Append("Phone");
return;
case DeviceInfo::DeviceType::kTablet:
sink.Append("Tablet");
return;
case DeviceInfo::DeviceType::kLaptop:
sink.Append("PC");
return;
}
}
} // namespace api
} // namespace nearby
#endif // PLATFORM_API_DEVICE_INFO_H_