aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/LocalizationController.cs
blob: b9772a06930b68cf179aa437ef953913fdaa1f40 (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
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
using System.Collections.Generic;
using Jellyfin.Api.Constants;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Globalization;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Jellyfin.Api.Controllers;

/// <summary>
/// Localization controller.
/// </summary>
[Authorize(Policy = Policies.FirstTimeSetupOrDefault)]
public class LocalizationController : BaseJellyfinApiController
{
    private readonly ILocalizationManager _localization;

    /// <summary>
    /// Initializes a new instance of the <see cref="LocalizationController"/> class.
    /// </summary>
    /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param>
    public LocalizationController(ILocalizationManager localization)
    {
        _localization = localization;
    }

    /// <summary>
    /// Gets known cultures.
    /// </summary>
    /// <response code="200">Known cultures returned.</response>
    /// <returns>An <see cref="OkResult"/> containing the list of cultures.</returns>
    [HttpGet("Cultures")]
    [ProducesResponseType(StatusCodes.Status200OK)]
    public ActionResult<IEnumerable<CultureDto>> GetCultures()
    {
        return Ok(_localization.GetCultures());
    }

    /// <summary>
    /// Gets known countries.
    /// </summary>
    /// <response code="200">Known countries returned.</response>
    /// <returns>An <see cref="OkResult"/> containing the list of countries.</returns>
    [HttpGet("Countries")]
    [ProducesResponseType(StatusCodes.Status200OK)]
    public ActionResult<IEnumerable<CountryInfo>> GetCountries()
    {
        return Ok(_localization.GetCountries());
    }

    /// <summary>
    /// Gets known parental ratings.
    /// </summary>
    /// <response code="200">Known parental ratings returned.</response>
    /// <returns>An <see cref="OkResult"/> containing the list of parental ratings.</returns>
    [HttpGet("ParentalRatings")]
    [ProducesResponseType(StatusCodes.Status200OK)]
    public ActionResult<IEnumerable<ParentalRating>> GetParentalRatings()
    {
        return Ok(_localization.GetParentalRatings());
    }

    /// <summary>
    /// Gets localization options.
    /// </summary>
    /// <response code="200">Localization options returned.</response>
    /// <returns>An <see cref="OkResult"/> containing the list of localization options.</returns>
    [HttpGet("Options")]
    [ProducesResponseType(StatusCodes.Status200OK)]
    public ActionResult<IEnumerable<LocalizationOption>> GetLocalizationOptions()
    {
        return Ok(_localization.GetLocalizationOptions());
    }
}