Show / Hide Table of Contents

Class APIResponse<T>

Represents the response of an Api interaction with R6Stats API

Inheritance
System.Object
APIResponse<T>
Namespace: R6Stats.Response
Assembly: R6Stat-Sharp.dll
Syntax
public sealed class APIResponse<T> : object where T : class, IPayload
Type Parameters
Name Description
T

Properties

| Improve this Doc View Source

Error

Error message for the response if the Status is not "OK"

Declaration
public string Error { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsSuccessful

Whether the Api interaction was successful or not

Declaration
public bool IsSuccessful { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Payload

Data returned by the Api if the interaction was successful

Declaration
public T Payload { get; }
Property Value
Type Description
T
| Improve this Doc View Source

Status

Status of the Api response

Declaration
public string Status { get; }
Property Value
Type Description
System.String
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX