mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
53 lines
1.4 KiB
C#
53 lines
1.4 KiB
C#
using System.Collections.Generic;
|
|
using System.Net;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A response from an API call that includes the deserialized object instance.
|
|
/// </summary>
|
|
public interface IApiResponse<out T>
|
|
{
|
|
/// <summary>
|
|
/// Object deserialized from the JSON response body.
|
|
/// </summary>
|
|
T Body { get; }
|
|
|
|
/// <summary>
|
|
/// The original non-deserialized http response.
|
|
/// </summary>
|
|
IResponse HttpResponse { get; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Represents a generic HTTP response
|
|
/// </summary>
|
|
public interface IResponse
|
|
{
|
|
/// <summary>
|
|
/// Raw response body. Typically a string, but when requesting images, or binary files, it will be a Stream.
|
|
/// </summary>
|
|
object Body { get; }
|
|
|
|
/// <summary>
|
|
/// Information about the API.
|
|
/// </summary>
|
|
IReadOnlyDictionary<string, string> Headers { get; }
|
|
|
|
/// <summary>
|
|
/// Information about the API response parsed from the response headers.
|
|
/// </summary>
|
|
ApiInfo ApiInfo { get; }
|
|
|
|
/// <summary>
|
|
/// The response status code.
|
|
/// </summary>
|
|
HttpStatusCode StatusCode { get; }
|
|
|
|
/// <summary>
|
|
/// The content type of the response.
|
|
/// </summary>
|
|
string ContentType { get; }
|
|
}
|
|
}
|