MediaBrowser.Controller/Devices/IDeviceManager.cs


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

using System;
using System.Threading.Tasks;
using Jellyfin.Data.Dtos;
using Jellyfin.Data.Events;
using Jellyfin.Data.Queries;
using Jellyfin.Database.Implementations.Entities;
using Jellyfin.Database.Implementations.Entities.Security;
using MediaBrowser.Model.Devices;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Querying;
using MediaBrowser.Model.Session;

namespace MediaBrowser.Controller.Devices;

/// <summary>
/// Device manager interface.
/// </summary>
public interface IDeviceManager
{
    /// <summary>
    /// Event handler for updated device options.
    /// </summary>
    event EventHandler<GenericEventArgs<Tuple<string, DeviceOptions>>> DeviceOptionsUpdated;

    /// <summary>
    /// Creates a new device.
    /// </summary>
    /// <param name="device">The device to create.</param>
    /// <returns>A <see cref="Task{Device}"/> representing the creation of the device.</returns>
    Task<Device> CreateDevice(Device device);

    /// <summary>
    /// Saves the capabilities.
    /// </summary>
    /// <param name="deviceId">The device id.</param>
    /// <param name="capabilities">The capabilities.</param>
    void SaveCapabilities(string deviceId, ClientCapabilities capabilities);

    /// <summary>
    /// Gets the capabilities.
    /// </summary>
    /// <param name="deviceId">The device id.</param>
    /// <returns>ClientCapabilities.</returns>
    ClientCapabilities GetCapabilities(string? deviceId);

    /// <summary>
    /// Gets the device information.
    /// </summary>
    /// <param name="id">The identifier.</param>
    /// <returns>DeviceInfoDto.</returns>
    DeviceInfoDto? GetDevice(string id);

    /// <summary>
    /// Gets devices based on the provided query.
    /// </summary>
    /// <param name="query">The device query.</param>
    /// <returns>A <see cref="Task{QueryResult}"/> representing the retrieval of the devices.</returns>
    QueryResult<Device> GetDevices(DeviceQuery query);

    /// <summary>
    /// Gets device information based on the provided query.
    /// </summary>
    /// <param name="query">The device query.</param>
    /// <returns>A <see cref="Task{QueryResult}"/> representing the retrieval of the device information.</returns>
    QueryResult<DeviceInfo> GetDeviceInfos(DeviceQuery query);

    /// <summary>
    /// Gets the device information.
    /// </summary>
    /// <param name="userId">The user's id, or <c>null</c>.</param>
    /// <returns>IEnumerable&lt;DeviceInfoDto&gt;.</returns>
    QueryResult<DeviceInfoDto> GetDevicesForUser(Guid? userId);

    /// <summary>
    /// Deletes a device.
    /// </summary>
    /// <param name="device">The device.</param>
    /// <returns>A <see cref="Task"/> representing the deletion of the device.</returns>
    Task DeleteDevice(Device device);

    /// <summary>
    /// Updates a device.
    /// </summary>
    /// <param name="device">The device.</param>
    /// <returns>A <see cref="Task"/> representing the update of the device.</returns>
    Task UpdateDevice(Device device);

    /// <summary>
    /// Determines whether this instance [can access device] the specified user identifier.
    /// </summary>
    /// <param name="user">The user to test.</param>
    /// <param name="deviceId">The device id to test.</param>
    /// <returns>Whether the user can access the device.</returns>
    bool CanAccessDevice(User user, string deviceId);

    /// <summary>
    /// Updates the options of a device.
    /// </summary>
    /// <param name="deviceId">The device id.</param>
    /// <param name="deviceName">The device name.</param>
    /// <returns>A <see cref="Task"/> representing the update of the device options.</returns>
    Task UpdateDeviceOptions(string deviceId, string? deviceName);

    /// <summary>
    /// Gets the options of a device.
    /// </summary>
    /// <param name="deviceId">The device id.</param>
    /// <returns><see cref="DeviceOptions"/> of the device.</returns>
    DeviceOptionsDto? GetDeviceOptions(string deviceId);

    /// <summary>
    /// Gets the dto for client capabilities.
    /// </summary>
    /// <param name="capabilities">The client capabilities.</param>
    /// <returns><see cref="ClientCapabilitiesDto"/> of the device.</returns>
    ClientCapabilitiesDto ToClientCapabilitiesDto(ClientCapabilities capabilities);
}