Class CRUDParam

Namespace

Glitch9.IO.Networking.RESTApi

public class CRUDParam

Inheritance

object

CRUDParam

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LogExtensions.LogIfNotSetInInspector<T>(T, string, string)

LogExtensions.LogIfNull<T>(T, string, string)

LogExtensions.LogIfSetInInspector<T>(T, string, string)

SystemExtensions.ToSenderName(object)

TypeExtensions.IsInteger(object)

Properties

Getter

Required if Type is set.

public Func<string> Getter { get; set; }

Property Value

Func<string>

HeaderFormat

Optional. If the API requires a specific header name instead of 'Bearer {0}', it will be set here.

public string HeaderFormat { get; set; }

Property Value

string

HeaderName

Optional. If the API requires a specific header name instead of 'Authorization', it will be set here.

public string HeaderName { get; set; }

Property Value

string

QueryKey

Required if Type is set to Query, or disregarded otherwise.

public string QueryKey { get; set; }

Property Value

string

Type

Required. Indicates how the API key should be sent.

public ParamType Type { get; set; }

Property Value

ParamType

Value

Either Value or Getter must be set.

Value is used if the API key is static.

public string Value { get; set; }

Property Value

string

Methods

GetValue()

public string GetValue()

Returns

string

Header(Func<string>, string, string)

public static CRUDParam Header(Func<string> getter, string headerName = null, string headerFormat = null)

Parameters

getter Func<string>

headerName string

headerFormat string

Returns

CRUDParam

Header(string, string, string)

public static CRUDParam Header(string value, string headerName = null, string headerFormat = null)

Parameters

value string

headerName string

headerFormat string

Returns

CRUDParam

Query(Func<string>, string)

public static CRUDParam Query(Func<string> getter, string queryKey = null)

Parameters

getter Func<string>

queryKey string

Returns

CRUDParam

Query(string, string)

public static CRUDParam Query(string value, string queryKey = null)

Parameters

value string

queryKey string

Returns

CRUDParam