aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/ActivityLogController.cs
blob: 8d37a83738d84b3544a5ebd6db5ccbe523d69832 (plain)
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
using System;
using System.Globalization;
using Jellyfin.Api.Constants;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Querying;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Jellyfin.Api.Controllers
{
    /// <summary>
    /// Activity log controller.
    /// </summary>
    [Route("/System/ActivityLog")]
    [Authorize(Policy = Policies.RequiresElevation)]
    public class ActivityLogController : BaseJellyfinApiController
    {
        private readonly IActivityManager _activityManager;

        /// <summary>
        /// Initializes a new instance of the <see cref="ActivityLogController"/> class.
        /// </summary>
        /// <param name="activityManager">Instance of <see cref="IActivityManager"/> interface.</param>
        public ActivityLogController(IActivityManager activityManager)
        {
            _activityManager = activityManager;
        }

        /// <summary>
        /// Gets activity log entries.
        /// </summary>
        /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
        /// <param name="limit">Optional. The maximum number of records to return.</param>
        /// <param name="minDate">Optional. The minimum date. Format = ISO.</param>
        /// <param name="hasUserId">Optional. Only returns activities that have a user associated.</param>
        /// <response code="200">Activity log returned.</response>
        /// <returns>A <see cref="QueryResult{ActivityLogEntry}"/> containing the log entries.</returns>
        [HttpGet("Entries")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        public ActionResult<QueryResult<ActivityLogEntry>> GetLogEntries(
            [FromQuery] int? startIndex,
            [FromQuery] int? limit,
            [FromQuery] DateTime? minDate,
            bool? hasUserId)
        {
            return _activityManager.GetActivityLogEntries(minDate, hasUserId, startIndex, limit);
        }
    }
}