Class ApiResponse<T>

Namespace

Cloudflare.NET.Core.Models

Assembly

Cloudflare.NET.dll

Represents the standard envelope for all Cloudflare API responses.

public sealed record ApiResponse<T> : IEquatable<ApiResponse<T>>

Type Parameters

T

The type of the 'result' payload.

Inheritance

object

ApiResponse<T>

Implements

IEquatable<ApiResponse<T>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ApiResponse(bool, IReadOnlyList<ApiError>, IReadOnlyList<ApiMessage>, T?, ResultInfo?, CursorResultInfo?)

Represents the standard envelope for all Cloudflare API responses.

public ApiResponse(bool Success, IReadOnlyList<ApiError> Errors, IReadOnlyList<ApiMessage> Messages, T? Result, ResultInfo? ResultInfo = null, CursorResultInfo? CursorResultInfo = null)

Parameters

Success bool

Errors IReadOnlyList<ApiError>

Messages IReadOnlyList<ApiMessage>

Result T

ResultInfo ResultInfo

CursorResultInfo CursorResultInfo

Properties

CursorResultInfo

[JsonPropertyName("cursor_result_info")]
public CursorResultInfo? CursorResultInfo { get; init; }

Property Value

CursorResultInfo

Errors

[JsonPropertyName("errors")]
public IReadOnlyList<ApiError> Errors { get; init; }

Property Value

IReadOnlyList<ApiError>

Messages

[JsonPropertyName("messages")]
public IReadOnlyList<ApiMessage> Messages { get; init; }

Property Value

IReadOnlyList<ApiMessage>

Result

[JsonPropertyName("result")]
public T? Result { get; init; }

Property Value

T

ResultInfo

[JsonPropertyName("result_info")]
public ResultInfo? ResultInfo { get; init; }

Property Value

ResultInfo

Success

[JsonPropertyName("success")]
public bool Success { get; init; }

Property Value

bool