2021-01-18 02:24:47 +08:00
<!DOCTYPE html>
<!-- [if IE]><![endif] -->
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge,chrome=1" >
< title > Class OpenIddictMessage
< / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class OpenIddictMessage
">
< meta name = "generator" content = "docfx 2.56.6.0" >
< link rel = "shortcut icon" href = "../images/favicon.ico" >
< link rel = "stylesheet" href = "../styles/docfx.vendor.css" >
< link rel = "stylesheet" href = "../styles/docfx.css" >
< link rel = "stylesheet" href = "../styles/main.css" >
< link href = "https://fonts.googleapis.com/css?family=Roboto" rel = "stylesheet" >
< meta property = "docfx:navrel" content = "../toc.html" >
< meta property = "docfx:tocrel" content = "toc.html" >
< / head > < body data-spy = "scroll" data-target = "#affix" data-offset = "120" >
< div id = "wrapper" >
< header >
< nav id = "autocollapse" class = "navbar navbar-inverse ng-scope" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#navbar" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../index.html" >
< img id = "logo" class = "svg" src = "../images/logo.png" alt = "" >
< / a > < / div >
< div class = "collapse navbar-collapse" id = "navbar" >
< form class = "navbar-form navbar-right" role = "search" id = "search" >
< div class = "form-group" >
< input type = "text" class = "form-control" id = "search-query" placeholder = "Search" autocomplete = "off" >
< / div >
< / form >
< / div >
< / div >
< / nav >
< div class = "subnav navbar navbar-default" >
< div class = "container hide-when-search" id = "breadcrumb" >
< ul class = "breadcrumb" >
< li > < / li >
< / ul >
< / div >
< / div >
< / header >
< div role = "main" class = "container body-content hide-when-search" >
< div class = "sidenav hide-when-search" >
< a class = "btn toc-toggle collapse" data-toggle = "collapse" href = "#sidetoggle" aria-expanded = "false" aria-controls = "sidetoggle" > Show / Hide Table of Contents< / a >
< div class = "sidetoggle collapse" id = "sidetoggle" >
< div id = "sidetoc" > < / div >
< / div >
< / div >
< div class = "article row grid-right" >
< div class = "col-md-10" >
< article class = "content wrap" id = "_content" data-uid = "OpenIddict.Abstractions.OpenIddictMessage" >
< h1 id = "OpenIddict_Abstractions_OpenIddictMessage" data-uid = "OpenIddict.Abstractions.OpenIddictMessage" class = "text-break" > Class OpenIddictMessage
< / h1 >
< div class = "markdown level0 summary" > < p > Represents an abstract OpenIddict message.< / p >
< / div >
< div class = "markdown level0 conceptual" > < / div >
< div class = "inheritance" >
< h5 > Inheritance< / h5 >
< div class = "level0" > < span class = "xref" > System.Object< / span > < / div >
< div class = "level1" > < span class = "xref" > OpenIddictMessage< / span > < / div >
< div class = "level2" > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictRequest.html" > OpenIddictRequest< / a > < / div >
< div class = "level2" > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictResponse.html" > OpenIddictResponse< / a > < / div >
< / div >
< div class = "inheritedMembers" >
< h5 > Inherited Members< / h5 >
< div >
< span class = "xref" > System.Object.Equals(System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.Equals(System.Object, System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetHashCode()< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetType()< / span >
< / div >
< div >
< span class = "xref" > System.Object.MemberwiseClone()< / span >
< / div >
< div >
< span class = "xref" > System.Object.ReferenceEquals(System.Object, System.Object)< / span >
< / div >
< / div >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "OpenIddict.Abstractions.html" > OpenIddict.Abstractions< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : cs.temp.dll.dll< / h6 >
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage_syntax" > Syntax< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public class OpenIddictMessage< / code > < / pre >
< / div >
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage_remarks" > < strong > Remarks< / strong > < / h5 >
< div class = "markdown level0 remarks" > < p > Security notice: developers instantiating this type are responsible of ensuring that the
imported parameters are safe and won' t cause the resulting message to grow abnormally,
which may result in an excessive memory consumption and a potential denial of service.< / p >
< / div >
< h3 id = "constructors" > Constructors
< / h3 >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor" > OpenIddictMessage()< / h4 >
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage()< / code > < / pre >
< / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
2021-01-24 16:39:56 +08:00
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_OpenIddict_Abstractions_OpenIddictParameter___" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor(IEnumerable{KeyValuePair{System.String,OpenIddict.Abstractions.OpenIddictParameter}})" > OpenIddictMessage(IEnumerable< KeyValuePair< String, OpenIddictParameter> > )< / h4 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2021-01-24 16:39:56 +08:00
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage(IEnumerable< KeyValuePair< string, OpenIddictParameter> > parameters)< / code > < / pre >
2021-01-18 02:24:47 +08:00
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > IEnumerable< / span > < < span class = "xref" > KeyValuePair< / span > < < span class = "xref" > System.String< / span > , < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > > < / td >
2021-01-18 02:24:47 +08:00
< td > < span class = "parametername" > parameters< / span > < / td >
< td > < p > The message parameters.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-01-24 16:39:56 +08:00
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_OpenIddict_Abstractions_OpenIddictParameter____remarks" > Remarks< / h5 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 remarks" > < p > Parameters with a null or empty key are always ignored.< / p >
< / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
2021-01-24 16:39:56 +08:00
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_StringValues___" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor(IEnumerable{KeyValuePair{System.String,StringValues}})" > OpenIddictMessage(IEnumerable< KeyValuePair< String, StringValues> > )< / h4 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2021-01-24 16:39:56 +08:00
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage(IEnumerable< KeyValuePair< string, StringValues> > parameters)< / code > < / pre >
2021-01-18 02:24:47 +08:00
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > IEnumerable< / span > < < span class = "xref" > KeyValuePair< / span > < < span class = "xref" > System.String< / span > , < span class = "xref" > StringValues< / span > > > < / td >
2021-01-18 02:24:47 +08:00
< td > < span class = "parametername" > parameters< / span > < / td >
< td > < p > The message parameters.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-01-24 16:39:56 +08:00
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_StringValues____remarks" > Remarks< / h5 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 remarks" > < p > Parameters with a null or empty key are always ignored.< / p >
< / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
2021-01-24 16:39:56 +08:00
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_System_String_____" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor(IEnumerable{KeyValuePair{System.String,System.String[]}})" > OpenIddictMessage(IEnumerable< KeyValuePair< String, String[]> > )< / h4 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2021-01-24 16:39:56 +08:00
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage(IEnumerable< KeyValuePair< string, string[]> > parameters)< / code > < / pre >
2021-01-18 02:24:47 +08:00
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > IEnumerable< / span > < < span class = "xref" > KeyValuePair< / span > < < span class = "xref" > System.String< / span > , < span class = "xref" > System.String< / span > []> > < / td >
2021-01-18 02:24:47 +08:00
< td > < span class = "parametername" > parameters< / span > < / td >
< td > < p > The message parameters.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-01-24 16:39:56 +08:00
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_System_String______remarks" > Remarks< / h5 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 remarks" > < p > Parameters with a null or empty key are always ignored.< / p >
< / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
2021-01-24 16:39:56 +08:00
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_System_String___" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor(IEnumerable{KeyValuePair{System.String,System.String}})" > OpenIddictMessage(IEnumerable< KeyValuePair< String, String> > )< / h4 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2021-01-24 16:39:56 +08:00
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage(IEnumerable< KeyValuePair< string, string> > parameters)< / code > < / pre >
2021-01-18 02:24:47 +08:00
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > IEnumerable< / span > < < span class = "xref" > KeyValuePair< / span > < < span class = "xref" > System.String< / span > , < span class = "xref" > System.String< / span > > > < / td >
2021-01-18 02:24:47 +08:00
< td > < span class = "parametername" > parameters< / span > < / td >
< td > < p > The message parameters.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-01-24 16:39:56 +08:00
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_IEnumerable_KeyValuePair_System_String_System_String____remarks" > Remarks< / h5 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 remarks" > < p > Parameters with a null or empty key are always ignored.< / p >
< / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor*" > < / a >
2021-01-24 16:39:56 +08:00
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_JsonElement_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.#ctor(JsonElement)" > OpenIddictMessage(JsonElement)< / h4 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 summary" > < p > Initializes a new OpenIddict message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
2021-01-24 16:39:56 +08:00
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage(JsonElement parameters)< / code > < / pre >
2021-01-18 02:24:47 +08:00
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > JsonElement< / span > < / td >
2021-01-18 02:24:47 +08:00
< td > < span class = "parametername" > parameters< / span > < / td >
< td > < p > The message parameters.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-01-24 16:39:56 +08:00
< h5 id = "OpenIddict_Abstractions_OpenIddictMessage__ctor_JsonElement__remarks" > Remarks< / h5 >
2021-01-18 02:24:47 +08:00
< div class = "markdown level1 remarks" > < p > Parameters with a null or empty key are always ignored.< / p >
< / div >
< h3 id = "properties" > Properties
< / h3 >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_Count_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Count*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_Count" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Count" > Count< / h4 >
< div class = "markdown level1 summary" > < p > Gets the number of parameters contained in the current message.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public int Count { get; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Int32< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_Item_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Item*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_Item_System_String_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Item(System.String)" > Item[String]< / h4 >
< div class = "markdown level1 summary" > < p > Gets or sets a parameter.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictParameter? this[string name] { get; set; }< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > < / td >
< td > < p > The parameter value.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_Parameters_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Parameters*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_Parameters" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.Parameters" > Parameters< / h4 >
< div class = "markdown level1 summary" > < p > Gets the dictionary containing the parameters.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > protected Dictionary< string, OpenIddictParameter> Parameters { get; }< / code > < / pre >
< / div >
< h5 class = "propertyValue" > Property Value< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Dictionary< / span > < < span class = "xref" > System.String< / span > , < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< h3 id = "methods" > Methods
< / h3 >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_AddParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.AddParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_AddParameter_System_String_OpenIddict_Abstractions_OpenIddictParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.AddParameter(System.String,OpenIddict.Abstractions.OpenIddictParameter)" > AddParameter(String, OpenIddictParameter)< / h4 >
< div class = "markdown level1 summary" > < p > Adds a parameter. Note: an exception is thrown if a parameter with the same name was already added.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage AddParameter(string name, OpenIddictParameter value)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< tr >
< td > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > < / td >
< td > < span class = "parametername" > value< / span > < / td >
< td > < p > The parameter value.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictMessage.html" > OpenIddictMessage< / a > < / td >
< td > < p > The current instance, which allows chaining calls.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_GetParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.GetParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_GetParameter_System_String_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.GetParameter(System.String)" > GetParameter(String)< / h4 >
< div class = "markdown level1 summary" > < p > Gets the value corresponding to a given parameter.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictParameter? GetParameter(string name)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > < / td >
< td > < p > The parameter value, or < code > null< / code > if it cannot be found.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_GetParameters_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.GetParameters*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_GetParameters" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.GetParameters" > GetParameters()< / h4 >
< div class = "markdown level1 summary" > < p > Gets all the parameters associated with this instance.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public IReadOnlyDictionary< string, OpenIddictParameter> GetParameters()< / code > < / pre >
< / div >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > IReadOnlyDictionary< / span > < < span class = "xref" > System.String< / span > , < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The parameters associated with this instance.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_HasParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.HasParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_HasParameter_System_String_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.HasParameter(System.String)" > HasParameter(String)< / h4 >
< div class = "markdown level1 summary" > < p > Determines whether the current message contains the specified parameter.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public bool HasParameter(string name)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Boolean< / span > < / td >
< td > < p > < code > true< / code > if the parameter is present, < code > false< / code > otherwise.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_RemoveParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.RemoveParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_RemoveParameter_System_String_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.RemoveParameter(System.String)" > RemoveParameter(String)< / h4 >
< div class = "markdown level1 summary" > < p > Removes a parameter.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage RemoveParameter(string name)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictMessage.html" > OpenIddictMessage< / a > < / td >
< td > < p > The current instance, which allows chaining calls.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_SetParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.SetParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_SetParameter_System_String_System_Nullable_OpenIddict_Abstractions_OpenIddictParameter__" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.SetParameter(System.String,System.Nullable{OpenIddict.Abstractions.OpenIddictParameter})" > SetParameter(String, Nullable< OpenIddictParameter> )< / h4 >
< div class = "markdown level1 summary" > < p > Adds, replaces or removes a parameter.
Note: this method automatically removes empty parameters.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictMessage SetParameter(string name, OpenIddictParameter? value)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > > < / td >
< td > < span class = "parametername" > value< / span > < / td >
< td > < p > The parameter value.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictMessage.html" > OpenIddictMessage< / a > < / td >
< td > < p > The current instance, which allows chaining calls.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_ToString_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.ToString*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_ToString" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.ToString" > ToString()< / h4 >
< div class = "markdown level1 summary" > < p > Returns a < span class = "xref" > System.String< / span > representation of the current instance that can be used in logs.
Note: sensitive parameters like client secrets are automatically removed for security reasons.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public override string ToString()< / code > < / pre >
< / div >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < p > The indented JSON representation corresponding to this message.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "overrides" > Overrides< / h5 >
< div > < span class = "xref" > System.Object.ToString()< / span > < / div >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_TryGetParameter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.TryGetParameter*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_TryGetParameter_System_String_OpenIddict_Abstractions_OpenIddictParameter__" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.TryGetParameter(System.String,OpenIddict.Abstractions.OpenIddictParameter@)" > TryGetParameter(String, out OpenIddictParameter)< / h4 >
< div class = "markdown level1 summary" > < p > Tries to get the value corresponding to a given parameter.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public bool TryGetParameter(string name, out OpenIddictParameter value)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > name< / span > < / td >
< td > < p > The parameter name.< / p >
< / td >
< / tr >
< tr >
< td > < a class = "xref" href = "OpenIddict.Abstractions.OpenIddictParameter.html" > OpenIddictParameter< / a > < / td >
< td > < span class = "parametername" > value< / span > < / td >
< td > < p > The parameter value.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Boolean< / span > < / td >
< td > < p > < code > true< / code > if the parameter could be found, < code > false< / code > otherwise.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Abstractions_OpenIddictMessage_WriteTo_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.WriteTo*" > < / a >
< h4 id = "OpenIddict_Abstractions_OpenIddictMessage_WriteTo_Utf8JsonWriter_" data-uid = "OpenIddict.Abstractions.OpenIddictMessage.WriteTo(Utf8JsonWriter)" > WriteTo(Utf8JsonWriter)< / h4 >
< div class = "markdown level1 summary" > < p > Writes the message to the specified JSON writer.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public void WriteTo(Utf8JsonWriter writer)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > Utf8JsonWriter< / span > < / td >
< td > < span class = "parametername" > writer< / span > < / td >
< td > < p > The UTF-8 JSON writer.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / article >
< / div >
< div class = "hidden-sm col-md-2" role = "complementary" >
< div class = "sideaffix" >
< div class = "contribution" >
< ul class = "nav" >
< / ul >
< / div >
< nav class = "bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id = "affix" >
< h5 > In This Article< / h5 >
< div > < / div >
< / nav >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "grad-bottom" > < / div >
< div class = "footer" >
< div class = "container" >
< span class = "pull-right" >
< a href = "#top" > Back to top< / a >
< / span >
< span > Generated by < strong > DocFX< / strong > < / span >
< / div >
< / div >
< / footer >
< / div >
< script type = "text/javascript" src = "../styles/docfx.vendor.js" > < / script >
< script type = "text/javascript" src = "../styles/docfx.js" > < / script >
< script type = "text/javascript" src = "../styles/main.js" > < / script >
< / body >
< / html >
