Struct OpenIddictParameter

Namespace

OpenIddict.Abstractions

Assembly

OpenIddict.Abstractions.dll

Represents an OpenIddict parameter value, that can be either a primitive value, an array of strings or a complex JSON representation containing child nodes.

public readonly struct OpenIddictParameter : IEquatable<OpenIddictParameter>

Implements

IEquatable<OpenIddictParameter>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

OpenIddictParameter(bool)

Initializes a new parameter using the specified value.

public OpenIddictParameter(bool value)

Parameters

value bool

The parameter value.

OpenIddictParameter(long)

Initializes a new parameter using the specified value.

public OpenIddictParameter(long value)

Parameters

value long

The parameter value.

OpenIddictParameter(bool?)

Initializes a new parameter using the specified value.

public OpenIddictParameter(bool? value)

Parameters

value bool?

The parameter value.

OpenIddictParameter(long?)

Initializes a new parameter using the specified value.

public OpenIddictParameter(long? value)

Parameters

value long?

The parameter value.

OpenIddictParameter(string?)

Initializes a new parameter using the specified value.

public OpenIddictParameter(string? value)

Parameters

value string

The parameter value.

OpenIddictParameter(string?[]?)

Initializes a new parameter using the specified value.

public OpenIddictParameter(string?[]? value)

Parameters

value string[]

The parameter value.

OpenIddictParameter(JsonElement)

Initializes a new parameter using the specified value.

public OpenIddictParameter(JsonElement value)

Parameters

value JsonElement

The parameter value.

OpenIddictParameter(JsonNode?)

Initializes a new parameter using the specified value.

public OpenIddictParameter(JsonNode? value)

Parameters

value JsonNode

The parameter value.

Properties

Count

Gets the number of named or unnamed child items contained in the current parameter or 0 if the parameter doesn't represent an array of strings, a JSON array or a JSON object.

public int Count { get; }

Property Value

int

this[int]

Gets the child item corresponding to the specified index.

public OpenIddictParameter? this[int index] { get; }

Parameters

index int

The index of the child item.

Property Value

OpenIddictParameter?

An OpenIddictParameter instance containing the item value.

this[string]

Gets the child item corresponding to the specified name.

public OpenIddictParameter? this[string name] { get; }

Parameters

name string

The name of the child item.

Property Value

OpenIddictParameter?

An OpenIddictParameter instance containing the item value.

Value

Gets the associated value, that can be either a primitive CLR type (e.g bool, string, long), an array of strings or a complex JSON object.

public object? Value { get; }

Property Value

object

Methods

Equals(OpenIddictParameter)

Determines whether the current OpenIddictParameter instance is equal to the specified OpenIddictParameter.

public bool Equals(OpenIddictParameter other)

Parameters

other OpenIddictParameter

The other object to which to compare this instance.

Returns

bool

true if the two instances have both the same representation (e.g string) and value, false otherwise.

Equals(object?)

Determines whether the current OpenIddictParameter instance is equal to the specified object.

public override bool Equals(object? obj)

Parameters

obj object

The other object to which to compare this instance.

Returns

bool

true if the two instances have both the same representation (e.g string) and value, false otherwise.

GetHashCode()

Returns the hash code of the current OpenIddictParameter instance.

public override int GetHashCode()

Returns

int

The hash code for the current instance.

GetNamedParameter(string)

Gets the child item corresponding to the specified name.

public OpenIddictParameter? GetNamedParameter(string name)

Parameters

name string

The name of the child item.

Returns

OpenIddictParameter?

An OpenIddictParameter instance containing the item value.

GetNamedParameters()

Gets the named child items associated with the current parameter, if it represents a JSON object. Note: if the JSON object contains multiple parameters with the same name, only the last occurrence is returned.

public IReadOnlyDictionary<string, OpenIddictParameter> GetNamedParameters()

Returns

IReadOnlyDictionary<string, OpenIddictParameter>

A dictionary of all the parameters associated with the current instance.

GetUnnamedParameter(int)

Gets the child item corresponding to the specified index.

public OpenIddictParameter? GetUnnamedParameter(int index)

Parameters

index int

The index of the child item.

Returns

OpenIddictParameter?

An OpenIddictParameter instance containing the item value.

GetUnnamedParameters()

Gets the unnamed child items associated with the current parameter, if it represents an array of strings or a JSON array.

public IReadOnlyList<OpenIddictParameter> GetUnnamedParameters()

Returns

