Class BaseRestRequest

Represents a request sent over HTTP.

Inheritance

Object

BaseRestRequest

RestRequest

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: KSharpPlus.Net.Rest

Assembly: KSharpPlus.dll

Syntax

public abstract class BaseRestRequest

Properties

Headers

Gets the headers sent with this request.

Declaration

public IReadOnlyDictionary<string, string> Headers { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, String>

Kuracord

Declaration

protected BaseKuracordClient Kuracord { get; }

Property Value

Type	Description
BaseKuracordClient

Method

Gets the HTTP method used for this request.

Declaration

public RestRequestMethod Method { get; }

Property Value

Type	Description
RestRequestMethod

RequestTaskSource

Declaration

protected TaskCompletionSource<RestResponse> RequestTaskSource { get; }

Property Value

Type	Description
TaskCompletionSource<RestResponse>

Url

Gets the url to which this request is going to be made.

Declaration

public Uri Url { get; }

Property Value

Type	Description
Uri

Methods

SetCompleted(RestResponse)

Declaration

protected void SetCompleted(RestResponse response)

Parameters

Type	Name	Description
RestResponse	response

SetFaulted(Exception)

Declaration

protected void SetFaulted(Exception ex)

Parameters

Type	Name	Description
Exception	ex

TrySetFaulted(Exception)

Declaration

protected bool TrySetFaulted(Exception ex)

Parameters

Type	Name	Description
Exception	ex

Returns

Type	Description
Boolean

WaitForCompletionAsync()

Asynchronously waits for this request to complete.

Declaration

public Task<RestResponse> WaitForCompletionAsync()

Returns

Type	Description
Task<RestResponse>	HTTP response to this request.