Tools/dotnetcli/sdk/NuGetFallbackFolder/microsoft.identitymodel.protocols/2.1.4/lib/netstandard1.4/Microsoft.IdentityModel.Protocols.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Microsoft.IdentityModel.Protocols</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage">
   8             <summary>
   9             base class for authentication protocol messages.
  10             </summary>
  11         </member>
  12         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.#ctor">
  13             <summary>
  14             Initializes a default instance of the <see cref="T:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage"/> class.
  15             </summary>
  16         </member>
  17         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.BuildFormPost">
  18             <summary>
  19             Builds a form post using the current IssuerAddress and the parameters that have been set.
  20             </summary>
  21             <returns>html with head set to 'Title', body containing a hiden from with action = IssuerAddress.</returns>
  22         </member>
  23         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.BuildRedirectUrl">
  24             <summary>
  25             Builds a Url using the current IssuerAddress and the parameters that have been set.
  26             </summary>
  27             <returns>UrlEncoded string.</returns>
  28             <remarks>Each parameter &lt;Key, Value&gt; is first transformed using <see cref="M:System.Uri.EscapeDataString(System.String)"/>.</remarks>
  29         </member>
  30         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.GetParameter(System.String)">
  31             <summary>
  32             Returns a parameter.
  33             </summary>
  34             <param name="parameter">The parameter name.</param>
  35             <returns>The value of the parameter or null if the parameter does not exists.</returns>
  36             <exception cref="T:System.ArgumentNullException">If parameter is null</exception>
  37         </member>
  38         <member name="P:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.IssuerAddress">
  39             <summary>
  40             Gets or sets the issuer address.
  41             </summary>
  42             <exception cref="T:System.ArgumentNullException">If the 'value' is null.</exception>
  43         </member>
  44         <member name="P:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.Parameters">
  45             <summary>
  46             Gets the message parameters as a Dictionary.
  47             </summary>
  48         </member>
  49         <member name="P:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.PostTitle">
  50             <summary>
  51             Gets or sets the title used when constructing the post string.
  52             </summary>
  53             <exception cref="T:System.ArgumentNullException">If the 'value' is null.</exception>
  54         </member>
  55         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.RemoveParameter(System.String)">
  56             <summary>
  57             Removes a parameter.
  58             </summary>
  59             <param name="parameter">The parameter name.</param>
  60             <exception cref="T:System.ArgumentNullException">If 'parameter' is null or empty.</exception>
  61         </member>
  62         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.SetParameter(System.String,System.String)">
  63             <summary>
  64             Sets a parameter to the Parameters Dictionary.
  65             </summary>
  66             <param name="parameter">The parameter name.</param>
  67             <param name="value">The value to be assigned to parameter.</param>
  68             <exception cref="T:System.ArgumentNullException">If 'parameterName' is null or empty.</exception>
  69             <remarks>If null is passed as value and the parameter exists, that parameter is removed.</remarks>
  70         </member>
  71         <member name="M:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.SetParameters(System.Collections.Specialized.NameValueCollection)">
  72             <summary>
  73             Sets a collection parameters.
  74             </summary>
  75             <param name="nameValueCollection"></param>
  76         </member>
  77         <member name="P:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.ScriptButtonText">
  78             <summary>
  79             Gets or sets the script button text used when constructing the post string.
  80             </summary>
  81             <exception cref="T:System.ArgumentNullException">If the 'value' is null.</exception>
  82         </member>
  83         <member name="P:Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage.ScriptDisabledText">
  84             <summary>
  85             Gets or sets the text used when constructing the post string that will be displayed to used if script is disabled.
  86             </summary>
  87             <exception cref="T:System.ArgumentNullException">If the 'value' is null.</exception>
  88         </member>
  89         <member name="T:Microsoft.IdentityModel.Protocols.LogMessages">
  90             <summary>
  91             Log messages and codes
  92             </summary>
  93         </member>
  94         <member name="T:Microsoft.IdentityModel.Protocols.X509CertificateValidationMode">
  95             <summary>
  96             Represents X509Certificate validation mode.
  97             </summary>
  98         </member>
  99         <member name="T:Microsoft.IdentityModel.Protocols.ConfigurationManager`1">
 100             <summary>
 101             Manages the retrieval of Configuration data.
 102             </summary>
 103             <typeparam name="T">The type of <see cref="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever"/>.</typeparam>
 104         </member>
 105         <member name="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultAutomaticRefreshInterval">
 106             <summary>
 107             1 day is the default time interval that afterwards, <see cref="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.GetConfigurationAsync"/> will obtain new configuration.
 108             </summary>
 109         </member>
 110         <member name="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultRefreshInterval">
 111             <summary>
 112             30 seconds is the default time interval that must pass for <see cref="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RequestRefresh"/> to obtain a new configuration.
 113             </summary>
 114         </member>
 115         <member name="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.MinimumAutomaticRefreshInterval">
 116             <summary>
 117             5 minutes is the minimum value for automatic refresh. <see cref="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.AutomaticRefreshInterval"/> can not be set less than this value.
 118             </summary>
 119         </member>
 120         <member name="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.MinimumRefreshInterval">
 121             <summary>
 122             1 second is the minimum time interval that must pass for <see cref="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RequestRefresh"/> to obtain new configuration.
 123             </summary>
 124         </member>
 125         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.#cctor">
 126             <summary>
 127             Static initializer for a new object. Static initializers run before the first instance of the type is created.
 128             </summary>
 129         </member>
 130         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.#ctor(System.String,Microsoft.IdentityModel.Protocols.IConfigurationRetriever{`0})">
 131             <summary>
 132             Instantiaties a new <see cref="T:Microsoft.IdentityModel.Protocols.ConfigurationManager`1"/> that manages automatic and controls refreshing on configuration data.
 133             </summary>
 134             <param name="metadataAddress">The address to obtain configuration.</param>
 135             <param name="configRetriever">The <see cref="T:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1"/></param>
 136         </member>
 137         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.#ctor(System.String,Microsoft.IdentityModel.Protocols.IConfigurationRetriever{`0},System.Net.Http.HttpClient)">
 138             <summary>
 139             Instantiaties a new <see cref="T:Microsoft.IdentityModel.Protocols.ConfigurationManager`1"/> that manages automatic and controls refreshing on configuration data.
 140             </summary>
 141             <param name="metadataAddress">The address to obtain configuration.</param>
 142             <param name="configRetriever">The <see cref="T:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1"/></param>
 143             <param name="httpClient">The client to use when obtaining configuration.</param>
 144         </member>
 145         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.#ctor(System.String,Microsoft.IdentityModel.Protocols.IConfigurationRetriever{`0},Microsoft.IdentityModel.Protocols.IDocumentRetriever)">
 146             <summary>
 147             Instantiaties a new <see cref="T:Microsoft.IdentityModel.Protocols.ConfigurationManager`1"/> that manages automatic and controls refreshing on configuration data.
 148             </summary>
 149             <param name="metadataAddress">The address to obtain configuration.</param>
 150             <param name="configRetriever">The <see cref="T:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1"/></param>
 151             <param name="docRetriever">The <see cref="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever"/> that reaches out to obtain the configuration.</param>
 152             <exception cref="T:System.ArgumentNullException">If 'metadataAddress' is null or empty.</exception>
 153             <exception cref="T:System.ArgumentNullException">If 'configRetriever' is null.</exception>
 154             <exception cref="T:System.ArgumentNullException">If 'docRetriever' is null.</exception>
 155         </member>
 156         <member name="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.AutomaticRefreshInterval">
 157             <summary>
 158             Gets or sets the <see cref="T:System.TimeSpan"/> that controls how often an automatic metadata refresh should occur.
 159             </summary>
 160         </member>
 161         <member name="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RefreshInterval">
 162             <summary>
 163             The minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.
 164             </summary>
 165         </member>
 166         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.GetConfigurationAsync">
 167             <summary>
 168             Obtains an updated version of Configuration.
 169             </summary>
 170             <returns>Configuration of type T.</returns>
 171             <remarks>If the time since the last call is less than <see cref="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.AutomaticRefreshInterval"/> then <see cref="M:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1.GetConfigurationAsync(System.String,Microsoft.IdentityModel.Protocols.IDocumentRetriever,System.Threading.CancellationToken)"/> is not called and the current Configuration is returned.</remarks>
 172         </member>
 173         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.GetConfigurationAsync(System.Threading.CancellationToken)">
 174             <summary>
 175             Obtains an updated version of Configuration.
 176             </summary>
 177             <param name="cancel">CancellationToken</param>
 178             <returns>Configuration of type T.</returns>
 179             <remarks>If the time since the last call is less than <see cref="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.AutomaticRefreshInterval"/> then <see cref="M:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1.GetConfigurationAsync(System.String,Microsoft.IdentityModel.Protocols.IDocumentRetriever,System.Threading.CancellationToken)"/> is not called and the current Configuration is returned.</remarks>
 180         </member>
 181         <member name="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RequestRefresh">
 182             <summary>
 183             Requests that then next call to <see cref="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.GetConfigurationAsync"/> obtain new configuration.
 184             <para>If the last refresh was greater than <see cref="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RefreshInterval"/> then the next call to <see cref="M:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.GetConfigurationAsync"/> will retrieve new configuration.</para>
 185             <para>If <see cref="P:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.RefreshInterval"/> == <see cref="F:System.TimeSpan.MaxValue"/> then this method does nothing.</para>
 186             </summary>
 187         </member>
 188         <member name="T:Microsoft.IdentityModel.Protocols.FileDocumentRetriever">
 189             <summary>
 190             Reads a local file from the disk.
 191             </summary>
 192         </member>
 193         <member name="M:Microsoft.IdentityModel.Protocols.FileDocumentRetriever.#ctor">
 194             <summary>
 195             Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Protocols.FileDocumentRetriever"/> class.
 196             </summary>
 197         </member>
 198         <member name="M:Microsoft.IdentityModel.Protocols.FileDocumentRetriever.GetDocumentAsync(System.String,System.Threading.CancellationToken)">
 199             <summary>
 200             Reads a document using <see cref="T:System.IO.FileStream"/>.
 201             </summary>
 202             <param name="address">Fully qualified path to a file.</param>
 203             <param name="cancel"><see cref="T:System.Threading.CancellationToken"/> not used.</param>
 204             <returns>UTF8 decoding of bytes in the file.</returns>
 205             <exception cref="T:System.ArgumentNullException">If address is null or whitespace.</exception>
 206             <exception cref="T:System.IO.IOException">with inner expection containing the original exception.</exception>
 207         </member>
 208         <member name="T:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever">
 209             <summary>
 210             Retrieves metadata information using HttpClient.
 211             </summary>
 212         </member>
 213         <member name="M:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever.#ctor">
 214             <summary>
 215             Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever"/> class.
 216             </summary>
 217         </member>
 218         <member name="M:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever.#ctor(System.Net.Http.HttpClient)">
 219             <summary>
 220             Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever"/> class with a specified httpClient.
 221             </summary>
 222             <param name="httpClient"><see cref="T:System.Net.Http.HttpClient"/></param>
 223             <exception cref="T:System.ArgumentNullException">'httpClient' is null.</exception>
 224         </member>
 225         <member name="P:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever.RequireHttps">
 226             <summary>
 227             Requires Https secure channel for sending requests.. This is turned ON by default for security reasons. It is RECOMMENDED that you do not allow retrieval from http addresses by default.
 228             </summary>
 229         </member>
 230         <member name="M:Microsoft.IdentityModel.Protocols.HttpDocumentRetriever.GetDocumentAsync(System.String,System.Threading.CancellationToken)">
 231             <summary>
 232             Returns a task which contains a string converted from remote document when completed, by using the provided address.
 233             </summary>
 234             <param name="address">Location of document</param>
 235             <param name="cancel">A cancellation token that can be used by other objects or threads to receive notice of cancellation. <see cref="T:System.Threading.CancellationToken"/></param>
 236             <returns>Document as a string</returns>
 237         </member>
 238         <member name="T:Microsoft.IdentityModel.Protocols.IConfigurationManager`1">
 239             <summary>
 240             Interface that defines a model for retrieving configuration data.
 241             </summary>
 242             <typeparam name="T">The type of <see cref="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever"/>.</typeparam>
 243         </member>
 244         <member name="M:Microsoft.IdentityModel.Protocols.IConfigurationManager`1.GetConfigurationAsync(System.Threading.CancellationToken)">
 245             <summary>
 246             Retrieve the current configuration, refreshing and/or caching as needed.
 247             This method will throw if the configuration cannot be retrieved, instead of returning null.
 248             </summary>
 249             <param name="cancel"><see cref="T:System.Threading.CancellationToken"/></param>
 250             <returns><see cref="T:System.Threading.Tasks.Task`1"/></returns>
 251         </member>
 252         <member name="M:Microsoft.IdentityModel.Protocols.IConfigurationManager`1.RequestRefresh">
 253             <summary>
 254             Indicate that the configuration may be stale (as indicated by failing to process incoming tokens).
 255             </summary>
 256         </member>
 257         <member name="T:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1">
 258             <summary>
 259             Interface that defines methods to retrieve configuration.
 260             </summary>
 261             <typeparam name="T">The type of the configuration metadata.</typeparam>
 262         </member>
 263         <member name="M:Microsoft.IdentityModel.Protocols.IConfigurationRetriever`1.GetConfigurationAsync(System.String,Microsoft.IdentityModel.Protocols.IDocumentRetriever,System.Threading.CancellationToken)">
 264             <summary>
 265             Retrieves a populated configuration given an address and an <see cref="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever"/>.
 266             </summary>
 267             <param name="address">Address of the discovery document.</param>
 268             <param name="retriever">The <see cref="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever"/> to use to read the discovery document.</param>
 269             <param name="cancel">A cancellation token that can be used by other objects or threads to receive notice of cancellation. <see cref="T:System.Threading.CancellationToken"/>.</param>
 270         </member>
 271         <member name="T:Microsoft.IdentityModel.Protocols.IDocumentRetriever">
 272             <summary>
 273             Interface that defines a document retriever that returns the document as a string.
 274             </summary>
 275         </member>
 276         <member name="M:Microsoft.IdentityModel.Protocols.IDocumentRetriever.GetDocumentAsync(System.String,System.Threading.CancellationToken)">
 277             <summary>
 278             Obtains a document from an address.
 279             </summary>
 280             <param name="address">location of document.</param>
 281             <param name="cancel"><see cref="T:System.Threading.CancellationToken"/>.</param>
 282             <returns>document as a string.</returns>
 283         </member>
 284         <member name="T:Microsoft.IdentityModel.Protocols.StaticConfigurationManager`1">
 285             <summary>
 286             This type is for users that want a fixed and static Configuration.
 287             In this case, the configuration is obtained and passed to the constructor.
 288             </summary>
 289             <typeparam name="T">must be a class.</typeparam>
 290         </member>
 291         <member name="M:Microsoft.IdentityModel.Protocols.StaticConfigurationManager`1.#ctor(`0)">
 292             <summary>
 293             Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Protocols.StaticConfigurationManager`1"/> with a Configuration instance.
 294             </summary>
 295             <param name="configuration">Configuration of type OpenIdConnectConfiguration or OpenIdConnectConfiguration.</param>
 296         </member>
 297         <member name="M:Microsoft.IdentityModel.Protocols.StaticConfigurationManager`1.GetConfigurationAsync(System.Threading.CancellationToken)">
 298             <summary>
 299             Obtains an updated version of Configuration.
 300             </summary>
 301             <param name="cancel"><see cref="T:System.Threading.CancellationToken"/>.</param>
 302             <returns>Configuration of type T.</returns>
 303         </member>
 304         <member name="M:Microsoft.IdentityModel.Protocols.StaticConfigurationManager`1.RequestRefresh">
 305             <summary>
 306             For the this type, this is a no-op
 307             </summary>
 308         </member>
 309     </members>
 310 </doc>