tno/api/net/Areas/Helpers/IWorkOrderHelper.cs at 404b7fbdc190913df1971628bb42a2fa1a72c221 · Fosol/tno · 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
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
using TNO.Core.Exceptions;

namespace TNO.API.Helpers;

/// <summary>
/// IWorkOrderHelper interface, provides methods to help with work orders.
/// </summary>
public interface IWorkOrderHelper
{
    /// <summary>
    /// Determine if the content should be auto transcribed.
    /// </summary>
    /// <param name="contentId"></param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    bool ShouldAutoTranscribe(long contentId);

    /// <summary>
    /// Determine if the content should perform FFmpeg actions.
    /// </summary>
    /// <param name="contentId"></param>
    /// <returns></returns>
    bool ShouldFFmpeg(long contentId);

    /// <summary>
    /// Request a transcript for the specified 'contentId'.
    /// Only allow one active transcript request.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestTranscriptionAsync(long contentId, bool force = false);

    /// <summary>
    /// Request a auto clip for the specified 'contentId'.
    /// Only allow one active auto clip request.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestAutoClipAsync(long contentId, bool force = false);

    /// <summary>
    /// Request a transcript for the specified 'contentId'.
    /// Only allow one active transcript request.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="requestor"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestTranscriptionAsync(long contentId, Entities.User requestor, bool force = false);

    /// <summary>
    /// Request a auto clip for the specified 'contentId'.
    /// Only allow one active auto clip request.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="requestor"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestAutoClipAsync(long contentId, Entities.User requestor, bool force = false);

    /// <summary>
    /// Request a natural language processing for the specified 'contentId'.
    /// Only allow one active nlp request.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestNLPAsync(long contentId, bool force = false);

    /// <summary>
    /// Request a FFmpeg for the specified 'contentId'.
    /// </summary>
    /// <param name="contentId"></param>
    /// <param name="force">Whether to force a request regardless of the prior requests state</param>
    /// <returns></returns>
    /// <exception cref="NoContentException"></exception>
    /// <exception cref="ConfigurationException"></exception>
    /// <exception cref="NotAuthorizedException"></exception>
    Task<Entities.WorkOrder> RequestFFmpegAsync(long contentId, bool force = false);
}