Tgstation.Server.Client.RateLimitException Class Reference

Occurs when a GitHub rate limit occurs. More...

Inheritance diagram for Tgstation.Server.Client.RateLimitException:

Collaboration diagram for Tgstation.Server.Client.RateLimitException:

Public Member Functions
	RateLimitException (ErrorMessageResponse? errorMessage, HttpResponseMessage responseMessage)
	Initializes a new instance of the RateLimitException class.
	RateLimitException ()
	Initializes a new instance of the RateLimitException class.
	RateLimitException (string message)
	Initializes a new instance of the RateLimitException class.
	RateLimitException (string message, Exception innerException)
	Initializes a new instance of the RateLimitException class.

Properties
DateTimeOffset?	RetryAfter [get]
	Gets the DateTimeOffset to try the request again after.
Properties inherited from Tgstation.Server.Client.ApiException
Version?	ServerApiVersion [get]
	The Version of the server's API.
string?	AdditionalServerData [get]
	Additional error data from the server.
ErrorCode?	ErrorCode [get]
	The API ErrorCode if applicable.
Properties inherited from Tgstation.Server.Client.ClientException
HttpResponseMessage?	ResponseMessage [get]
	The HttpStatusCode of the ClientException.

Additional Inherited Members
Protected Member Functions inherited from Tgstation.Server.Client.ApiException
	ApiException (ErrorMessageResponse? errorMessage, HttpResponseMessage responseMessage)
	Initializes a new instance of the ApiException class.
	ApiException (HttpResponseMessage responseMessage, string message)
	Initializes a new instance of the ApiException class.
	ApiException ()
	Initializes a new instance of the ApiException class.
	ApiException (string message)
	Initializes a new instance of the ApiException class.
	ApiException (string message, Exception innerException)
	Initializes a new instance of the ApiException class.
Protected Member Functions inherited from Tgstation.Server.Client.ClientException
	ClientException (HttpResponseMessage responseMessage, string message)
	Initializes a new instance of the ClientException class.
	ClientException ()
	Initializes a new instance of the ClientException class.
	ClientException (string message)
	Initializes a new instance of the ClientException class.
	ClientException (string message, Exception innerException)
	Initializes a new instance of the ClientException class.

Detailed Description

Occurs when a GitHub rate limit occurs.

Definition at line 14 of file RateLimitException.cs.

Constructor & Destructor Documentation

RateLimitException() [1/4]

Tgstation.Server.Client.RateLimitException.RateLimitException	(	ErrorMessageResponse?	errorMessage,
		HttpResponseMessage	responseMessage
	)

Initializes a new instance of the RateLimitException class.

Parameters

errorMessage	The ErrorMessageResponse for the ApiException.
responseMessage	The HttpResponseMessage for the ClientException.

Definition at line 26 of file RateLimitException.cs.

            : base(errorMessage, responseMessage)
        {
            if (responseMessage == null)
                throw new ArgumentNullException(nameof(responseMessage));
 
            if (!responseMessage.Headers.TryGetValues(HeaderNames.RetryAfter, out var values))
                return;
 
            var secondsString = values.FirstOrDefault();
            if (UInt32.TryParse(secondsString, out var seconds))
                RetryAfter = DateTimeOffset.UtcNow.AddSeconds(seconds);
        }

References Tgstation.Server.Client.RateLimitException.RetryAfter.

RateLimitException() [2/4]

Tgstation.Server.Client.RateLimitException.RateLimitException

(

)

Initializes a new instance of the RateLimitException class.

Definition at line 43 of file RateLimitException.cs.

        {
        }

RateLimitException() [3/4]

Tgstation.Server.Client.RateLimitException.RateLimitException

(

string

message

)

Initializes a new instance of the RateLimitException class.

Parameters

message

The message for the Exception.

Definition at line 51 of file RateLimitException.cs.

            : base(message)
        {
        }

RateLimitException() [4/4]

Tgstation.Server.Client.RateLimitException.RateLimitException	(	string	message,
		Exception	innerException
	)

Initializes a new instance of the RateLimitException class.

Parameters

message	The message for the Exception.
innerException	The inner Exception for the base Exception.

Definition at line 61 of file RateLimitException.cs.

            : base(message, innerException)
        {
        }

Property Documentation

RetryAfter

DateTimeOffset? Tgstation.Server.Client.RateLimitException.RetryAfter

get

Gets the DateTimeOffset to try the request again after.

Definition at line 19 of file RateLimitException.cs.

{ get; }

Referenced by Tgstation.Server.Client.RateLimitException.RateLimitException().

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Client/RateLimitException.cs