IReadOnlyList<OpenIddictParameter>

An enumeration of all the unnamed parameters associated with the current instance.

IsNullOrEmpty(OpenIddictParameter)

Determines whether a parameter is null or empty.

public static bool IsNullOrEmpty(OpenIddictParameter parameter)

Parameters

parameter OpenIddictParameter

The parameter.

Returns

bool

true if the parameter is null or empty, false otherwise.

ToString()

Returns the string representation of the current instance.

public override string? ToString()

Returns

string

The string representation associated with the parameter value.

TryGetNamedParameter(string, out OpenIddictParameter)

Tries to get the child item corresponding to the specified name.

public bool TryGetNamedParameter(string name, out OpenIddictParameter value)

Parameters

name string

The name of the child item.

value OpenIddictParameter

An OpenIddictParameter instance containing the item value.

Returns

bool

true if the parameter could be found, false otherwise.

TryGetUnnamedParameter(int, out OpenIddictParameter)

Tries to get the child item corresponding to the specified index.

public bool TryGetUnnamedParameter(int index, out OpenIddictParameter value)

Parameters

index int

The index of the child item.

value OpenIddictParameter

An OpenIddictParameter instance containing the item value.

Returns

bool

true if the parameter could be found, false otherwise.

WriteTo(Utf8JsonWriter)

Writes the parameter value to the specified JSON writer.

public void WriteTo(Utf8JsonWriter writer)

Parameters

writer Utf8JsonWriter

The UTF-8 JSON writer.

Operators

operator ==(OpenIddictParameter, OpenIddictParameter)

Determines whether two OpenIddictParameter instances are equal.

public static bool operator ==(OpenIddictParameter left, OpenIddictParameter right)

Parameters

left OpenIddictParameter

The first instance.

right OpenIddictParameter

The second instance.

Returns

bool

true if the two instances are equal, false otherwise.

explicit operator bool(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a boolean.

public static explicit operator bool(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

bool

The converted value.

explicit operator long(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a long integer.

public static explicit operator long(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

long

The converted value.

explicit operator bool?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a nullable boolean.

public static explicit operator bool?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

bool?

The converted value.

explicit operator long?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a nullable long integer.

public static explicit operator long?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

long?

The converted value.

explicit operator string?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a string.

public static explicit operator string?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

string

The converted value.

explicit operator string?[]?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to an array of strings.

public static explicit operator string?[]?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

string[]

The converted value.

explicit operator JsonElement(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a JsonElement.

public static explicit operator JsonElement(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

JsonElement

The converted value.

explicit operator JsonArray?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a JsonArray.

public static explicit operator JsonArray?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

JsonArray

The converted value.

explicit operator JsonNode?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a JsonNode.

public static explicit operator JsonNode?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

JsonNode

The converted value.

explicit operator JsonObject?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a JsonObject.

public static explicit operator JsonObject?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

JsonObject

The converted value.

explicit operator JsonValue?(OpenIddictParameter?)

Converts an OpenIddictParameter instance to a JsonValue.

public static explicit operator JsonValue?(OpenIddictParameter? parameter)

Parameters

parameter OpenIddictParameter?

The parameter to convert.

Returns

JsonValue

The converted value.

implicit operator OpenIddictParameter(bool)

Converts a boolean to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(bool value)

Parameters

value bool

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(long)

Converts a long integer to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(long value)

Parameters

value long

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(bool?)

Converts a nullable boolean to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(bool? value)

Parameters

value bool?

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(long?)

Converts a nullable long integer to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(long? value)

Parameters

value long?

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(string?)

Converts a string to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(string? value)

Parameters

value string

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(string?[]?)

Converts an array of strings to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(string?[]? value)

Parameters

value string[]

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(JsonElement)

Converts a JsonElement to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(JsonElement value)

Parameters

value JsonElement

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

implicit operator OpenIddictParameter(JsonNode?)

Converts a JsonNode to an OpenIddictParameter instance.

public static implicit operator OpenIddictParameter(JsonNode? value)

Parameters

value JsonNode

The value to convert

Returns

OpenIddictParameter

An OpenIddictParameter instance.

operator !=(OpenIddictParameter, OpenIddictParameter)

Determines whether two OpenIddictParameter instances are not equal.

public static bool operator !=(OpenIddictParameter left, OpenIddictParameter right)

Parameters

left OpenIddictParameter

The first instance.

right OpenIddictParameter

The second instance.

Returns

bool

true if the two instances are not equal, false otherwise.