Class RequestParameter

Inheritance
object
RequestParameter
HeaderParameter
MethodParameter
PathParameter
QueryParameter
Inherited Members
Namespace: Glitch9.IO.Networking.RESTApi
Assembly: Glitch9.IO.dll
Syntax
public abstract class RequestParameter

Constructors

| Edit this page View Source

RequestParameter(string, string, RequestParameterProvider, bool)

Declaration
protected RequestParameter(string key, string value, RequestParameterProvider provider, bool sensitive = false)
Parameters
Type Name Description
string key
string value
RequestParameterProvider provider
bool sensitive

Fields

| Edit this page View Source

ApiKey

Declaration
public const string ApiKey = "api_key"
Field Value
Type Description
string
| Edit this page View Source

BetaVersion

Declaration
public const string BetaVersion = "beta_version"
Field Value
Type Description
string
| Edit this page View Source

Version

Declaration
public const string Version = "version"
Field Value
Type Description
string
| Edit this page View Source

VersionToken

Declaration
public const string VersionToken = "VERSION"
Field Value
Type Description
string

Properties

| Edit this page View Source

IsSensitive

Declaration
public virtual bool IsSensitive { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Key

Declaration
public virtual string Key { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Provider

Required if Value is not set. A function that provides the value at runtime.

Declaration
public RequestParameterProvider Provider { get; set; }
Property Value
Type Description
RequestParameterProvider
| Edit this page View Source

Type

Declaration
public RequestParameterType Type { get; }
Property Value
Type Description
RequestParameterType
| Edit this page View Source

Value

Declaration
public virtual string Value { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

Bearer(Func<string, string>)

Declaration
public static RequestParameter Bearer(Func<string, string> rawProvider)
Parameters
Type Name Description
Func<string, string> rawProvider
Returns
Type Description
RequestParameter
| Edit this page View Source

Bearer(string)

Declaration
public static RequestParameter Bearer(string value)
Parameters
Type Name Description
string value
Returns
Type Description
RequestParameter
| Edit this page View Source

GetLogValue()

Declaration
public string GetLogValue()
Returns
Type Description
string
| Edit this page View Source

GetValue(string)

Declaration
public string GetValue(string arg = null)
Parameters
Type Name Description
string arg
Returns
Type Description
string
| Edit this page View Source

Header(string, RequestParameterProvider, bool)

Declaration
public static RequestParameter Header(string key, RequestParameterProvider provider, bool sensitive = false)
Parameters
Type Name Description
string key
RequestParameterProvider provider
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Header(string, Func<string, string>, bool)

Declaration
public static RequestParameter Header(string key, Func<string, string> rawProvider, bool sensitive = false)
Parameters
Type Name Description
string key
Func<string, string> rawProvider
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Header(string, string, bool)

Declaration
public static RequestParameter Header(string key, string value, bool sensitive = false)
Parameters
Type Name Description
string key
string value
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

IsValid()

Declaration
public virtual bool IsValid()
Returns
Type Description
bool
| Edit this page View Source

Method(string)

Creates a parameter specifying a method type or request operation.

Example:
:GET, :POST, :DELETE, etc.

Declaration
public static RequestParameter Method(string method)
Parameters
Type Name Description
string method
Returns
Type Description
RequestParameter
| Edit this page View Source

OverrideValue(string)

Declaration
public string OverrideValue(string value)
Parameters
Type Name Description
string value
Returns
Type Description
string
| Edit this page View Source

Path(string, RequestParameterProvider, bool)

Declaration
public static RequestParameter Path(string key, RequestParameterProvider provider, bool sensitive = false)
Parameters
Type Name Description
string key
RequestParameterProvider provider
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Path(string, Func<string, string>, bool)

Declaration
public static RequestParameter Path(string key, Func<string, string> rawProvider, bool sensitive = false)
Parameters
Type Name Description
string key
Func<string, string> rawProvider
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Path(string, string, bool)

Creates a path parameter with the specified key and value.
Example: /{key}

Declaration
public static RequestParameter Path(string key, string value, bool sensitive = false)
Parameters
Type Name Description
string key
string value
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Query(string, RequestParameterProvider, bool)

Declaration
public static RequestParameter Query(string key, RequestParameterProvider provider, bool sensitive = false)
Parameters
Type Name Description
string key
RequestParameterProvider provider
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

Query(string, string, bool)

Creates a query parameter with the specified key and value.
Example: ?type=json

Declaration
public static RequestParameter Query(string key, string value, bool sensitive = false)
Parameters
Type Name Description
string key
string value
bool sensitive
Returns
Type Description
RequestParameter
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

VersionPath(Func<string, string>)

Declaration
public static RequestParameter VersionPath(Func<string, string> rawProvider)
Parameters
Type Name Description
Func<string, string> rawProvider
Returns
Type Description
RequestParameter
| Edit this page View Source

XApiKey(Func<string, string>)

Declaration
public static RequestParameter XApiKey(Func<string, string> rawProvider)
Parameters
Type Name Description
Func<string, string> rawProvider
Returns
Type Description
RequestParameter
| Edit this page View Source

XiApiKey(Func<string, string>)

Declaration
public static RequestParameter XiApiKey(Func<string, string> rawProvider)
Parameters
Type Name Description
Func<string, string> rawProvider
Returns
Type Description
RequestParameter

Extension Methods