IApiClient.cs

Go to the documentation of this file.

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.AspNetCore.SignalR.Client;
using Microsoft.Extensions.Logging;
 
using Tgstation.Server.Api;
using Tgstation.Server.Api.Models;
using Tgstation.Server.Api.Models.Response;
 
namespace Tgstation.Server.Client
{
    interface IApiClient : IAsyncDisposable
    {
        ApiHeaders Headers { get; set; }
 
        Uri Url { get; }
 
        TimeSpan Timeout { get; set; }
 
        void AddRequestLogger(IRequestLogger requestLogger);
 
        ValueTask<IAsyncDisposable> CreateHubConnection<THubImplementation>(
            THubImplementation hubImplementation,
            IRetryPolicy? retryPolicy,
            Action<ILoggingBuilder>? loggingConfigureAction,
            CancellationToken cancellationToken)
            where THubImplementation : class;
 
        ValueTask<TResult> Create<TBody, TResult>(string route, TBody body, CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask<TResult> Create<TResult>(string route, CancellationToken cancellationToken);
 
        ValueTask<TResult> Read<TResult>(string route, CancellationToken cancellationToken);
 
        ValueTask<TResult> Update<TBody, TResult>(string route, TBody body, CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask<TResult> Update<TResult>(string route, CancellationToken cancellationToken);
 
        ValueTask Update<TBody>(string route, TBody body, CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask Patch(string route, CancellationToken cancellationToken);
 
        ValueTask Delete(string route, CancellationToken cancellationToken);
 
        ValueTask<TResult> Create<TBody, TResult>(
            string route,
            TBody body,
            long instanceId,
            CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask<TResult> Create<TResult>(string route, long instanceId, CancellationToken cancellationToken);
 
        ValueTask<TResult> Patch<TResult>(string route, long instanceId, CancellationToken cancellationToken);
 
        ValueTask<TResult> Read<TResult>(string route, long instanceId, CancellationToken cancellationToken);
 
        ValueTask<TResult> Update<TBody, TResult>(
            string route,
            TBody body,
            long instanceId,
            CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask Delete(string route, long instanceId, CancellationToken cancellationToken);
 
        ValueTask Delete<TBody>(string route, TBody body, long instanceId, CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask<TResult> Delete<TResult>(string route, long instanceId, CancellationToken cancellationToken);
 
        ValueTask<TResult> Delete<TBody, TResult>(string route, TBody body, long instanceId, CancellationToken cancellationToken)
            where TBody : class;
 
        ValueTask<Stream> Download(FileTicketResponse ticket, CancellationToken cancellationToken);
 
        ValueTask Upload(FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken);
    }
}