Microsoft.Identity.Client.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Identity.Client</name> </assembly> <members> <member name="T:Microsoft.Identity.Client.Account"> <summary> Contains information of a single account. A user can be present in multiple directories and thus have multiple accounts. This information is used for token cache lookup and enforcing the user session on the STS authorize endpoint. </summary> </member> <member name="M:Microsoft.Identity.Client.Account.#ctor(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IEnumerable{Microsoft.Identity.Client.TenantProfile})"> <summary> Constructor </summary> <param name="homeAccountId">Home account id in "uid.utid" format; can be null, for example when migrating the ADAL v3 cache</param> <param name="username">UPN style , can be null</param> <param name="environment">Identity provider for this account, e.g. <c>login.microsoftonline.com</c></param> <param name="wamAccountIds">Map of (client_id, wam_account_id)</param> <param name="tenantProfiles">Map of (tenant_id, tenant_profile)</param> </member> <member name="P:Microsoft.Identity.Client.Account.TenantProfiles"> <summary> The same account can exist in its home tenant and also as a guest in multiple other tenants. A <see cref="T:Microsoft.Identity.Client.TenantProfile"/> is derived from the ID token for that tenant. </summary> </member> <member name="T:Microsoft.Identity.Client.AccountExtensions"> <summary> Extension methods for <see cref="T:Microsoft.Identity.Client.IAccount"/> </summary> </member> <member name="M:Microsoft.Identity.Client.AccountExtensions.GetTenantProfiles(Microsoft.Identity.Client.IAccount)"> <summary> The same account can exist in its home tenant and also as a guest in multiple other tenants. <see cref="T:Microsoft.Identity.Client.TenantProfile"/> is derived from the ID token for that tenant. </summary> <remarks>Only tenants for which a token was acquired will be available in <c>TenantProfiles</c> property</remarks> </member> <member name="T:Microsoft.Identity.Client.AccountId"> <summary> An identifier for an account in a specific tenant. Returned by <see cref="P:IAccount.HomeAccountId"/> </summary> </member> <member name="P:Microsoft.Identity.Client.AccountId.Identifier"> <summary> Unique identifier for the account </summary> <remarks> For the Microsoft identity platform (formerly named Azure AD v2.0), the identifier is the concatenation of <see cref="P:Microsoft.Identity.Client.AccountId.ObjectId"/> and <see cref="P:Microsoft.Identity.Client.AccountId.TenantId"/> separated by a dot. Contrary to what was happening in ADAL.NET, these two segments are no longer base64 encoded. Note that there are some legitimate cases (for instance domain takeover), where the same ObjectId may show up in multiple tenants. </remarks> </member> <member name="P:Microsoft.Identity.Client.AccountId.ObjectId"> <summary> For Azure AD, a string representation for a GUID which is the Object ID of the user owning the account in the tenant </summary> </member> <member name="P:Microsoft.Identity.Client.AccountId.TenantId"> <summary> For Azure AD, a string representation for a GUID, which is the ID of the tenant where the account resides. </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.#ctor(System.String,System.String,System.String)"> <summary> Constructor of an AccountId </summary> <param name="identifier">Unique identifier for the account.</param> <param name="objectId">A string representation for a GUID which is the ID of the user owning the account in the tenant</param> <param name="tenantId">A string representation for a GUID, which is the ID of the tenant where the account resides</param> </member> <member name="M:Microsoft.Identity.Client.AccountId.#ctor(System.String)"> <summary> Constructor of an AccountId meant for ADFS scenarios since ADFS instances lack tenant ids. </summary> <param name="adfsIdentifier">Unique identifier for the account if authority is ADFS</param> </member> <member name="M:Microsoft.Identity.Client.AccountId.Equals(System.Object)"> <summary> Two accounts are equal when their <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> properties match </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.GetHashCode"> <summary> GetHashCode implementation to match <see cref="M:Microsoft.Identity.Client.AccountId.Equals(System.Object)"/> </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.ToString"> <summary> Textual description of an <see cref="T:Microsoft.Identity.Client.AccountId"/> </summary> </member> <member name="T:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1"> <summary> Base class for builders of token requests, which attempt to acquire a token based on the provided parameters. </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.#ctor"> <summary> Default constructor for AbstractAcquireTokenParameterBuilder. </summary> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Executes the Token request asynchronously, with a possibility of canceling the asynchronous method. </summary> <param name="cancellationToken">Cancellation token. See <see cref="T:System.Threading.CancellationToken"/> </param> <returns>Authentication result containing a token for the requested scopes and parameters set in the builder.</returns> <remarks>Cancellation is not guaranteed, it is best effort. If the operation reaches a point of no return, e.g. tokens are acquired and written to the cache, the task will complete even if cancellation was requested. Do not rely on cancellation tokens for strong consistency.</remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.ExecuteAsync"> <summary> Executes the Token request asynchronously. </summary> <returns>Authentication result containing a token for the requested scopes and parameters set in the builder.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithScopes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Specifies which scopes to request. This method is used when your application needs to specify the scopes needed to call a protected API. See <see>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</see> to learn more about scopes, permissions and consent, and <see>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</see> to learn how to create scopes for legacy applications which used to expose OAuth2 permissions. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request. </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority as a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithClaims(System.String)"> <summary> Sets claims in the query. Use when the AAD admin has enabled conditional access. Acquiring the token normally will result in a <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/> with the <see cref="P:Microsoft.Identity.Client.MsalServiceException.Claims"/> property set. Retry the token acquisition, and use this value in the <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithClaims(System.String)"/> method. See https://aka.ms/msal-exceptions for details as well as https://aka.ms/msal-net-claim-challenge. </summary> <param name="claims">A string with one or multiple claims.</param> <returns>The builder to chain .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.String)"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request. </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The string needs to be properly URL-encoded and ready to send as a string of segments of the form <c>key=value</c> separated by an ampersand character. </param> <returns>The builder to chain .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"> <summary> Specific authority for which the token is requested. Passing a different value than configured at the application constructor narrows down the selection to a specific tenant. This does not change the configured value in the application. This is specific to applications managing several accounts (like a mail client with several mailboxes). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityUri">Uri for the authority. In the case when the authority URI is a known Azure AD URI, this setting needs to be consistent with what is declared in the application registration portal.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) specified by its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Azure Cloud instance.</param> <param name="tenantId">GUID of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its domain name. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Uri to the Azure Cloud instance (for instance <c>https://login.microsoftonline.com)</c>.</param> <param name="tenant">Tenant Id associated with the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks> <paramref name="tenant"/> can also contain the string representation of a GUID (tenantId), or even <c>common</c>, <c>organizations</c> or <c>consumers</c> but in this case it's recommended to use another override (<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"/> and <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </remarks> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenantId">Tenant Id of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its domain name or tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenant">Tenant Id of the tenant from which to sign-in users. This can also be a GUID.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the cloud instance and the sign-in audience. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the sign-in audience (the cloud being the Azure public cloud). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"> <summary> Overrides the tenant ID specified in the authority at the application level. This operation preserves the authority host (environment). If an authority was not specified at the application level, the default used is https://login.microsoftonline.com/common. </summary> <param name="tenantId">The tenant ID, which can be either in GUID format or a domain name. Also known as the Directory ID.</param> <returns>The builder to chain the .With methods.</returns> <exception cref="T:System.ArgumentNullException">Thrown if tenantId is null or an empty string</exception> <exception cref="T:Microsoft.Identity.Client.MsalClientException">Thrown if the application was configured with an authority that is not AAD specific (e.g. ADFS or B2C).</exception> <remarks> The tenant should be more restrictive than the one configured at the application level, e.g. don't use "common". Does not affect authority validation, which is specified at the application level.</remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAdfsAuthority(System.String,System.Boolean)"> <summary> Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs. </summary> <param name="authorityUri">Authority URL for an ADFS server.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks>MSAL.NET supports ADFS 2019 or later.</remarks> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithB2CAuthority(System.String)"> <summary> Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities </summary> <param name="authorityUri">Azure AD B2C authority, including the B2C policy (for instance <c>"https://fabrikamb2c.b2clogin.com/tfp/{Tenant}/{policy}</c></param>). <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithCorrelationId(System.Guid)"> <summary> Sets the correlation id to be used in the authentication request. Used to track a request in the logs of both the SDK and the Identity Provider service. If not set, a random one will be generated. </summary> <param name="correlationId">Correlation id of the authentication request.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.Validate"> <summary> Validates the parameters of the AcquireToken operation. </summary> </member> <member name="T:Microsoft.Identity.Client.AbstractClientAppBaseAcquireTokenParameterBuilder`1"> <summary> Base class for parameter builders common to public client application and confidential client application token acquisition operations </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractClientAppBaseAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1"> <summary> Base class for confidential client application token request builders </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.WithProofOfPossession(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration)"> <summary> Modifies the token acquisition request so that the acquired token is a Proof of Possession token (PoP), rather than a Bearer token. PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage on Windows. See https://aka.ms/msal-net-pop </summary> <param name="popAuthenticationConfiguration">Configuration properties used to construct a proof of possession request.</param> <returns>The builder.</returns> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description></item> <item><description>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</description></item> </list> </remarks> </member> <member name="T:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1"> <summary> Base class for public client application token request builders </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1.PublicClientApplicationExecutor"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder"> <summary> Builder for AcquireTokenByAuthorizationCode </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.Validate"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Specifies if the x5c claim (public key of the certificate) should be sent to the STS. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithPkceCodeVerifier(System.String)"> <summary> Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). See (https://tools.ietf.org/html/rfc7636) for more details. </summary> <param name="pkceCodeVerifier">A dynamically created cryptographically random key used to provide proof of possession for the authorization code. </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithCcsRoutingHint(System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userName">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithSpaAuthorizationCode(System.Boolean)"> <summary> Requests an auth code for the frontend (SPA using MSAL.js for instance). See https://aka.ms/msal-net/spa-auth-code for details. This is an experimental API. The method signature may change in the future without involving a major version upgrade. </summary> <param name="requestSpaAuthorizationCode "><c>true</c> if a SPA Authorization Code should be returned, <c>false</c></param> otherwise. <returns>The builder to chain the .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder"> <summary> Builder for AcquireTokenByIntegratedWindowsAuth </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IPublicClientApplicationExecutor)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithUsername(System.String)"> <summary> Specifies the username. </summary> <param name="username">Identifier of the user account for which to acquire a token with Integrated Windows authentication. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithFederationMetadata(System.String)"> <summary> Enables MSAL to read the federation metadata for a WS-Trust exchange from the provided input instead of acquiring it from an endpoint. This is only applicable for managed ADFS accounts. See https://aka.ms/MsalFederationMetadata. </summary> <param name="federationMetadata">Federation metadata in the form of XML.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder"> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshToken(System.Collections.Generic.IEnumerable{System.String},System.String)"/> method. See https://aka.ms/msal-net-migration-adal2-msal2 </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IClientApplicationBaseExecutor)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Specifies if the x5c claim (public key of the certificate) should be sent to the STS. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder"> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> operation. See https://aka.ms/msal-net-up </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.WithFederationMetadata(System.String)"> <summary> Enables MSAL to read the federation metadata for a WS-Trust exchange from the provided input instead of acquiring it from an endpoint. This is only applicable for managed ADFS accounts. See https://aka.ms/MsalFederationMetadata. </summary> <param name="federationMetadata">Federation metadata in the form of XML.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder"> <summary> Builder for AcquireTokenForClient (used in client credential flows, in daemon applications). See https://aka.ms/msal-net-client-credentials </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IConfidentialClientApplicationExecutor)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the token request will ignore the access token in the application token cache and will attempt to acquire a new access token using client credentials. By default the token is taken from the application token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, the request will ignore the token cache. The default is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Specifies if the x5c claim (public key of the certificate) should be sent to the STS. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithAzureRegion(System.Boolean)"> <summary> Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithPreferredAzureRegion(System.Boolean,System.String,System.Boolean)"> <summary> Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder"> <summary> Builder for an Interactive token request. See https://aka.ms/msal-net-acquire-token-interactively </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"> <summary> Specifies if the public client application should used an embedded web browser or the system default browser </summary> <param name="useEmbeddedWebView">If <c>true</c>, will use an embedded web browser, otherwise will attempt to use a system web browser. The default depends on the platform: <c>false</c> for Xamarin.iOS and Xamarin.Android, and <c>true</c> for .NET Framework, and UWP</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"> <summary> Specifies options for using the system OS browser handle interactive authentication. </summary> <param name="options">Data object with options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithEmbeddedWebViewOptions(Microsoft.Identity.Client.EmbeddedWebViewOptions)"> <summary> Specifies options for using the embedded wevbiew for interactive authentication. </summary> <param name="options">Data object with options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"> <summary> Sets the <paramref name="loginHint"/>, in order to avoid select account dialogs in the case the user is signed-in with several identities. This method is mutually exclusive with <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/>. If both are used, an exception will be thrown </summary> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"> <summary> Sets the account for which the token will be retrieved. This method is mutually exclusive with <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/>. If both are used, an exception will be thrown </summary> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"> <summary> </summary> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected Web API for which you want to acquire a security token.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"> <summary> Specifies the what the interactive experience is for the user. </summary> <param name="prompt">Requested interactive experience. The default is <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount"/> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.Object)"> <summary> Sets a reference to the ViewController (if using Xamarin.iOS), Activity (if using Xamarin.Android) IWin32Window or IntPtr (if using .Net Framework). Used for invoking the browser. </summary> <remarks>Mandatory only on Android. Can also be set via the PublicClientApplcation builder.</remarks> <param name="parent">The parent as an object, so that it can be used from shared NetStandard assemblies</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.Windows.Forms.IWin32Window)"> <summary> Sets a reference to the current IWin32Window that triggers the browser to be shown. Used to center the browser (embedded webview and Windows broker) that pop-up onto this window. </summary> <param name="window">The current window as a IWin32Window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.IntPtr)"> <summary> Sets a reference to the IntPtr to a window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. The center of the screen or the foreground app if a value is configured. </summary> <param name="window">The current window as IntPtr</param> <returns>The builder to chain the .With methods</returns> <remarks></remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.Validate"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder"> <summary> Builder for AcquireTokenOnBehalfOf (OBO flow) See https://aka.ms/msal-net-on-behalf-of </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IConfidentialClientApplicationExecutor)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCacheKey(System.String)"> <summary> Specifies a key by which to look up the token in the cache instead of searching by an assertion. </summary> <param name="cacheKey">Key by which to look up the token in the cache</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Specifies if the x5c claim (public key of the certificate) should be sent to the STS. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the client application should force refreshing the token from the user token cache. By default the token is taken from the the user token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, ignore any access token in the user token cache and attempt to acquire new access token using the refresh token for the account if one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> <remarks>Avoid unnecessarily setting <paramref name="forceRefresh"/> to <c>true</c> true in order to avoid negatively affecting the performance of your application</remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userName">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"> <inheritdoc /> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> operation. See https://aka.ms/msal-net-acquiretokensilent </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the client application should force refreshing the token from the user token cache. By default the token is taken from the the user token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, ignore any access token in the user token cache and attempt to acquire new access token using the refresh token for the account if one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> <remarks>Avoid unnecessarily setting <paramref name="forceRefresh"/> to <c>true</c> true in order to avoid negatively affecting the performance of your application</remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Specifies if the x5c claim (public key of the certificate) should be sent to the STS. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithProofOfPossession(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration)"> <summary> Modifies the token acquisition request so that the acquired token is a Proof of Possession token (PoP), rather than a Bearer token. PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage on Windows. See https://aka.ms/msal-net-pop </summary> <param name="popAuthenticationConfiguration">Configuration properties used to construct a proof of possession request.</param> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description></item> <item><description>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</description></item> </list> </remarks> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder"> <summary> Parameters builder for the <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"/> operation. See https://aka.ms/msal-net-device-code-flow </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IPublicClientApplicationExecutor)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.WithDeviceCodeResultCallback(System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Sets the Callback delegate so your application can interact with the user to direct them to authenticate (to a specific URL, with a code) </summary> <param name="deviceCodeResultCallback">callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.Validate"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.EmbeddedWebViewOptions"> <summary> Options for using the embedded webview. </summary> </member> <member name="M:Microsoft.Identity.Client.EmbeddedWebViewOptions.#ctor"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.EmbeddedWebViewOptions.Title"> <summary> Forces a static title to be set on the window hosting the browser. If not configured, the widow's title is set to the web page title. </summary> <remarks>Currently only affects the windows desktop apps (WebView1 / Vulcan and WebView2 browser).</remarks> </member> <member name="P:Microsoft.Identity.Client.EmbeddedWebViewOptions.WebView2BrowserExecutableFolder"> <summary> It is possible for applications to bundle a fixed version of the runtime, and ship it side-by-side. For this you need to tell MSAL (so it can tell WebView2) where to find the runtime bits by setting this property. If you don't set it, MSAL will attempt to use a system-wide "evergreen" installation of the runtime." For more details see: https://docs.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2environment.createasync?view=webview2-dotnet-1.0.705.50 </summary> </member> <member name="T:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters"> <summary> Abstract class for confidential clients Supports common property(ies) </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters.SendX5C"> <summary> Parameter sent to request to send X5C or not. This overrides application config settings. </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters.SpaCode"> <summary> if <c>true</c> then Spa code param will be sent via AcquireTokenByAuthorizeCode </summary> </member> <member name="T:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByIntegratedWindowsAuthParameters"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByIntegratedWindowsAuthParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByUsernamePasswordParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenForClientParameters.ForceRefresh"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenForClientParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenInteractiveParameters.ExtraScopesToConsent"> <summary> These need to be asked for to the /authorize endpoint (for consent) but not to the /token endpoint </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.UserAssertion"> <remarks> User assertion is null when <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/> is called. </remarks> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.LongRunningOboCacheKey"> <summary> User-provided cache key for long-running OBO flow. </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenSilentParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenWithDeviceCodeParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.GetAuthorizationRequestUrlParameters.LogParameters(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder"> <summary> NOTE: a few of the methods in AbstractAcquireTokenParameterBuilder (e.g. account) don't make sense here. Do we want to create a further base that contains ALL of the common methods, and then have another one including account, etc that are only used for AcquireToken? </summary> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"> <summary> Sets the redirect URI to add to the Authorization request URL </summary> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"> <summary> </summary> <param name="loginHint"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"> <summary> </summary> <param name="account"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"> <summary> </summary> <param name="extraScopesToConsent"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPkce(System.String@)"> <summary> Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636 </summary> <param name="codeVerifier">MSAL.NET will generate it. </param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. The hint created with this api will take precedence over the one created with <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"> <summary> Specifies the interactive experience for the user. </summary> <param name="prompt">Requested interactive experience. The default is <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount"/> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync(System.Threading.CancellationToken)"> <summary> </summary> <param name="cancellationToken"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.CalculateApiEventId"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.SystemWebViewOptions"> <summary> Options for using the default OS browser as a separate process to handle interactive auth. MSAL will be listening for the OS browser to finish authenticating, but it cannot close the browser. It can however respond with a 200 OK message or a 302 Redirect, which can be configured here. For more details see https://aka.ms/msal-net-os-browser </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.#ctor"> <summary> Constructor </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageSuccess"> <summary> When the user finishes authenticating, MSAL will respond with a 200 OK message, which the browser will show to the user. </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageError"> <summary> When the user finishes authenticating, but an error occurred, MSAL will respond with a 200 OK message, which the browser will show to the user. You can use a string format e.g. "An error has occurred: {0} details: {1}" </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.BrowserRedirectSuccess"> <summary> When the user finishes authenticating, MSAL will redirect the browser to the given Uri </summary> <remarks>Takes precedence over <see cref="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageSuccess"/></remarks> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.BrowserRedirectError"> <summary> When the user finishes authenticating, but an error occurred, MSAL will redirect the browser to the given Uri </summary> <remarks>Takes precedence over <see cref="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageError"/></remarks> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.iOSHidePrivacyPrompt"> <summary> This hides the privacy prompt displayed on iOS Devices (ver 13.0+) when set to true. By default, it is false and displays the prompt. </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.OpenBrowserAsync"> <summary> Allows developers to implement their own logic for starting a browser and navigating to a specific Uri. MSAL will use this when opening the browser. Leave it null and the user configured browser will be used. Consider using the static helpers OpenWithEdgeBrowserAsync and OpenWithChromeEdgeBrowserAsync </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.OpenWithEdgeBrowserAsync(System.Uri)"> <summary> Use Microsoft Edge to navigate to the given URI. On non-windows platforms it uses whatever browser is the default. </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.OpenWithChromeEdgeBrowserAsync(System.Uri)"> <summary> Use Microsoft Edge Chromium to navigate to the given URI. Requires the browser to be installed. On Linux, uses the default system browser instead, as Edge is not available. </summary> </member> <member name="T:Microsoft.Identity.Client.WindowsBrokerOptions"> <summary> Advanced options for using the Windows 10 broker. For more details see https://aka.ms/msal-net-wam </summary> </member> <member name="M:Microsoft.Identity.Client.WindowsBrokerOptions.#ctor"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.WindowsBrokerOptions.MsaPassthrough"> <summary> A legacy option available only to old Microsoft applications. Should be avoided where possible. Support is experimental. </summary> </member> <member name="P:Microsoft.Identity.Client.WindowsBrokerOptions.ListWindowsWorkAndSchoolAccounts"> <summary> Allow the Windows broker to list Work and School accounts as part of the <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> </summary> <remarks>On UWP, accounts are not listed due to privacy concerns</remarks> </member> <member name="T:Microsoft.Identity.Client.AadAuthorityAudience"> <summary> Specifies which Microsoft accounts can be used for sign-in with a given application. See https://aka.ms/msal-net-application-configuration </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.None"> <summary> The sign-in audience was not specified </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdMyOrg"> <summary> Users with a Microsoft work or school account in my organization’s Azure AD tenant (i.e. single tenant). Maps to https://[instance]/[tenantId] </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdAndPersonalMicrosoftAccount"> <summary> Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant Maps to https://[instance]/common/ </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdMultipleOrgs"> <summary> Users with a Microsoft work or school account in any organization’s Azure AD tenant (i.e. multi-tenant). Maps to https://[instance]/organizations/ </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.PersonalMicrosoftAccount"> <summary> Users with a personal Microsoft account. Maps to https://[instance]/consumers/ </summary> </member> <member name="T:Microsoft.Identity.Client.AbstractApplicationBuilder`1"> <summary> </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithHttpClientFactory(Microsoft.Identity.Client.IMsalHttpClientFactory)"> <summary> Uses a specific <see cref="T:Microsoft.Identity.Client.IMsalHttpClientFactory"/> to communicate with the IdP. This enables advanced scenarios such as setting a proxy, or setting the Agent. </summary> <param name="httpClientFactory">HTTP client factory</param> <remarks>MSAL does not guarantee that it will not modify the HttpClient, for example by adding new headers. Prior to the changes needed in order to make MSAL's httpClients thread safe (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/pull/2046/files), the httpClient had the possibility of throwing an exception stating "Properties can only be modified before sending the first request". MSAL's httpClient will no longer throw this exception after 4.19.0 (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/releases/tag/4.19.0) see (https://aka.ms/msal-httpclient-info) for more information. </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDicoveryMetadata(System.String)"> <summary> Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not know in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryJson"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.String)"> <summary> Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not known in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryJson"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDicoveryMetadata(System.Uri)"> <summary> Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not know in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryUri"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.Uri)"> <summary> Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not known in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryUri"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithCacheOptions(Microsoft.Identity.Client.CacheOptions)"> <summary> Options for MSAL token caches. MSAL maintains a token cache internally in memory. By default, this cache object is part of each instance of <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> or <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>. This method allows customization of the in-memory token cache of MSAL. MSAL's memory cache is different than token cache serialization. Cache serialization pulls the tokens from a cache (e.g. Redis, Cosmos, or a file on disk), where they are stored in JSON format, into MSAL's internal memory cache. Memory cache operations do not involve JSON operations. External cache serialization remains the recommended way to handle desktop apps, web site and web APIs, as it provides persistence. These options do not currently control external cache serialization. Detailed guidance for each application type and platform: https://aka.ms/msal-net-token-cache-serialization </summary> <param name="options">Options for the internal MSAL token caches. </param> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLegacyCacheCompatibility(System.Boolean)"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> <param name="enableLegacyCacheCompatibility">Enable legacy ADAL cache compatibility.</param> <returns>The builder to chain the .With methods.</returns> <remarks> ADAL is a previous legacy generation of MSAL.NET authentication library. If you don't use <c>.WithLegacyCacheCompatibility(false)</c>, then by default, the ADAL cache is used (along with MSAL cache). <c>true</c> flag is only needed for specific migration scenarios from ADAL.NET to MSAL.NET when both library versions are running side-by-side. To improve performance add <c>.WithLegacyCacheCompatibility(false)</c> unless you care about migration scenarios. </remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"> <summary> Sets the logging callback. For details see https://aka.ms/msal-net-logging </summary> <param name="loggingCallback"></param> <param name="logLevel">Desired level of logging. The default is LogLevel.Info</param> <param name="enablePiiLogging">Boolean used to enable/disable logging of Personally Identifiable Information (PII). PII logs are never written to default outputs like Console, Logcat or NSLog Default is set to <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII </param> <param name="enableDefaultPlatformLogging">Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In android, Logcat is used. The default value is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the loggingCallback was already set on the application builder </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithDebugLoggingCallback(Microsoft.Identity.Client.LogLevel,System.Boolean,System.Boolean)"> <summary> Sets the Debug logging callback to a default debug method which displays the level of the message and the message itself. For details see https://aka.ms/msal-net-logging </summary> <param name="logLevel">Desired level of logging. The default is LogLevel.Info</param> <param name="enablePiiLogging">Boolean used to enable/disable logging of Personally Identifiable Information (PII). PII logs are never written to default outputs like Console, Logcat or NSLog Default is set to <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII </param> <param name="withDefaultPlatformLoggingEnabled">Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In android, logcat is used. The default value is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the loggingCallback was already set on the application builder by calling <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> <seealso cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTelemetry(Microsoft.Identity.Client.TelemetryCallback)"> <summary> Sets the telemetry callback. For details see https://aka.ms/msal-net-telemetry </summary> <param name="telemetryCallback">Delegate to the callback sending the telemetry elaborated by the library to the telemetry endpoint of choice</param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the method was already called on the application builder. </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientId(System.String)"> <summary> Sets the Client ID of the application </summary> <param name="clientId">Client ID (also known as <i>Application ID</i>) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithRedirectUri(System.String)"> <summary> Sets the redirect URI of the application. See https://aka.ms/msal-net-application-configuration </summary> <param name="redirectUri">URL where the STS will call back the application with the security token. This parameter is not required for desktop or UWP applications (as a default is used). It's not required for mobile applications that don't use a broker It is required for web apps</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTenantId(System.String)"> <summary> Sets the Tenant Id of the organization from which the application will let users sign-in. This is classically a GUID or a domain name. See https://aka.ms/msal-net-application-configuration. Although it is also possible to set <paramref name="tenantId"/> to <c>common</c>, <c>organizations</c>, and <c>consumers</c>, it's recommended to use one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </summary> <param name="tenantId">tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in a user of a specific organization only</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientName(System.String)"> <summary> Sets the name of the calling application for telemetry purposes. </summary> <param name="clientName">The name of the application for telemetry purposes.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientVersion(System.String)"> <summary> Sets the version of the calling application for telemetry purposes. </summary> <param name="clientVersion">The version of the calling application for telemetry purposes.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithOptions(Microsoft.Identity.Client.ApplicationOptions)"> <summary> Sets application options, which can, for instance have been read from configuration files. See https://aka.ms/msal-net-application-configuration. </summary> <param name="applicationOptions">Application options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority as a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.String)"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The string needs to be properly URL-encoded and ready to send as a string of segments of the form <c>key=value</c> separated by an ampersand character. </param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExperimentalFeatures(System.Boolean)"> <summary> Allows usage of experimental features and APIs. If this flag is not set, experimental features will throw an exception. For details see https://aka.ms/msal-net-experimental-features </summary> <remarks> Changes in the public API of experimental features will not result in an increment of the major version of this library. For these reason we advise against using these features in production. </remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> Microsoft Identity specific OIDC extension that allows resource challenges to be resolved without interaction. Allows configuration of one or more client capabilities, e.g. "llt" </summary> <remarks> MSAL will transform these into special claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTelemetry(Microsoft.Identity.Client.ITelemetryConfig)"> <summary> Generate telemetry aggregation events. </summary> <param name="telemetryConfig"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.Uri,System.Boolean)"> <summary> Adds a known authority to the application from its Uri. See https://aka.ms/msal-net-application-configuration. This constructor is mainly used for scenarios where the authority is not a standard Azure AD authority, nor an ADFS authority, nor an Azure AD B2C authority. For Azure AD, even in national and sovereign clouds, prefer using other overrides such as <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </summary> <param name="authorityUri">Uri of the authority</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the full authority Uri. See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityUri">URL of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities endpoints for the Azure public Cloud are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c> where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in users of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to sign-in users with any work and school accounts or Microsoft personal account</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to sign-in users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to sign-in users with only personal Microsoft accounts (live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) specified by its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Azure Cloud instance.</param> <param name="tenantId">GUID of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its domain name. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Uri to the Azure Cloud instance (for instance <c>https://login.microsoftonline.com)</c></param> <param name="tenant">domain name associated with the tenant from which to sign-in users</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks> <paramref name="tenant"/> can also contain the string representation of a GUID (tenantId), or even <c>common</c>, <c>organizations</c> or <c>consumers</c> but in this case it's recommended to use another override (<see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"/> and <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...)</param> <param name="tenantId">Tenant Id of the tenant from which to sign-in users</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its domain name or tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenant">Domain name associated with the Azure AD tenant from which to sign-in users. This can also be a GUID.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the cloud instance and the sign-in audience. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...)</param> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the sign-in audience (the cloud being the Azure public cloud). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAdfsAuthority(System.String,System.Boolean)"> <summary> Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs </summary> <param name="authorityUri">Authority URL for an ADFS server</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks>MSAL.NET will only support ADFS 2019 or later.</remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithB2CAuthority(System.String)"> <summary> Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities </summary> <param name="authorityUri">Azure AD B2C authority, including the B2C policy (for instance <c>"https://fabrikamb2c.b2clogin.com/tfp/{Tenant}/{policy}</c></param>) <returns>The builder to chain the .With methods</returns> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.KerberosServicePrincipalName"> <summary> Service principal name for Kerberos Service Ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.TicketContainer"> <summary> Kerberos Service Ticket container to be used. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.AadAuthorityAudience"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.AzureCloudInstance"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.Instance"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.ValidateAuthority"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="T:Microsoft.Identity.Client.ApplicationOptions"> <summary> Base class for options objects with string values loadable from a configuration file (for instance a JSON file, as in an asp.net configuration scenario) See https://aka.ms/msal-net-application-configuration See also derived classes <see cref="T:Microsoft.Identity.Client.PublicClientApplicationOptions"/> and <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationOptions"/> </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientId"> <summary> Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.TenantId"> <summary> Tenant from which the application will allow users to sign it. This can be: a domain associated with a tenant, a GUID (tenant id), or a meta-tenant (e.g. consumers). This property is mutually exclusive with <see cref="P:Microsoft.Identity.Client.ApplicationOptions.AadAuthorityAudience"/>. If both are provided, an exception will be thrown. </summary> <remarks>The name of the property was chosen to ensure compatibility with AzureAdOptions in ASP.NET Core configuration files (even the semantics would be tenant)</remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.AadAuthorityAudience"> <summary> Sign-in audience. This property is mutually exclusive with TenantId. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.Instance"> <summary> STS instance (for instance https://login.microsoftonline.com for the Azure public cloud). The name was chosen to ensure compatibility with AzureAdOptions in ASP.NET Core. This property is mutually exclusive with <see cref="P:Microsoft.Identity.Client.ApplicationOptions.AzureCloudInstance"/>. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.AzureCloudInstance"> <summary> Specific instance in the case of Azure Active Directory. It allows users to use the enum instead of the explicit URL. This property is mutually exclusive with <see cref="P:Microsoft.Identity.Client.ApplicationOptions.Instance"/>. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.RedirectUri"> <summary> This redirect URI needs to be registered in the app registration. See https://aka.ms/msal-net-register-app for details on which redirect URIs are defined by default by MSAL.NET and how to register them. Also use: <see cref="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithDefaultRedirectUri"/> which provides a good default for public client applications for all platforms. For web apps and web APIs, the redirect URI is computed from the URL where the application is running (for instance, <c>baseUrl//signin-oidc</c> for ASP.NET Core web apps). For daemon applications (confidential client applications using only the Client Credential flow that is calling <c>AcquireTokenForClient</c>), no reply URI is needed. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal </remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.LogLevel"> <summary> Enables you to configure the level of logging you want. The default value is <see cref="F:Microsoft.Identity.Client.LogLevel.Info"/>. Setting it to <see cref="F:Microsoft.Identity.Client.LogLevel.Error"/> will only get errors Setting it to <see cref="F:Microsoft.Identity.Client.LogLevel.Warning"/> will get errors and warning, etc.. See https://aka.ms/msal-net-logging </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.EnablePiiLogging"> <summary> Flag to enable/disable logging of Personally Identifiable Information (PII). PII logs are never written to default outputs like Console, Logcat or NSLog Default is set to <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII. See https://aka.ms/msal-net-logging </summary> <seealso cref="P:Microsoft.Identity.Client.ApplicationOptions.IsDefaultPlatformLoggingEnabled"/> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.IsDefaultPlatformLoggingEnabled"> <summary> Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In Android, logcat is used. The default value is <c>false</c>. See https://aka.ms/msal-net-logging </summary> <seealso cref="P:Microsoft.Identity.Client.ApplicationOptions.EnablePiiLogging"/> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientName"> <summary> The name of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientVersion"> <summary> The version of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientCapabilities"> <summary> Microsoft Identity specific OIDC extension that allows resource challenges to be resolved without interaction. Allows configuration of one or more client capabilities, e.g. "llt" </summary> <remarks> MSAL will transform these into special claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.LegacyCacheCompatibilityEnabled"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.KerberosServicePrincipalName"> <summary> Service principal name for Kerberos Service Ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.TicketContainer"> <summary> Kerberos Service Ticket container to be used. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthorityInfo"> <remarks> This class must be kept immutable </remarks> </member> <member name="T:Microsoft.Identity.Client.AuthorityType"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.AuthorityType.Aad"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.AuthorityType.Adfs"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.AuthorityType.B2C"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.AzureCloudInstance"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.None"> <summary> Value communicating that the AzureCloudInstance is not specified. </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzurePublic"> <summary> Microsoft Azure public cloud. Maps to https://login.microsoftonline.com </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureChina"> <summary> Microsoft Chinese national cloud. Maps to https://login.chinacloudapi.cn </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureGermany"> <summary> Microsoft German national cloud ("Black Forest"). Maps to https://login.microsoftonline.de </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureUsGovernment"> <summary> US Government cloud. Maps to https://login.microsoftonline.us </summary> </member> <member name="T:Microsoft.Identity.Client.CacheOptions"> <summary> Options for MSAL token caches. </summary> <remarks> Detailed cache guidance for each application type and platform, including L2 options: https://aka.ms/msal-net-token-cache-serialization </remarks> </member> <member name="P:Microsoft.Identity.Client.CacheOptions.EnableSharedCacheOptions"> <summary> Recommended options for using a static cache. </summary> </member> <member name="M:Microsoft.Identity.Client.CacheOptions.#ctor"> <summary> Constructor for the options with default values. </summary> </member> <member name="M:Microsoft.Identity.Client.CacheOptions.#ctor(System.Boolean)"> <summary> Constructor </summary> <param name="useSharedCache">Set to true to share the cache between all ClientApplication objects. The cache becomes static. <see cref="P:Microsoft.Identity.Client.CacheOptions.UseSharedCache"/> for a detailed description. </param> </member> <member name="P:Microsoft.Identity.Client.CacheOptions.UseSharedCache"> <summary> Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false. </summary> <remarks> Recommended only for client credentials flow (service to service communication). Web apps and Web APIs should use external token caching (Redis, Cosmos etc.) for scaling purposes. Desktop apps should encrypt and persist their token cache to disk, to avoid losing tokens when app restarts. ADAL used a static cache by default. </remarks> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.#ctor(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.CreateWithApplicationOptions(Microsoft.Identity.Client.ConfidentialClientApplicationOptions)"> <summary> Constructor of a ConfidentialClientApplicationBuilder from application configuration options. See https://aka.ms/msal-net-application-configuration </summary> <param name="options">Confidential client applications configuration options</param> <returns>A <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"/> from which to set more parameters, and to create a confidential client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Create(System.String)"> <summary> Creates a ConfidentialClientApplicationBuilder from a clientID. See https://aka.ms/msal-net-application-configuration </summary> <param name="clientId">Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/.</param> <returns>A <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"/> from which to set more parameters, and to create a confidential client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Sets the certificate associated with the application. </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <remarks> You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. Does not send the certificate (as x5c parameter) with the request by default. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean)"> <summary> Sets the certificate associated with the application. </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="sendX5C">To send X5C with every request or not.</param> <remarks>You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientClaims(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)"> <summary> Sets the certificate associated with the application along with the specific claims to sign. By default, this will merge the <paramref name="claimsToSign"/> with the default required set of claims needed for authentication. If <paramref name="mergeWithDefaultClaims"/> is set to false, you will need to provide the required default claims. See https://aka.ms/msal-net-client-assertion </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="claimsToSign">The claims to be signed by the provided certificate.</param> <param name="mergeWithDefaultClaims">Determines whether or not to merge <paramref name="claimsToSign"/> with the default claims required for authentication.</param> <remarks> You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. Does not send the certificate (as x5c parameter) with the request by default. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientClaims(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean,System.Boolean)"> <summary> Sets the certificate associated with the application along with the specific claims to sign. By default, this will merge the <paramref name="claimsToSign"/> with the default required set of claims needed for authentication. If <paramref name="mergeWithDefaultClaims"/> is set to false, you will need to provide the required default claims. See https://aka.ms/msal-net-client-assertion </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="claimsToSign">The claims to be signed by the provided certificate.</param> <param name="mergeWithDefaultClaims">Determines whether or not to merge <paramref name="claimsToSign"/> with the default claims required for authentication.</param> <param name="sendX5C">To send X5C with every request or not.</param> <remarks>You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys.</remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientSecret(System.String)"> <summary> Sets the application secret </summary> <param name="clientSecret">Secret string previously shared with AAD at application registration to prove the identity of the application (the client) requesting the tokens</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.String)"> <summary> Sets the application client assertion. See https://aka.ms/msal-net-client-assertion. This will create an assertion that will be held within the client application's memory for the duration of the client. You can use <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.String})"/> to set a delegate that will be executed for each authentication request. This will allow you to update the client assertion used by the client application once the assertion expires. </summary> <param name="signedClientAssertion">The client assertion used to prove the identity of the application to Azure AD. This is a Base-64 encoded JWT.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.String})"> <summary> Configures a delegate that creates a client assertion. See https://aka.ms/msal-net-client-assertion </summary> <param name="clientAssertionDelegate">delegate computing the client assertion used to prove the identity of the application to Azure AD. This is a delegate that computes a Base-64 encoded JWT for each authentication call.</param> <returns>The ConfidentialClientApplicationBuilder to chain more .With methods</returns> <remarks> Callers can use this mechanism to cache their assertions </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.String}})"> <summary> Configures an async delegate that creates a client assertion. See https://aka.ms/msal-net-client-assertion </summary> <param name="clientAssertionAsyncDelegate">An async delegate computing the client assertion used to prove the identity of the application to Azure AD. This is a delegate that computes a Base-64 encoded JWT for each authentication call.</param> <returns>The ConfidentialClientApplicationBuilder to chain more .With methods</returns> <remarks> Callers can use this mechanism to cache their assertions </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithAzureRegion(System.String)"> <summary> Instructs MSAL.NET to use an Azure regional token service. </summary> <param name="azureRegion">Either the string with the region (preferred) or use <see cref="F:Microsoft.Identity.Client.ConfidentialClientApplication.AttemptRegionDiscovery"/> and MSAL.NET will attempt to auto-detect the region. </param> <remarks> Region names as per https://azure.microsoft.com/en-ca/global-infrastructure/geographies/. See https://aka.ms/region-map for more details on region names. The region value should be short region name for the region where the service is deployed. For example "centralus" is short name for region Central US. Not all auth flows can use the regional token service. Service To Service (client credential flow) tokens can be obtained from the regional service. Requires configuration at the tenant level. Auto-detection works on a limited number of Azure artifacts (VMs, Azure functions). If auto-detection fails, the non-regional endpoint will be used. If an invalid region name is provided, the non-regional endpoint MIGHT be used or the token request MIGHT fail. See https://aka.ms/msal-net-region-discovery for more details. </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCacheSynchronization(System.Boolean)"> <summary> When set to <c>true</c>, MSAL will lock cache access at the <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> level, i.e. the block of code between BeforeAccessAsync and AfterAccessAsync callbacks will be synchronized. Apps can set this flag to <c>false</c> to enable an optimistic cache locking strategy, which may result in better performance, especially when ConfidentialClientApplication objects are reused. </summary> <remarks> False by default. Not recommended for apps that call RemoveAsync </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Validate"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Build"> <summary> Builds the ConfidentialClientApplication from the parameters set in the builder </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.BuildConcrete"> <summary> </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplicationOptions"> <summary> Configuration options for a confidential client application (web app / web API / daemon app). See https://aka.ms/msal-net/application-configuration </summary> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.ClientSecret"> <summary> Client secret for the confidential client application. This secret (application password) is provided by the application registration portal, or provided to Azure AD during the application registration with PowerShell AzureAD, PowerShell AzureRM, or Azure CLI. </summary> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.AzureRegion"> <summary> Instructs MSAL.NET to use an Azure regional token service. This setting should be set to either the string with the region (preferred) or to "TryAutoDetect" and MSAL.NET will attempt to auto-detect the region. </summary> <remarks> Region names as per https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.fluent.core.region?view=azure-dotnet. Not all auth flows can use the regional token service. Service To Service (client credential flow) tokens can be obtained from the regional service. Requires configuration at the tenant level. Auto-detection works on a limited number of Azure artifacts (VMs, Azure functions). If auto-detection fails, the non-regional endpoint will be used. If an invalid region name is provided, the non-regional endpoint MIGHT be used or the token request MIGHT fail. See https://aka.ms/msal-net-region-discovery for more details. </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.EnableCacheSynchronization"> <summary> When set to <c>true</c>, MSAL will lock cache access at the <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> level, i.e. the block of code between BeforeAccessAsync and AfterAccessAsync callbacks will be synchronized. Apps can set this flag to <c>false</c> to enable an optimistic cache locking strategy, which may result in better performance, especially when ConfidentialClientApplication objects are reused. </summary> <remarks> False by default. Not recommended for apps that call RemoveAsync </remarks> </member> <member name="T:Microsoft.Identity.Client.IAppConfig"> <summary> Configuration properties used to build a public or confidential client application. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientId"> <summary> Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app). </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.EnablePiiLogging"> <summary> Flag telling if logging of Personally Identifiable Information (PII) is enabled/disabled for the application. See https://aka.ms/msal-net-logging. </summary> <seealso cref="P:Microsoft.Identity.Client.IAppConfig.IsDefaultPlatformLoggingEnabled"/> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.HttpClientFactory"> <summary> <see cref="T:Microsoft.Identity.Client.IMsalHttpClientFactory"/> used to get HttpClient instances to communicate with the identity provider. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LogLevel"> <summary> Level of logging requested for the app. See https://aka.ms/msal-net-logging. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.IsDefaultPlatformLoggingEnabled"> <summary> Flag telling if logging to platform defaults is enabled/disabled for the app. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In Android, logcat is used. See https://aka.ms/msal-net-logging. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.RedirectUri"> <summary> Redirect URI for the application. See <see cref="P:Microsoft.Identity.Client.ApplicationOptions.RedirectUri"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.TenantId"> <summary> Audience for the application. See <see cref="P:Microsoft.Identity.Client.ApplicationOptions.TenantId"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LoggingCallback"> <summary> Callback used for logging. It was set with <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> See https://aka.ms/msal-net-logging </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ExtraQueryParameters"> <summary> Extra query parameters that will be applied to every acquire token operation. See <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.Collections.Generic.IDictionary{System.String,System.String})"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.IsBrokerEnabled"> <summary> Indicates whether or not the current application object is configured to use brokered authentication. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientName"> <summary> The name of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientVersion"> <summary> The version of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.TelemetryConfig"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ExperimentalFeaturesEnabled"> <summary> Allows usage of features that are experimental and would otherwise throw a specific exception. Use of experimental features in production is not recommended and are subject to be removed between builds. For details see https://aka.ms/msal-net-experimental-features. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientCapabilities"> <summary> Microsoft Identity specific OIDC extension that allows resource challenges to be resolved without interaction. Allows configuration of one or more client capabilities, e.g. "llt" </summary> <remarks> MSAL will transform these into a "access_token" claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LegacyCacheCompatibilityEnabled"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientSecret"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientCredentialCertificate"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ParentActivityOrWindowFunc"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.IMsalHttpClientFactory"> <summary> Factory responsible for creating HttpClient .Net recommends to use a single instance of HttpClient. </summary> <remarks> Implementations must be thread safe. Consider creating and configuring an HttpClient in the constructor of the factory, and returning the same object in <see cref="M:Microsoft.Identity.Client.IMsalHttpClientFactory.GetHttpClient"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IMsalHttpClientFactory.GetHttpClient"> <summary> Method returning an HTTP client that will be used to communicate with Azure AD. This enables advanced scenarios. See https://aka.ms/msal-net-application-configuration. </summary> <returns>An HTTP client.</returns> </member> <member name="T:Microsoft.Identity.Client.TelemetryAudienceType"> <summary> Describes the types of audiences for telemetry. <see cref="P:Microsoft.Identity.Client.ITelemetryConfig.AudienceType"/> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="F:Microsoft.Identity.Client.TelemetryAudienceType.PreProduction"> <summary> Indicates a PreProduction environment. PreProd environments are not sampled. </summary> </member> <member name="F:Microsoft.Identity.Client.TelemetryAudienceType.Production"> <summary> Indicates a Production environment. These environments are sampled based on the platforms' device info to reduce data load. </summary> </member> <member name="T:Microsoft.Identity.Client.ITelemetryConfig"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.AudienceType"> <summary> Communicates which audience the telemetry is for (e.g. Production or Pre-Production) so that MSAL.NET can change sampling and filtering behavior. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.SessionId"> <summary> ID for the telemetry session. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.DispatchAction"> <summary> Implementers of the interface will receive this callback when telemetry data is available. The implementation should transfer the data in ITelemetryEventPayload to a specific telemetry uploader instance. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="T:Microsoft.Identity.Client.ITelemetryEventPayload"> <summary> Data that represents a single snapshot in the series of events that are collected </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.Name"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> <returns></returns> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.BoolValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.Int64Values"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.IntValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.StringValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="M:Microsoft.Identity.Client.ITelemetryEventPayload.ToJsonString"> <summary> Used for debugging and testing. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration"> <summary> Details about the HTTP request and configuration properties used to construct a proof of possession request. </summary> <remarks> POP tokens are signed by the process making the request. By default, MSAL will generate a key in memory. To use a hardware key or an external key, implement <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.PopCryptoProvider"/>. </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor"> <summary> Creates a configuration using the default key management. Use the properties <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpMethod"/>, <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpHost"/> etc. to control which elements of the request should be included in the POP token. </summary> <remarks> See https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 for details about signed HTTP requests. </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor(System.Net.Http.HttpRequestMessage)"> <summary> Creates a configuration using the default key management, and which binds all the details of the HttpRequestMessage. </summary> <remarks> Currently only the HtppMethod (m), UrlHost (u) and UrlPath (p) are used to create the signed HTTP request - see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor(System.Uri)"> <summary> Creates a configuration using the default key management, and which binds only the Uri part of the HTTP request. </summary> <remarks> The UrlHost (u) and UrlPath (p) are used to create the signed HTTP request - see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 </remarks> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpMethod"> <summary> The HTTP method ("GET", "POST" etc.) method that will be bound to the token. Leave null and the POP token will not be bound to the method. Corresponds to the "m" part of the a signed HTTP request. Optional. </summary> <remarks> See https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#section-3 </remarks> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpHost"> <summary> The URL host of the protected API. The "u" part of a signed HTTP request. This MAY include the port separated from the host by a colon in host:port format. Optional. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpPath"> <summary> The "p" part of the signed HTTP request. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.PopCryptoProvider"> <summary> An extensibility point that allows developers to define their own key management. Leave <c>null</c> and MSAL will use a default implementation, which generates an RSA key pair in memory and refreshes it every 8 hours. Important note: if you want to change the key (e.g. rotate the key), you should create a new instance of this object, as MSAL.NET will keep a thumbprint of keys in memory. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.Nonce"> <summary> If the protected resource (RP) requires use of a special nonce, they will publish it as part of the WWWAuthenticate header associated with a 401 HTTP response or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the POP token. </summary> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.#ctor(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.CreateWithApplicationOptions(Microsoft.Identity.Client.PublicClientApplicationOptions)"> <summary> Creates a PublicClientApplicationBuilder from public client application configuration options. See https://aka.ms/msal-net-application-configuration </summary> <param name="options">Public client applications configuration options</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Create(System.String)"> <summary> Creates a PublicClientApplicationBuilder from a clientID. See https://aka.ms/msal-net-application-configuration </summary> <param name="clientId">Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/.</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithDefaultRedirectUri"> <summary> Configures the public client application to use the recommended reply URI for the platform. See https://aka.ms/msal-net-default-reply-uri. <list type="table"> <listheader> <term>Platform</term> <Description>Default Reply URI</Description> </listheader> <item> <term>.NET desktop</term> <Description><c>https://login.microsoftonline.com/common/oauth2/nativeclient</c></Description> </item> <item> <term>UWP</term> <Description>value of <c>WebAuthenticationBroker.GetCurrentApplicationCallbackUri()</c></Description> </item> <item> <term>For system browser on .NET Core</term> <Description><c>http://localhost</c></Description> </item> </list> NOTE:There will be an update to the default redirect URI in the future to accommodate for system browsers on the .NET desktop and .NET Core platforms. </summary> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithIosKeychainSecurityGroup(System.String)"> <summary> You can specify a Keychain Access Group to use for persisting the token cache across multiple applications. This enables you to share the token cache between several applications having the same Keychain access group. Sharing the token cache allows single sign-on between all of the applications that use the same Keychain access Group. See https://aka.ms/msal-net-ios-keychain-security-group for more information. </summary> <param name="keychainSecurityGroup"></param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithBroker(System.Boolean)"> <summary> Brokers enable Single-Sign-On, device identification, and application identification verification. To enable one of these features, you need to set the WithBroker() parameters to true. See https://aka.ms/msal-net-brokers for more information on platform specific settings required to enable the broker. On iOS and Android, Authenticator and Company Portal serve as brokers. On Windows, WAM (Windows Account Manager) serves as broker. See https://aka.ms/msal-net-wam </summary> <param name="enableBroker">Determines whether or not to use broker with the default set to true.</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> <remarks>If your app uses .NET classic or .NET Core 3.x, and you wish to use the Windows broker, please install the nuget package Microsoft.Identity.Client.Desktop and call .WithDesktopFeatures()</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithWindowsBrokerOptions(Microsoft.Identity.Client.WindowsBrokerOptions)"> <summary> Allows customization of the Windows 10 Broker experience </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.Object})"> <summary> Sets a reference to the ViewController (if using Xamarin.iOS), Activity (if using Xamarin.Android) IWin32Window or IntPtr (if using .Net Framework). Used for invoking the browser. </summary> <remarks> Mandatory only on Android to be set either from here or from AcquireTokenInteractive builder. See https://aka.ms/msal-net-android-activity for further documentation and details. </remarks> <param name="parentActivityOrWindowFunc">The parent as an object, so that it can be used from shared NetStandard assemblies</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.Windows.Forms.IWin32Window})"> <summary> Sets a reference to the current IWin32Window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. </summary> <param name="windowFunc">A function to return the current window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.IntPtr})"> <summary> Sets a reference to the IntPtr to a window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. </summary> <param name="windowFunc">A function to return the current window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithKerberosTicketClaim(System.String,Microsoft.Identity.Client.Kerberos.KerberosTicketContainer)"> <summary> Sets the parameters required to get a Kerberos Ticket from Azure AD service. </summary> <param name="servicePrincipalName">Service principal name to get Kerberos Service Ticket.</param> <param name="ticketContainer">Container to use for Kerberos Ticket.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.IsBrokerAvailable"> <summary> Returns true if a broker can be used. </summary> <remarks> On Windows, the broker (WAM) can be used on Win10 and is always installed. See https://aka.ms/msal-net-wam On Mac, Linux and older versions of Windows a broker is not available. If your application is .NET5, please use the target .net5.0-windows10.0.17763.0 for all Windows versions and target net5.0 to target Linux and Mac. If your application is .NET classic or .NET Core 3.1 and you wish to use the Windows Broker, please install Microsoft.Identity.Client.Desktop first and call WithDesktopFeatures(). On mobile, the device must be Intune joined and Authenticator or Company Portal must be installed. See https://aka.ms/msal-brokers </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Build"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.BuildConcrete"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Validate"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplicationOptions"> <summary> Configuration options for a public client application (desktop/mobile app). See https://aka.ms/msal-net/application-configuration </summary> </member> <member name="T:Microsoft.Identity.Client.TelemetryConfig"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryConfig.AudienceType"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryConfig.SessionId"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryConfig.DispatchAction"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryConfig.AllowedScopes"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.TraceTelemetryConfig"> <summary> A simple <see cref="T:Microsoft.Identity.Client.ITelemetryConfig"/> implementation that writes data using System.Diagnostics.Trace. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="M:Microsoft.Identity.Client.TraceTelemetryConfig.#ctor"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.AudienceType"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.SessionId"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.DispatchAction"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.AllowedScopes"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="T:Microsoft.Identity.Client.AuthenticationResult"> <summary> Contains the results of one token acquisition operation in <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> or ConfidentialClientApplication. For details see https://aka.ms/msal-net-authenticationresult </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.#ctor(System.String,System.Boolean,System.String,System.DateTimeOffset,System.DateTimeOffset,System.String,Microsoft.Identity.Client.IAccount,System.String,System.Collections.Generic.IEnumerable{System.String},System.Guid,System.String,Microsoft.Identity.Client.AuthenticationResultMetadata,System.Security.Claims.ClaimsPrincipal,System.String)"> <summary> Constructor meant to help application developers test their apps. Allows mocking of authentication flows. App developers should <b>never</b> new-up <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> in product code. </summary> <param name="accessToken">Access Token that can be used as a bearer token to access protected web APIs</param> <param name="account">Account information</param> <param name="expiresOn">Expiry date-time for the access token</param> <param name="extendedExpiresOn">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"/></param> <param name="idToken">ID token</param> <param name="isExtendedLifeTimeToken">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"/></param> <param name="scopes">Granted scope values as returned by the service</param> <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param> <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param> <param name="correlationId">The correlation id of the authentication request</param> <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param> <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param> <param name="claimsPrincipal">Claims from the ID token</param> <param name="spaAuthCode">Auth Code returned by the Microsoft identity platform when you use AcquireTokenByAuthorizeCode.WithSpaAuthorizationCode(). This auth code is meant to be redeemed by the frontend code.</param> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.#ctor(System.String,System.Boolean,System.String,System.DateTimeOffset,System.DateTimeOffset,System.String,Microsoft.Identity.Client.IAccount,System.String,System.Collections.Generic.IEnumerable{System.String},System.Guid,Microsoft.Identity.Client.AuthenticationResultMetadata,System.String)"> <summary> Constructor meant to help application developers test their apps. Allows mocking of authentication flows. App developers should <b>never</b> new-up <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> in product code. </summary> <param name="accessToken">Access Token that can be used as a bearer token to access protected web APIs</param> <param name="account">Account information</param> <param name="expiresOn">Expiry date-time for the access token</param> <param name="extendedExpiresOn">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"/></param> <param name="idToken">ID token</param> <param name="isExtendedLifeTimeToken">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"/></param> <param name="scopes">Granted scope values as returned by the service</param> <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param> <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param> <param name="correlationId">The correlation id of the authentication request</param> <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param> <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param> <remarks>For backwards compatibility with MSAL 4.17-4.20 </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.AccessToken"> <summary> Access Token that can be used as a bearer token to access protected web APIs </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"> <summary> In case when Azure AD has an outage, to be more resilient, it can return tokens with an expiration time, and also with an extended expiration time. The tokens are then automatically refreshed by MSAL when the time is more than the expiration time, except when ExtendedLifeTimeEnabled is true and the time is less than the extended expiration time. This goes in pair with Web APIs middleware which, when this extended life time is enabled, can accept slightly expired tokens. Client applications accept extended life time tokens only if the ExtendedLifeTimeEnabled Boolean is set to true on ClientApplicationBase. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.UniqueId"> <summary> Gets the Unique Id of the account. It can be null. When the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ExpiresOn"> <summary> Gets the point in time in which the Access Token returned in the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.AccessToken"/> property ceases to be valid. This value is calculated based on current UTC time measured locally and the value expiresIn received from the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"> <summary> Gets the point in time in which the Access Token returned in the AccessToken property ceases to be valid in MSAL's extended LifeTime. This value is calculated based on current UTC time measured locally and the value ext_expiresIn received from the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.TenantId"> <summary> Gets an identifier for the Azure AD tenant from which the token was acquired. This property will be null if tenant information is not returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.Account"> <summary> Gets the account information. Some elements in <see cref="T:Microsoft.Identity.Client.IAccount"/> might be null if not returned by the service. The account can be passed back in some API overloads to identify which account should be used such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> for instance </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"> <summary> Gets the Id Token if returned by the service or null if no Id Token is returned. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.Scopes"> <summary> Gets the granted scope values returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.CorrelationId"> <summary> Gets the correlation id used for the request. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.TokenType"> <summary> Identifies the type of access token. By default tokens returned by Azure Active Directory are Bearer tokens. <seealso cref="M:Microsoft.Identity.Client.AuthenticationResult.CreateAuthorizationHeader"/> for getting an HTTP authorization header from an AuthenticationResult. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.SpaAuthCode"> <summary> Gets the SPA Authorization Code, if it was requested using WithSpaAuthorizationCode method on the AcquireTokenByAuthorizationCode builder. See https://aka.ms/msal-net/spa-auth-code for details. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ClaimsPrincipal"> <summary> All the claims present in the ID token. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.AuthenticationResultMetadata"> <summary> Contains metadata for the Authentication result. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.CreateAuthorizationHeader"> <summary> Creates the content for an HTTP authorization header from this authentication result, so that you can call a protected API </summary> <returns>Created authorization header of the form "Bearer {AccessToken}"</returns> <example> Here is how you can call a protected API from this authentication result (in the <c>result</c> variable): <code> HttpClient client = new HttpClient(); client.DefaultRequestHeaders.Add("Authorization", result.CreateAuthorizationHeader()); HttpResponseMessage r = await client.GetAsync(urlOfTheProtectedApi); </code> </example> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.User"> <summary> In MSAL.NET 1.x, returned the user who signed in to get the authentication result. From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.AuthenticationResult.Account"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthenticationResultMetadata"> <summary> Contains metadata of the authentication result. <see cref="T:Microsoft.Identity.Client.Metrics"/> for additional MSAL-wide metrics. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResultMetadata.#ctor(Microsoft.Identity.Client.TokenSource)"> <summary> Constructor for the class AuthenticationResultMetadata <param name="tokenSource">The token source.</param> </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenSource"> <summary> The source of the token in the result. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenEndpoint"> <summary> The token endpoint used to contact the Identity Provider (e.g. Azure Active Directory). Can be null, for example when the token comes from the cache. </summary> <remarks> This may be different from the endpoint you'd infer from the authority configured in the application object: - if regional auth is used. - if AAD instructs MSAL to use a different environment. - if the authority or tenant is overridden at the request level. - during a refresh_token operation, when MSAL must resolve "common" and "organizations" to a tenant ID. </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs"> <summary> Time, in milliseconds, spent to service this request. Includes time spent making HTTP requests <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs"/>, time spent in token cache callbacks <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs"/>, time spent in MSAL and context switching. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs"> <summary> Time, in milliseconds, MSAL spent during this request reading and writing to the token cache, i.e. in the OnBeforeAccess, OnAfterAccess, etc. callbacks. Does not include internal MSAL logic for searching through the cache once loaded. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs"> <summary> Time, in milliseconds, MSAL spent for HTTP communication during this request. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.RefreshOn"> <summary> Specifies the time when the cached token should be proactively refreshed. This value may be null if proactive refresh is not enabled. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.CacheRefreshReason"> <summary> Specifies the reason for fetching the access token from the identity provider. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.AuthSchemeHelper.StoreTokenTypeInCacheKey(System.String)"> <summary> For backwards compatibility reasons, keep the cache key unchanged for Bearer and SSH tokens. For PoP and future tokens, the cache should support both several types of tokens for the same scope (e.g. PoP and Bearer) </summary> <param name="tokenType"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme"> <summary> Used to modify the experience depending on the type of token asked. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.AuthorizationHeaderPrefix"> <summary> Prefix for the HTTP header that has the token. E.g. "Bearer" or "POP" </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.GetTokenRequestParams"> <summary> Extra parameters that are added to the request to the /token endpoint. </summary> <returns>Name and values of params</returns> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.KeyId"> <summary> Key ID of the public / private key pair used by the encryption algorithm, if any. Tokens obtained by authentication schemes that use this are bound to the KeyId, i.e. if a different kid is presented, the access token cannot be used. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.FormatAccessToken(Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem)"> <summary> Creates the access token that goes into an Authorization HTTP header. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.AccessTokenType"> <summary> Expected to match the token_type parameter returned by ESTS. Used to disambiguate between ATs of different types (e.g. Bearer and PoP) when loading from cache etc. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.InMemoryCryptoProvider"> <summary> The default implementation will store a key in memory </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.InMemoryCryptoProvider.ComputeCannonicalJwk(System.Security.Cryptography.RSAParameters)"> <summary> Creates the canonical representation of the JWK. See https://tools.ietf.org/html/rfc7638#section-3. The number of parameters as well as the lexicographic order is important, as this string will be hashed to get a thumbprint. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider"> <summary> An abstraction over an the asymmetric key operations needed by POP, that encapsulates a pair of public and private keys and some typical crypto operations. All symmetric operations are SHA256. </summary> <remarks> Important: The 2 methods on this interface will be called at different times but MUST return details of the same private / public key pair, i.e. do not change to a different key pair mid way. Best to have this class immutable. Ideally there should be a single public / private key pair associated with a machine, so implementers of this interface should consider exposing a singleton. </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.CannonicalPublicKeyJwk"> <summary> The canonical representation of the JWK. See https://tools.ietf.org/html/rfc7638#section-3 </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.CryptographicAlgorithm"> <summary> Algorithm used to sign proof of possession request. See https://docs.microsoft.com/en-us/azure/key-vault/keys/about-keys#signverify for ECD See https://docs.microsoft.com/en-us/azure/key-vault/keys/about-keys#signverify-1 for RSA </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.Sign(System.Byte[])"> <summary> Signs the byte array using the private key </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.JsonWebKeyParameterNames"> <summary> Names for Json Web Key Values </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.JsonWebAlgorithmsKeyTypes"> <summary> Constants for JsonWebAlgorithms "kty" Key Type (sec 6.1) http://tools.ietf.org/html/rfc7518#section-6.1 </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PoPAuthenticationScheme.#ctor(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration,Microsoft.Identity.Client.Internal.IServiceBundle)"> <summary> Creates POP tokens, i.e. tokens that are bound to an HTTP request and are digitally signed. </summary> <remarks> Currently the signing credential algorithm is hard-coded to RSA with SHA256. Extensibility should be done by integrating Wilson's SigningCredentials </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.PoPAuthenticationScheme.KeyId"> <summary> For PoP, we chose to use the base64(jwk_thumbprint) </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PoPAuthenticationScheme.ComputeThumbprint(System.String)"> <summary> A key ID that uniquely describes a public / private key pair. While KeyID is not normally strict, AAD support for PoP requires that we use the base64 encoded JWK thumbprint, as described by https://tools.ietf.org/html/rfc7638 </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PoPAuthenticationScheme.CreateJWS(System.String,System.String)"> <summary> Creates a JWS (json web signature) as per: https://tools.ietf.org/html/rfc7515 Format: header.payload.signed_payload </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.At"> <summary> Access token with response cnf https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.HttpMethod"> <summary> Http method (GET or POST) https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Ts"> <summary> Timestamp https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Host"> <summary> Uri host https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Path"> <summary> Uri path https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Query"> <summary> Uri path https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Cnf"> <summary> Confirmation claim. By including this in a JWT, the issuer states that the presenter possesses a particular key (i.e. the private key) and that the recepient can confirm this cryptographycally. https://tools.ietf.org/html/rfc7800 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.JWK"> <summary> Also part of the confirmation claim. <seealso cref="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Cnf"/> </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Nonce"> <summary> Non-standard claim representing a nonce that protects against replay attacks. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.PoPProviderFactory"> <summary> This factory ensures key rotation every 8h </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalResult"> <summary> Contains the results of an ADAL token acquisition. Access Tokens from ADAL are not compatible with MSAL, only Refresh Tokens are. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResult.UserInfo"> <summary> Gets user information including user Id. Some elements in UserInfo might be null if not returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResultWrapper.RefreshToken"> <summary> Gets the Refresh Token associated with the requested Access Token. Note: not all operations will return a Refresh Token. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResultWrapper.IsMultipleResourceRefreshToken"> <summary> Gets a value indicating whether the refresh token can be used for requesting access token for other resources. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalResultWrapper.Deserialize(System.String)"> <summary> Serializes the object to a JSON string </summary> <returns>Deserialized authentication result</returns> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalResultWrapper.Serialize"> <summary> Serializes the object to a JSON string </summary> <returns>Serialized authentication result</returns> </member> <member name="T:Microsoft.Identity.Client.Cache.TokenSubjectType"> <summary> Determines what type of subject the token was issued for. </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.User"> <summary> User </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.Client"> <summary> Client </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.UserPlusClient"> <summary> UserPlusClient: This is for confidential clients used in middle tier. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalTokenCacheKey"> <summary> <see cref="T:Microsoft.Identity.Client.Cache.AdalTokenCacheKey"/> can be used with Linq to access items from the TokenCache dictionary. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Resource"> <summary> For the purposes of MSAL, the resource is irrelevant, since only RTs can be migrated. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Equals(System.Object)"> <summary> Determines whether the specified object is equal to the current object. </summary> <returns> true if the specified object is equal to the current object; otherwise, false. </returns> <param name="obj">The object to compare with the current object. </param><filterpriority>2</filterpriority> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Equals(Microsoft.Identity.Client.Cache.AdalTokenCacheKey)"> <summary> Determines whether the specified TokenCacheKey is equal to the current object. </summary> <returns> true if the specified TokenCacheKey is equal to the current object; otherwise, false. </returns> <param name="other">The TokenCacheKey to compare with the current object. </param><filterpriority>2</filterpriority> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.GetHashCode"> <summary> Returns the hash code for this TokenCacheKey. </summary> <returns> A 32-bit signed integer hash code. </returns> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalUserInfo"> <summary> Contains information of a single user. This information is used for token cache lookup. Also if created with userId, userId is sent to the service when login_hint is accepted. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalUserInfo.#ctor"> <summary> Create user information for token cache lookup </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalUserInfo.#ctor(Microsoft.Identity.Client.Cache.AdalUserInfo)"> <summary> Create user information copied from another UserInfo object </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.UniqueId"> <summary> Gets identifier of the user authenticated during token acquisition. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.DisplayableId"> <summary> Gets a displayable value in UserPrincipalName (UPN) format. The value can be null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.GivenName"> <summary> Gets given name of the user if provided by the service. If not, the value is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.FamilyName"> <summary> Gets family name of the user if provided by the service. If not, the value is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.PasswordExpiresOn"> <summary> Gets the time when the password expires. Default value is 0. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.PasswordChangeUrl"> <summary> Gets the URL where the user can change the expiring password. The value can be null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.IdentityProvider"> <summary> Gets identity provider if returned by the service. If not, the value is null. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheData"> <summary> Data class, common to ADAL.NET and MSAL.NET V2 used for the token cache serialization in a dual format: the ADAL V3 cache format, and the new unified cache format, common to ADAL.NET 4.x, MSAL.NET 2.x and other libraries in the same Operating System (for instance ADAL and MSAL for objective C in iOS) </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.CacheData.AdalV3State"> <summary> Array of bytes containing the serialized cache in ADAL.NET V3 format </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.CacheData.UnifiedState"> <summary> Array of bytes containing the serialized MSAL.NET V2 cache </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheFallbackOperations.GetAllAdalUsersForMsal(Microsoft.Identity.Client.Core.ICoreLogger,Microsoft.Identity.Client.Cache.ILegacyCachePersistence,System.String)"> <summary> Returns a tuple where Item1 is a map of ClientInfo -> AdalUserInfo for those users that have ClientInfo Item2 is a list of AdalUserInfo for those users that do not have ClientInfo </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheFallbackOperations.RemoveAdalUser(Microsoft.Identity.Client.Core.ICoreLogger,Microsoft.Identity.Client.Cache.ILegacyCachePersistence,System.String,System.String,System.String)"> <summary> Algorithm to delete: DisplayableId cannot be null Removal is scoped by environment and clientId; If accountId != null then delete everything with the same clientInfo otherwise, delete everything with the same displayableId Notes: - displayableId can change rarely - ClientCredential Grant uses the app token cache, not the user token cache, so this algorithm does not apply (nor will GetAccounts / RemoveAccount work) </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheKeyFactory"> <summary> Responsible for computing: - external distributed cache key (from request and responses) - internal cache partition keys (as above, but also from cache items) These are the same string, but MSAL cannot control if the app developer actually uses distributed caching. However, MSAL's in-memory cache needs to be partitioned, and this class computes the partition key. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheSessionManager"> <summary> MSAL should only interact with the cache though this object. It is responsible for firing cache notifications. Flows should only perform (at most) 2 cache accesses: one to read data and one to write tokens. Reading data multiple times (e.g. read all ATs, read all RTs) should not refresh the cache from disk because of performance impact. Write operations are still the responsibility of TokenCache. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheSessionManager.RefreshCacheForReadOperationsAsync(Microsoft.Identity.Client.TelemetryCore.Internal.Events.CacheEvent.TokenTypes)"> <remarks> Possibly refreshes the internal cache by calling OnBeforeAccessAsync and OnAfterAccessAsync delegates. </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.WithExpiresOn(System.DateTimeOffset)"> <summary> Creates a new object with a different expires on </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.OboCacheKey"> <summary> Used to find the token in the cache. Can be a token assertion hash (normal OBO flow) or a user provided key (long-running OBO flow). </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.KeyId"> <summary> Used when the token is bound to a public / private key pair which is identified by a key id (kid). Currently used by PoP tokens </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem"> <summary> Example account json: "authority_type":"MSSTS", "client_info":"", "environment":"login.windows.net", "family_name":"", "given_name":"Some Name", "home_account_id":"69c374a4-1df6-46f8-b83a-a2fcd8823ee2.49f548d0-12b7-4169-a390-bb5304d24462", "local_account_id":"69c374a4-1df6-46f8-b83a-a2fcd8823ee2", "middle_name":"", "name":"Some Name", "realm":"49f548d0-12b7-4169-a390-bb5304d24462", "username":"subzero@bogavrilltd.onmicrosoft.com", "wam_account_ids":"{\"00000000480FA373\":\"ob7b8h79td9gs6hfqoh2r37m\",\"4b0db8c2-9f26-4417-8bde-3f0e3656f8e0\":\"ob7b8h79td9gs6hfqoh2r37m\"}" </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem.WamAccountIds"> <summary> WAM special implementation: MSA accounts (and also AAD accounts on UWP) cannot be discovered through WAM however the broker offers an interactive experience for the user to login, even with an MSA account. After an interactive login, MSAL must be able to silently login the MSA user. To do this, MSAL must save the account ID in its token cache. Accounts with associated WAM account ID can be used in silent WAM flows. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem"> <summary> Apps shouldn't rely on its presence, unless the app itself wrote it. It means that SDK should translate absence of app metadata to the default values of its required fields. Other apps that don't support app metadata should never remove existing app metadata. App metadata is a non-removable entity.It means there's no need for a public API to remove app metadata, and it shouldn't be removed when removeAccount is called. App metadata is a non-secret entity. It means that it cannot store any secret information, like tokens, nor PII, like username etc. App metadata can be extended by adding additional fields when required.Absense of any non-required field should translate to default values for those field. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.ClientId"> <remarks>mandatory</remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.Environment"> <remarks>mandatory</remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.FamilyId"> <summary> The family id of which this application is part of. This is an internal feature and there is currently a single app, with id 1. If familyId is empty, it means an app is not part of a family. A missing entry means unknown status. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.Items.MsalItemWithAdditionalFields.PopulateFieldsFromJObject(Microsoft.Identity.Json.Linq.JObject)"> <remarks> Important: order matters. This MUST be the last one called since it will extract the remaining fields out. </remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.FamilyId"> <summary> Optional. A value here means the token in an FRT. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.OboCacheKey"> <summary> Used to find the token in the cache. Can be a token assertion hash (normal OBO flow) or a user provided key (long-running OBO flow). </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.IsFRT"> <summary> Family Refresh Tokens, can be used for all clients part of the family </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllAccessTokens(System.String)"> <summary> Returns all access tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns access tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllRefreshTokens(System.String)"> <summary> Returns all refresh tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns refresh tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllIdTokens(System.String)"> <summary> Returns all ID tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns ID tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllAccounts(System.String)"> <summary> Returns all accounts from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns accounts from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.HasAccessOrRefreshTokens"> <remarks> WARNING: this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </remarks> </member> <member name="T:Microsoft.Identity.Client.Cache.Keys.MsalAccessTokenCacheKey"> <summary> An object representing the key of the token cache AT dictionary. The format of the key is not important for this library, as long as it is unique. </summary> <remarks>The format of the key is platform dependent</remarks> </member> <member name="T:Microsoft.Identity.Client.Cache.Keys.MsalAccountCacheKey"> <summary> An object representing the key of the token cache Account dictionary. The format of the key is not important for this library, as long as it is unique. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Keys.MsalAppMetadataCacheKey"> <summary> App metadata is an optional entity in cache and can be used by apps to store additional metadata applicable to a particular client. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.Keys.MsalAppMetadataCacheKey.ToString"> <summary> Ex: appmetadata-login.microsoftonline.com-b6c69a37-df96-4db0-9088-2ab96e1d8215 </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Cache.Keys.MsalIdTokenCacheKey"> <summary> An object representing the key of the token cache Id Token dictionary. The format of the key is not important for this library, as long as it is unique. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Keys.MsalRefreshTokenCacheKey"> <summary> An object representing the key of the token cache RT dictionary. The format of the key is not important for this library, as long as it is unique. </summary> <remarks> Normal RTs are scoped by env, account_id and clientID FRTs are scoped by env, account_id and familyID (clientID exists, but is irrelevant) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.Keys.MsalRefreshTokenCacheKey.#ctor(System.String,System.String,System.String,System.String)"> <summary> Constructor </summary> <param name="environment"></param> <param name="clientId"></param> <param name="userIdentifier"></param> <param name="familyId">Can be null or empty, denoting a normal RT. A value signifies an FRT.</param> </member> <member name="T:Microsoft.Identity.Client.Cache.TokenCacheDictionarySerializer"> <remarks> The dictionary serializer does not handle unknown nodes. </remarks> </member> <member name="T:Microsoft.Identity.Client.CacheRefreshReason"> <summary> Specifies the reason for fetching the access token from the identity provider when using AcquireTokenSilent, AcquireTokenForClient or AcquireTokenOnBehalfOf. </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.NotApplicable"> <summary> When a token is found in the cache or the cache is not supposed to be hit when making the request (interactive call, username password call, device code flow, etc.) </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.ForceRefreshOrClaims"> <summary> When the token request goes to the identity provider because force_refresh was set to true. Also occurs if WithClaims() is used. </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.NoCachedAccessToken"> <summary> When the token request goes to the identity provider because no cached access token exists </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.Expired"> <summary> When the token request goes to the identity provider because cached access token expired </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.ProactivelyRefreshed"> <summary> When the token request goes to the identity provider because refresh_in was used and the existing token needs to be refreshed </summary> </member> <member name="T:Microsoft.Identity.Client.ClientApplicationBase"> <summary> Abstract class containing common API methods and properties. Both <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> and ConfidentialClientApplication extend this class. For details see https://aka.ms/msal-net-client-applications </summary> <summary> Abstract class containing common API methods and properties. Both <see cref="T:PublicClientApplication"/> and <see cref="T:ConfidentialClientApplication"/> extend this class. For details see https://aka.ms/msal-net-client-applications </summary> </member> <member name="F:Microsoft.Identity.Client.ClientApplicationBase.DefaultAuthority"> <summary> Default Authority used for interactive calls. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.AppConfig"> <summary> Details on the configuration of the ClientApplication for debugging purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Authority"> <summary> Gets the URL of the authority, or security token service (STS) from which MSAL.NET will acquire security tokens The return value of this property is either the value provided by the developer in the constructor of the application, or otherwise the value of the <see cref="F:Microsoft.Identity.Client.ClientApplicationBase.DefaultAuthority"/> static member (that is <c>https://login.microsoftonline.com/common/</c>) </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.UserTokenCache"> <summary> User token cache. It holds access tokens, id tokens and refresh tokens for accounts. It's used and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or one of the overrides of <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application cache (see <c>IConfidentialClientApplication</c>). </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on mobile platforms and on UWP. It is recommended to use token cache serialization for web site and web api scenarios. </remarks> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.Threading.CancellationToken)"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String,System.Threading.CancellationToken)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> <param name="cancellationToken">Cancellation token </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String,System.Threading.CancellationToken)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache. </summary> <param name="accountId">Account identifier. The identifier is typically the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property> </param> <param name="cancellationToken">Cancellation token </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache. </summary> <param name="accountId">Account identifier. The identifier is typically the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property> </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">Instance of the account that needs to be removed</param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount,System.Threading.CancellationToken)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">Instance of the account that needs to be removed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> [V3 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested.</param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned. If the access token is expired or close to expiration - within a 5 minute window - then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. You can set additional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V3 API] Attempts to acquire an access token for the <see cref="T:Microsoft.Identity.Client.IAccount"/> having the <see cref="P:Microsoft.Identity.Client.IAccount.Username" /> match the given <paramref name="loginHint"/>, from the user token cache. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Typically the username, in UPN format, e.g. johnd@contoso.com </param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> If multiple <see cref="T:Microsoft.Identity.Client.IAccount"/> match the <paramref name="loginHint"/>, or if there are no matches, an exception is thrown. The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned. If the access token is expired or close to expiration - within a 5 minute window - then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. You can set additional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Users"> <summary> In MSAL 1.x returned an enumeration of <see cref="T:Microsoft.Identity.Client.IUser"/>. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetUser(System.String)"> <summary> In MSAL 1.x, return a user from its identifier. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="identifier">Identifier of the user to retrieve</param> <returns>the user in the cache with the identifier passed as an argument</returns> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)"> <summary> In MSAL 1.x removed a user from the cache. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="user">User to remove from the cache</param> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.SliceParameters"> <summary> Sets or Gets a custom query parameters that may be sent to the STS for dogfood testing or debugging. This is a string of segments of the form <c>key=value</c> separated by an ampersand character. Unless requested otherwise, this parameter should not be set by application developers as it may have adverse effect on the application. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.ValidateAuthority"> <summary> Gets/sets a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default value is <c>true</c>. It should currently be set to <c>false</c> for Azure AD B2C authorities as those are customer specific (a list of known B2C authorities cannot be maintained by MSAL.NET). This property can be set just after the construction of the application and before an operation acquiring a token or interacting with the STS. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.RedirectUri"> <summary> The redirect URI (also known as Reply URI or Reply URL), is the URI at which Azure AD will contact back the application with the tokens. This redirect URI needs to be registered in the app registration (https://aka.ms/msal-net-register-app). In MSAL.NET, <see cref="T:PublicClientApplication"/> define the following default RedirectUri values: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/common/oauth2/nativeclient</c> for desktop (.NET Framework and .NET Core) applications</description></item> <item><description><c>msal{ClientId}</c> for Xamarin iOS and Xamarin Android (as this will be used by the system web browser by default on these platforms to call back the application) </description></item> </list> These default URIs could change in the future. In Microsoft.Identity.Client.ConfidentialClientApplication, this can be the URL of the web application / web API. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal</remarks> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.ClientId"> <summary> Gets the Client ID (also known as <i>Application ID</i>) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) and as passed in the constructor of the application </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)"> <summary> [V2 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache, with advanced parameters controlling network call. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured in the application constructor narrows down the selection to a specific tenant. This does not change the configured value in the application. This is specific to applications managing several accounts (like a mail client with several mailboxes)</param> <param name="forceRefresh">If <c>true</c>, ignore any access token in the cache and attempt to acquire new access token using the refresh token for the account if this one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token</param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested access token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> [V2 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance so that the user consents, or re-signs-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplication"> <summary> Class to be used for confidential client applications (web apps, web APIs, and daemon applications). </summary> <remarks> Confidential client applications are typically applications which run on servers (web apps, web API, or even service/daemon applications). They are considered difficult to access, and therefore capable of keeping an application secret (hold configuration time secrets as these values would be difficult for end users to extract). A web app is the most common confidential client. The clientId is exposed through the web browser, but the secret is passed only in the back channel and never directly exposed. For details see https://aka.ms/msal-net-client-applications </remarks> </member> <member name="F:Microsoft.Identity.Client.ConfidentialClientApplication.AttemptRegionDiscovery"> <summary> Instructs MSAL to try to auto discover the Azure region. </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and can request an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can set optional parameters by chaining the builder with other .With methods. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"> <summary> Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. See https://aka.ms/msal-net-client-credentials. </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are defined statically with the application registration in the portal, and cannot be overridden in the application.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> Acquires an access token for this application (usually a Web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-on-behalf-of. This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"> <summary> Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request to get the URL of the STS authorization endpoint parametrized with the parameters</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplication.AppTokenCache"> <summary> Application token cache. This case holds access tokens for the application. It's maintained and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplication.Certificate"> <summary> The certificate used to create this <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, if any. </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.#ctor(System.String,System.String,Microsoft.Identity.Client.ClientCredential,Microsoft.Identity.Client.TokenCache,Microsoft.Identity.Client.TokenCache)"> <summary> [V2 API] Constructor for a confidential client application requesting tokens with the default authority (<see cref="F:Microsoft.Identity.Client.ClientApplicationBase.DefaultAuthority"/>) </summary> <param name="clientId">Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> <param name="redirectUri">URL where the STS will call back the application with the security token. REQUIRED</param> <param name="clientCredential">Credential, previously shared with Azure AD during the application registration and proving the identity of the application. An instance of <see cref="P:Microsoft.Identity.Client.ConfidentialClientApplication.ClientCredential"/> can be created either from an application secret, or a certificate. REQUIRED.</param> <param name="userTokenCache">Token cache for saving user tokens. Can be set to null if the confidential client application only uses the Client Credentials grants (that is requests token in its own name and not in the name of users). Otherwise should be provided. REQUIRED</param> <param name="appTokenCache">Token cache for saving application (that is client token). Can be set to <c>null</c> except if the application uses the client credentials grants</param> <remarks> See https://aka.ms/msal-net-client-applications for a description of confidential client applications (and public client applications) Client credential grants are overrides of <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"/> See also <see cref="T:ConfidentialClientApplicationBuilder"/> for the V3 API way of building a confidential client application with a builder pattern. It offers building the application from configuration options, and a more fluid way of providing parameters. </remarks> <seealso cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> which enables app developers to specify the authority </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.#ctor(System.String,System.String,System.String,Microsoft.Identity.Client.ClientCredential,Microsoft.Identity.Client.TokenCache,Microsoft.Identity.Client.TokenCache)"> <summary> [V2 API] Constructor for a confidential client application requesting tokens with a specified authority </summary> <param name="clientId">Client ID (also named Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> <param name="authority">Authority of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c>, where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in users of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to sign-in users with any work and school accounts or Microsoft personal accounts</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to sign-in users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to sign-in users with only personal Microsoft accounts(live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal </param> <param name="redirectUri">URL where the STS will call back the application with the security token. REQUIRED</param> <param name="clientCredential">Credential, previously shared with Azure AD during the application registration and proving the identity of the application. An instance of <see cref="P:Microsoft.Identity.Client.ConfidentialClientApplication.ClientCredential"/> can be created either from an application secret, or a certificate. REQUIRED.</param> <param name="userTokenCache">Token cache for saving user tokens. Can be set to null if the confidential client application only uses the Client Credentials grants (that is requests token in its own name and not in the name of users). Otherwise should be provided. REQUIRED</param> <param name="appTokenCache">Token cache for saving application (that is client token). Can be set to <c>null</c> except if the application uses the client credentials grants</param> <remarks> See https://aka.ms/msal-net-client-applications for a description of confidential client applications (and public client applications) Client credential grants are overrides of <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"/> See also <see cref="T:ConfidentialClientApplicationBuilder"/> for the V3 API way of building a confidential client application with a builder pattern. It offers building the application from configuration options, and a more fluid way of providing parameters. </remarks> <seealso cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> which enables app developers to create a confidential client application requesting tokens with the default authority. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"/> for the on-behalf-of flow when specifying the authority <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from a specific authority, in order to access another downstream protected web API on behalf of a user (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> for the on-behalf-of flow without specifying the authority <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. This override sends the certificate, which helps certificate rotation in Azure AD </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from a specific authority, in order to access another downstream protected web API on behalf of a user (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the This override sends the certificate, which helps certificate rotation in Azure AD <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCodeAsync(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and therefore receive an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="authorizationCode">The authorization code received from service authorization endpoint.</param> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing token of the user for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"/> which is the corresponding V2 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application. See also </param> <returns>Authentication result containing the token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) </summary> <param name="scopes">Scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application</param> <param name="forceRefresh">If <c>true</c>, API will ignore the access token in the cache and attempt to acquire new access token using client credentials. This override can be used in case the application knows that conditional access policies changed</param> <returns>Authentication result containing token of the user for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation) </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing application token for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method attempts to look up valid access token in the cache unless<paramref name="forceRefresh"/> is true This method enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation) </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param> <returns>Authentication result containing application token for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IByRefreshToken#AcquireTokenByRefreshTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it and the refresh token into the application user token cache, where it will be available for further AcquireTokenSilentAsync calls. This method can be used in migration to MSAL from ADAL v2 and in various integration scenarios where you have a RefreshToken available. (see https://aka.ms/msal-net-migration-adal2-msal2) </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token (for example previously obtained from ADAL 2.x)</param> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> [V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally a UPN. This can be empty</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>URL of the authorize endpoint including the query parameters.</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority specified as the <paramref name="authority"/> parameter. This override enables you to specify a redirectUri, login hint extra query parameters, extra scope to consent (which are not for the same resource as the <paramref name="scopes"/>), and an authority. </summary> <param name="scopes">Scopes requested to access a protected API (a resource)</param> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes for additional resources (other than the resource for which <paramref name="scopes"/> are requested), which a developer can request the user to consent to upfront.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>URL of the authorize endpoint including the query parameters.</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="T:Microsoft.Identity.Client.DeviceCodeResult"> <summary> This object is returned as part of the device code flow and has information intended to be shown to the user about where to navigate to login and what the device code needs to be entered on that device. See https://aka.ms/msal-device-code-flow. </summary> <seealso cref="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> and the other overrides </seealso> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.UserCode"> <summary> User code returned by the service </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.DeviceCode"> <summary> Device code returned by the service </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.VerificationUrl"> <summary> Verification URL where the user must navigate to authenticate using the device code and credentials. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.ExpiresOn"> <summary> Time when the device code will expire. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Interval"> <summary> Polling interval time to check for completion of authentication flow. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Message"> <summary> User friendly text response that can be used for display purpose. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.ClientId"> <summary> Identifier of the client requesting device code. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Scopes"> <summary> List of the scopes that would be held by token. </summary> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AcquireTokenInteractiveParameterBuilderExtensions"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.AcquireTokenInteractiveParameterBuilderExtensions.WithCustomWebUi(Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder,Microsoft.Identity.Client.Extensibility.ICustomWebUi)"> <summary> Extension method enabling MSAL.NET extenders for public client applications to set a custom web UI that will let the user sign-in with Azure AD, present consent if needed, and get back the authorization code </summary> <param name="builder">Builder for an AcquireTokenInteractive</param> <param name="customWebUi">Customer implementation for the Web UI</param> <returns>the builder to be able to chain .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.Extensibility.ICustomWebUi"> <summary> Interface that an MSAL.NET extender can implement to provide their own web UI in public client applications to sign-in user and have them consented part of the Authorization code flow. MSAL.NET provides an embedded web view for Windows and Mac, but there are other scenarios not yet supported. This extensibility point enables them to provide such UI in a secure way </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.ICustomWebUi.AcquireAuthorizationCodeAsync(System.Uri,System.Uri,System.Threading.CancellationToken)"> <summary> Method called by MSAL.NET to delegate the authentication code web with the Secure Token Service (STS) </summary> <param name="authorizationUri"> URI computed by MSAL.NET that will let the UI extension navigate to the STS authorization endpoint in order to sign-in the user and have them consent </param> <param name="redirectUri">The redirect URI that was configured. The auth code will be appended to this redirect URI and the browser will redirect to it. </param> <param name="cancellationToken">The cancellation token to which you should respond to. See https://docs.microsoft.com/en-us/dotnet/standard/parallel-programming/task-cancellation for details. </param> <returns> The URI returned back from the STS authorization endpoint. This URI contains a code=CODE parameters that MSAL.NET will extract and redeem. </returns> <remarks> The <paramref name="authorizationUri">authorizationUri</paramref>"/> is crafted to leverage PKCE in order to protect the token from a man in the middle attack. Only MSAL.NET can redeem the code. In the event of cancellation, the implementer should return OperationCanceledException. </remarks> </member> <member name="T:Microsoft.Identity.Client.Advanced.AcquireTokenParameterBuilderExtensions"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Advanced.AcquireTokenParameterBuilderExtensions.WithExtraHttpHeaders``1(Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder{``0},System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Adds additional Http Headers to the token request. </summary> <param name="builder">Parameter builder for a acquiring tokens.</param> <param name="extraHttpHeaders">additional Http Headers to add to the token request.</param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.SSHCertificates.SSHExtensions"> <summary> Extensions that add support for SSH certificates </summary> </member> <member name="M:Microsoft.Identity.Client.SSHCertificates.SSHExtensions.WithSSHCertificateAuthenticationScheme(Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder,System.String,System.String)"> <summary> Instructs AAD to return an SSH certificate instead of a Bearer token. The SSH certificate (not the same as public / private key pair used by SSH), can be used to securely deploy a public SSH key to a machine. See https://aka.ms/msal-net-ssh for details. </summary> <param name="builder">Interactive authentication builder</param> <param name="publicKeyJwk">The public SSH key in JWK format (https://tools.ietf.org/html/rfc7517). Currently only RSA is supported, and the JWK should contain only the RSA modulus and exponent</param> <param name="keyId">A key identifier, it can be in any format. Used to distinguish between different keys when fetching an SSH certificate from the token cache.</param> </member> <member name="M:Microsoft.Identity.Client.SSHCertificates.SSHExtensions.WithSSHCertificateAuthenticationScheme(Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder,System.String,System.String)"> <summary> Instructs AAD to return an SSH certificate instead of a Bearer token. Attempts to retrieve the certificate from the token cache, and if one is not found, attempts to acquire one silently, using the refresh token. See https://aka.ms/msal-net-ssh for details. </summary> <remarks> The same keyID must be used to distinguish between various </remarks> <param name="builder">Silent authentication builder</param> <param name="publicKeyJwk">The public SSH key in JWK format (https://tools.ietf.org/html/rfc7517). Currently only RSA is supported, and the JWK should contain only the RSA modulus and exponent</param> <param name="keyId"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Http.HttpManager"> <remarks> We invoke this class from different threads and they all use the same HttpClient. To prevent race conditions, make sure you do not get / set anything on HttpClient itself, instead rely on HttpRequest objects which are thread specific. In particular, do not change any properties on HttpClient such as BaseAddress, buffer sizes and Timeout. You should also not access DefaultRequestHeaders because the getters are not thread safe (use HttpRequestMessage.Headers instead). </remarks> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManager.SendPostForceResponseAsync(System.Uri,System.Collections.Generic.Dictionary{System.String,System.String},System.Net.Http.StringContent,Microsoft.Identity.Client.Core.ICoreLogger,System.Threading.CancellationToken)"> <summary> Performs the POST request just like <see cref="M:Microsoft.Identity.Client.Http.HttpManager.SendPostAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Net.Http.HttpContent,Microsoft.Identity.Client.Core.ICoreLogger,System.Threading.CancellationToken)"/> but does not throw a ServiceUnavailable service exception. Instead, it returns the <see cref="T:Microsoft.Identity.Client.Http.HttpResponse"/> associated with the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Http.RedirectUriHelper.Validate(System.Uri,System.Boolean)"> <summary> Check common redirect URI problems. Optionally check that the redirect URI is not the OAuth2 standard redirect URI https://login.microsoftonline.com/common/oauth2/nativeclientb when using a system browser, because the browser cannot redirect back to the app. </summary> </member> <member name="T:Microsoft.Identity.Client.IAccount"> <summary> The IAccount interface represents information about a single account. The same user can be present in different tenants, that is, a user can have multiple accounts. An <c>IAccount</c> is returned in the <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/>.<see cref="P:Microsoft.Identity.Client.AuthenticationResult.Account"/> property, and can be used as parameters of PublicClientApplication and ConfidentialClientApplication methods acquiring tokens such as <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAccount.Username"> <summary> Gets a string containing the displayable value in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c>. This can be null. </summary> <remarks>This property replaces the <c>DisplayableId</c> property of <c>IUser</c> in previous versions of MSAL.NET</remarks> </member> <member name="P:Microsoft.Identity.Client.IAccount.Environment"> <summary> Gets a string containing the identity provider for this account, e.g. <c>login.microsoftonline.com</c>. </summary> <remarks>This property replaces the <c>IdentityProvider</c> property of <c>IUser</c> in previous versions of MSAL.NET except that IdentityProvider was a URL with information about the tenant (in addition to the cloud environment), whereas Environment is only the <see cref="P:System.Uri.Host"/></remarks> </member> <member name="P:Microsoft.Identity.Client.IAccount.HomeAccountId"> <summary> AccountId of the home account for the user. This uniquely identifies the user across AAD tenants. </summary> <remarks>Can be null, for example if this account was migrated to MSAL.NET from ADAL.NET v3's token cache</remarks> </member> <member name="T:Microsoft.Identity.Client.IByRefreshToken"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshToken(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it, and the refresh token, in the user token cache, where it will be available for further AcquireTokenSilent calls. This method can be used in migration to MSAL from ADAL v2, and in various integration scenarios where you have a RefreshToken available. See https://aka.ms/msal-net-migration-adal2-msal2. </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token from ADAL 2.x</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it and the refresh token into the user token cache, where it will be available for further AcquireTokenSilentAsync calls. This method can be used in migration to MSAL from ADAL v2 and in various integration scenarios where you have a RefreshToken available. (see https://aka.ms/msal-net-migration-adal2-msal2) </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token from ADAL 2.x</param> </member> <member name="T:Microsoft.Identity.Client.IClientApplicationBase"> <summary> Abstract class containing common API methods and properties. Both <see cref="T:PublicClientApplication"/> and <see cref="T:ConfidentialClientApplication"/> extend this class. For details see https://aka.ms/msal-net-client-applications. </summary> <summary> Interface defining common API methods and properties. Both <see cref="T:PublicClientApplication"/> and <see cref="T:ConfidentialClientApplication"/> extend this class. For details see https://aka.ms/msal-net-client-applications </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.AppConfig"> <summary> Details on the configuration of the ClientApplication for debugging purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.UserTokenCache"> <summary> User token cache. This case holds id tokens, access tokens and refresh tokens for accounts. It's used and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application cache (see <c>IConfidentialClientApplication</c>). </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms. </remarks> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Authority"> <summary> Gets the URL of the authority, or the security token service (STS) from which MSAL.NET will acquire security tokens. The return value of this property is either the value provided by the developer in the constructor of the application, or otherwise the value of the <see cref="P:Microsoft.Identity.Client.ClientApplicationBase.Authority"/> static member (that is <c>https://login.microsoftonline.com/common/</c>) </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache and of the same environment (authority host) as <see cref="P:Microsoft.Identity.Client.IClientApplicationBase.Authority"/> </summary> <param name="identifier">Account identifier. The value of the identifier will probably have been stored value from the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property></param> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Attempts to acquire an access token for the <paramref name="account"/> from the user token cache, with advanced parameters controlling the network call. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See also the additional parameters that you can set chain: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Attempts to acquire an access token for the <paramref name="loginHint"/> from the user token cache, with advanced parameters controlling the network call. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Typically the username, in UPN format, e.g. johnd@contoso.com </param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See also the additional parameters that you can set chain: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">instance of the account that needs to be removed</param> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Users"> <summary> In MSAL 1.x returned an enumeration of <see cref="T:Microsoft.Identity.Client.IUser"/>. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetUser(System.String)"> <summary> In MSAL 1.x, return a user from its identifier. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="identifier">Identifier of the user to retrieve</param> <returns>the user in the cache with the identifier passed as an argument</returns> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)"> <summary> In MSAL 1.x removed a user from the cache. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="user">User to remove from the cache</param> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.SliceParameters"> <summary> Sets or Gets a custom query parameters that may be sent to the STS for dogfood testing or debugging. This is a string of segments of the form <c>key=value</c> separated by an ampersand character. Unless requested otherwise, this parameter should not be set by application developers as it may have adverse effect on the application. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.ValidateAuthority"> <summary> Gets a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default value is <c>true</c>. It should currently be set to <c>false</c> for Azure AD B2C authorities as those are customer specific (a list of known B2C authorities cannot be maintained by MSAL.NET) </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.RedirectUri"> <summary> The redirect URI (also known as Reply URI or Reply URL), is the URI at which Azure AD will contact back the application with the tokens. This redirect URI needs to be registered in the app registration (https://aka.ms/msal-net-register-app) In MSAL.NET, <see cref="T:PublicClientApplication"/> define the following default RedirectUri values: <list type="bullet"> <item><description><c>urn:ietf:wg:oauth:2.0:oob</c> for desktop (.NET Framework and .NET Core) applications</description></item> <item><description><c>msal{ClientId}</c> for Xamarin iOS and Xamarin Android (as this will be used by the system web browser by default on these platforms to call back the application) </description></item> </list> These default URIs could change in the future. In <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, this can be the URL of the web application / web API. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal. </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance so that the user consents, or re-signs-in (for instance if the password expirred), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acuiretokensilent for more details </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)"> <summary> Attempts to acquire and access token for the <paramref name="account"/> from the user token cache, with advanced parameters making a network call. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured in the application constructor narrows down the selection of tenants for which to get a tenant, but does not change the configured value</param> <param name="forceRefresh">If <c>true</c>, the will ignore the access token in the cache and attempt to acquire new access token using the refresh token for the account if this one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applies immediately, rather than after the expiration of the access token</param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consents, or re-sign-in (for instance if the password expirred), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.ClientId"> <summary> Gets the Client ID (also known as Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) and as passed in the constructor of the application. </summary> </member> <member name="T:Microsoft.Identity.Client.IConfidentialClientApplication"> <summary> Component to be used with confidential client applications like web apps/API. </summary> <summary> Component to be used with confidential client applications like web apps/APIs. </summary> </member> <member name="P:Microsoft.Identity.Client.IConfidentialClientApplication.AppTokenCache"> <summary> Application token cache. This case holds access tokens for the application. It's maintained and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms. </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V3 API] Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and can request an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can set optional parameters by chaining the builder with, for example <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/>, </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. See https://aka.ms/msal-net-client-credentials. </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V3 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-on-behalf-of. This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request to get the URL of the STS authorization endpoint parameterized with the parameters</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAccountsAsync"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V3 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V3 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenByAuthorizationCodeAsync(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires security token from the authority using authorization code previously received. This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="authorizationCode">The authorization code received from service authorization endpoint.</param> <param name="scopes">Array of scopes requested for resource</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires token from the service for the confidential client. This method attempts to look up valid access token in the cache. </summary> <param name="scopes">Array of scopes requested for resource</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires token from the service for the confidential client. This method attempts to look up valid access token in the cache. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> [V2 API] URL of the authorize endpoint including the query parameters. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param> <returns>URL of the authorize endpoint including the query parameters.</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V2 API] Gets URL of the authorize endpoint including the query parameters. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param> <param name="extraScopesToConsent">Array of scopes for which a developer can request consent upfront.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>URL of the authorize endpoint including the query parameters.</returns> </member> <member name="T:Microsoft.Identity.Client.ILongRunningWebApi"> <summary> Methods for long running processes in web APIs </summary> </member> <member name="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"> <summary> Acquires an access token for this web API from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-long-running-obo . This confidential client application was itself called with a token which will be provided in the <paramref name="userToken">userToken</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userToken">A JSON Web Token which was used to call the web API and contains the credential information about the user on behalf of whom to get a token.</param> <param name="longRunningProcessSessionKey">Key by which to look up the token in the cache. If null, it will be set to the assertion hash by default.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Retrieves an access token from the cache using the provided cache key that can be used to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-long-running-obo . </summary> <remarks> This method is intended to be used in the long running processes inside of web APIs. </remarks> <param name="scopes">Scopes requested to access a protected API</param> <param name="longRunningProcessSessionKey">Key by which to look up the token in the cache</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <exception cref="T:Microsoft.Identity.Client.MsalClientException"> is thrown if the token cache does not contain a token with an OBO cache key that matches the <paramref name="longRunningProcessSessionKey"/>.</exception> </member> <member name="T:Microsoft.Identity.Client.Instance.Authority"> <remarks> Must be kept immutable </remarks> </member> <member name="M:Microsoft.Identity.Client.Instance.Authority.CreateAuthorityForRequestAsync(Microsoft.Identity.Client.Internal.RequestContext,Microsoft.Identity.Client.AuthorityInfo,System.String)"> <summary> Figures out the authority based on the authority from the config and the authority from the request, and optionally the homeAccountTenantId, which has an impact on AcquireTokenSilent The algorithm is: 1. If there is no request authority (i.e. no authority override), use the config authority. 1.1. For AAD, if the config authority is "common" etc, try to use the tenanted version with the home account tenant ID 2. If there is a request authority, try to use it. 2.1. If the request authority is not "common", then use it 2.2 If the request authority is "common", ignore it, and use 1.1 Special cases: - if the authority is not defined at the application level and the request level is not AAD, use the request authority - if the authority is defined at app level, and the request level authority of is of different type, throw an exception </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Authority.GetTenantedAuthority(System.String,System.Boolean)"> <summary> Gets a tenanted authority if the current authority is tenant-less. Returns the original authority on B2C and ADFS </summary> </member> <member name="T:Microsoft.Identity.Client.Instance.AuthorityManager"> <summary> This object is at REQUEST level. </summary> </member> <member name="T:Microsoft.Identity.Client.Instance.Discovery.IInstanceDiscoveryManager"> <summary> Provides instance metadata across all authority types. Deals with metadata caching. </summary> </member> <member name="T:Microsoft.Identity.Client.Instance.Discovery.InstanceDiscoveryManager"> <summary> Priority order of metadata providers: If user provided metadata via <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.String)"/> use it exclusively. Otherwise: 1. Static cache (this is populated from the network) 2. Well-known cache if all environments present in the token cache are known (this is hard-coded into MSAL) 3. Cache stored in token cache (Not currently implemented) 5. AAD discovery endpoint 6. If going to the network fails with an error different than "invalid_instance" (i.e.authority validation failed), use the well-known instance metadata entry for the given authority 7. On failure, use the authority itself(i.e.preferred cache = preferred network = aliases = configured_authority) Spec: https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=%2FInstance%20Discovery%20Caching%2Fdesktop_web_caching.md </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.AadAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <summary> AAD performs authority validation by calling the instance metadata endpoint. This is a bit unfortunate, because instance metadata is used for aliasing, and authority validation is orthogonal to that. MSAL must figure out aliasing even if ValidateAuthority is set to false. </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.B2CAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.IAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <summary> Validates the authority. This is specific to each authority type. </summary> </member> <member name="M:Microsoft.Identity.Client.Region.IRegionManager.GetAzureRegionAsync(Microsoft.Identity.Client.Internal.RequestContext)"> <summary> Gets the azure region and adds telemetry to the ApiEvents </summary> <returns>Returns null if region should not be used or cannot be discovered.</returns> </member> <member name="T:Microsoft.Identity.Client.Region.RegionAutodetectionSource"> <summary> Indicates where the region information came from. </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.None"> <summary> Indicates that the API .WithAzureRegion() was not used </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.FailedAutoDiscovery"> <summary> Auto-detection failed, fallback to global </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.Cache"> <summary> Auto-detected from MSAL's static cache </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.EnvVariable"> <summary> Auto-detected from Env Variable </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.Imds"> <summary> Auto-detected from IMDS </summary> </member> <member name="T:Microsoft.Identity.Client.Region.RegionOutcome"> <summary> Indicates where the region information came from. </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.None"> <summary> Indicates that the API .WithAzureRegion() was not used </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedValid"> <summary> Region provided by the user, matches auto detected region </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedAutodetectionFailed"> <summary> Region provided by the user, auto detection cannot be done </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedInvalid"> <summary> Region provided by the user, does not match auto detected region </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.AutodetectSuccess"> <summary> Region autodetect requested and was successful </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.FallbackToGlobal"> <summary> Region autodetect requested but failed. Fallback to global </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Broker.BrokerResponseConst"> <summary> For Android there are from: https://github.com/AzureAD/microsoft-authentication-library-common-for-android/blob/dev/common/src/main/java/com/microsoft/identity/common/internal/broker/BrokerResult.java </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.Broker.IBroker.HandleInstallUrl(System.String)"> <summary> If device auth is required but the broker is not enabled, AAD will signal this by returning an URL pointing to the broker app that needs to be installed. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Broker.NullBroker"> <summary> For platforms that do not support a broker </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.ClientCredentialWrapper"> <summary> Meant to be used in confidential client applications, an instance of <c>ClientCredential</c> is passed to the constructors of (<see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>) as credentials proving that the application (the client) is what it claims it is. These credentials can be either a client secret (an application password) or a certificate. This class has one constructor for each case. These credentials are added in the application registration portal (in the secret section). </summary> <remarks> Important: this object is held at APP level and shared between all request, so it MUST be kept immutable </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.IServiceBundle.ApplicationLogger"> <summary> When outside of a request, the normal logger (requestContext.Logger) is not available. This logger is at the app level - it is just not tied to a correlation ID. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.JsonWebToken.JWTHeaderWithCertificate.X509CertificateThumbprint"> <summary> x5t = base64 URL encoded cert thumbprint </summary> <remarks> Mandatory for ADFS 2019 </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.JsonWebToken.JWTHeaderWithCertificate.X509CertificateKeyId"> <summary> kid (key id) = cert thumbprint </summary> <remarks> Key Id is an optional param, but recommended. Wilson adds both kid and x5t to JWT header </remarks> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.Algorithm"> <summary> Encryption algorithm used, e.g. ES256 https://tools.ietf.org/html/rfc7515#section-4.1.1 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.Type"> <summary> The type of token e.g. JWT https://tools.ietf.org/html/rfc7519#section-5.1 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.KeyId"> <summary> Key ID, can be an X509 cert thumbprint. When used with a JWK, the "kid" value is used to match a JWK "kid" parameter value https://tools.ietf.org/html/rfc7515#section-4.1.4 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.Product"> <summary> MSAL Flavor: .NET or WinRT </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.Version"> <summary> MSAL assembly version </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.CpuPlatform"> <summary> CPU platform with x86, x64 or ARM as value </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.OS"> <summary> Version of the operating system. This will not be sent on WinRT </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.DeviceModel"> <summary> Device model. This will not be sent on .NET </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.MsalIdHelper"> <summary> This class adds additional query parameters or headers to the requests sent to STS. This can help us in collecting statistics and potentially on diagnostics. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.RequestContext.ApiEvent"> <summary> One and only one ApiEvent is associated with each request. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters"> <summary> This class is responsible for merging app level and request level parameters. Not all parameters need to be merged - app level parameters can be accessed via AppConfig property </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.Authority"> <summary> Authority is the URI used by MSAL for communication and storage During a request it can be updated: - with the preferred environment - with actual tenant </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.Claims"> <summary> Indicates if the user configured claims via .WithClaims. Not affected by Client Capabilities </summary> <remarks>If user configured claims, request should bypass cache</remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.UserAssertion"> <remarks> User assertion is null when <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/> is called. </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.LongRunningOboCacheKey"> <summary> User-provided cache key for long-running OBO flow. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.IntegratedWindowsAuthRequest"> <summary> Handles requests that are non-interactive. Currently MSAL supports Integrated Windows Auth (IWA). </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.InteractiveRequest"> <summary> This class decides the workflow of an interactive request. The business rules are: 1. If WithBroker is set to true 1.1. Attempt to invoke the broker and get the token 1.2. If this fails, e.g. if broker is not installed, the use a web view (goto 2) 2. Use a webview and get an auth code and look at the auth code 2.1. If the auth code has a special format, showing that a broker is needed then. Invoke the broker flow (step 1) with a broker installation URL 2.2. Otherwise exchange the auth code for tokens (normal authorize_code grant) </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.RequestBase"> <summary> Base class for all flows. Use by implementing <see cref="M:Microsoft.Identity.Client.Internal.Requests.RequestBase.ExecuteAsync(System.Threading.CancellationToken)"/> and optionally calling protected helper methods such as SendTokenRequestAsync, which know how to use all params when making the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.Requests.RequestBase.GetOverriddenScopes(System.Collections.Generic.ISet{System.String})"> <summary> Return a custom set of scopes to override the default MSAL logic of merging input scopes with reserved scopes (openid, profile etc.) Leave as is / return null otherwise </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.UsernamePasswordRequest"> <summary> Handles requests that are non-interactive. Currently MSAL supports Integrated Windows Auth. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.AuthCodeRequestComponent"> <summary> Responsible for getting an auth code </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.SilentRequestHelper.ProcessFetchInBackground(Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem,System.Func{System.Threading.Tasks.Task{Microsoft.Identity.Client.AuthenticationResult}},Microsoft.Identity.Client.Core.ICoreLogger)"> <summary> Fire and forget the fetch action on a background thread. Do not change to Task and do not await it. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.ApplicationLogger"> <summary> This logger does not contain a correlation ID and should be used only when the correlation ID is not available i.e. before a request exists </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.HttpManager"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.MatsTelemetryManager"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.WsTrustWebRequestManager"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.PlatformProxy"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.Config"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.Mats"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Core.ICoreLogger.IsLoggingEnabled(Microsoft.Identity.Client.LogLevel)"> <summary> For expensive logging messsages (e.g. when the log message evaluates a variable), it is better to check the log level ahead of time so as not to evaluate the expensive message and then discard it. </summary> </member> <member name="T:Microsoft.Identity.Client.IPublicClientApplication"> <summary> Interface to be used with desktop or mobile applications (Desktop / UWP / Xamarin.iOS / Xamarin.Android). public client applications are not trusted to safely keep application secrets, and therefore they only access web APIs in the name of the user only. For details see https://aka.ms/msal-net-client-applications. </summary> <summary> Interface defining common API methods and properties. For details see https://aka.ms/msal-net-client-applications </summary> </member> <member name="P:Microsoft.Identity.Client.IPublicClientApplication.IsSystemWebViewAvailable"> <summary> Tells if the application can use the system web browser, therefore getting single-sign-on with web applications. By default, MSAL will try to use a system browser on the mobile platforms, if it is available. See https://aka.ms/msal-net-uses-web-browser. </summary> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire a token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant. You can also pass optional parameters by calling: <list type="table"> <item> <term><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"/> </term> <description>to specify the user experience when signing-in</description> </item> <item> <term><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"/></term> <description>to specify if you want to use the embedded web browser or the system default browser</description> </item> <item> <term><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"/></term> <description>to configure the user experience when using the Default browser</description> </item> <item> <term><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/></term> <description>to prevent the select account dialog from appearing in the case you want to sign-in a specific accounts</description> </item> <item> <term><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/></term> <description>if you want to let the user pre-consent to additional scopes (which won't be returned in the access token)</description> </item> <item> <term><see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/></term> <description>to pass additional query parameters to the Identity Provider, and <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> in order to change the tenant of the authority set at the application construction. </description> </item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a Web browser, by letting the user authenticate on another device. This is done in two steps: <list type="bullet"> <item><description>The method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> You can also pass optional parameters by calling: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the Identity Provider, and <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> in order to change the tenant of the authority set at the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> You can also pass optional parameters by calling: <see cref="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithUsername(System.String)"/> to pass the identifier of the user account for which to acquire a token with Integrated Windows authentication. This is generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com. This is normally not needed, but some Windows administrators set policies preventing applications from looking-up the signed-in user in Windows, and in that case the username needs to be passed. You can also chain with <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a security token from the authority, via Username/Password Authentication. Available only on .net desktop and .net core. See https://aka.ms/msal-net-up for details. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="password">User password as a secure string.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also pass optional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire token for the specified scopes. The user is required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for a login with control of the UI behavior and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for an account with control of the UI behavior and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. . The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and login</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a login with control of the UI behavior and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for an account with control of the UI behavior and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePasswordAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a security token from the authority, via Username/Password Authentication. See https://aka.ms/msal-net-up. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <param name="securePassword">User password.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra parameters. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra query parameters and cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <remarks> On Windows Universal Platform, the following capabilities need to be provided: Enterprise Authentication, Private Networks (Client and Server), User Account Information </remarks> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user account for which to acquire a token with Integrated Windows authentication. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="T:Microsoft.Identity.Client.TokenCacheCallback"> <summary> Notification for certain token cache interactions during token acquisition. This delegate is used in particular to provide a custom token cache serialization. See https://aka.ms/aka.ms/msal-net-token-cache-serialization </summary> <param name="args">Arguments related to the cache item impacted</param> </member> <member name="T:Microsoft.Identity.Client.ITokenCache"> <summary> This is the interface that implements the public access to cache operations. With CacheV2, this should only be necessary if the caller is persisting the cache in their own store, since this will provide the serialize/deserialize and before/after notifications used in that scenario. See https://aka.ms/aka.ms/msal-net-token-cache-serialization </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified before any library method accesses the cache. This gives an option to the delegate to deserialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. If you need async/task-based callbacks, please use SetBeforeAccessAsync instead. </summary> <param name="beforeAccess">Delegate set in order to handle the cache deserialization</param> <remarks>When the delegate is used to deserialize the cache, it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified after any library method accesses the cache. This gives an option to the delegate to serialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. If you need async/task-based callbacks, please use SetAfterAccessAsync instead. </summary> <param name="afterAccess">Delegate set in order to handle the cache serialization in the case where the <see cref="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"/> member of the cache is <c>true</c></param> <remarks>In the case where the delegate is used to serialize the cache entirely (not just a row), it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeWrite(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate called before any library method writes to the cache. This gives an option to the delegate to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the delegate registered with <see cref="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"/> If you need async/task-based callbacks, please use SetBeforeWriteAsync instead. </summary> <param name="beforeWrite">Delegate set in order to prepare the cache serialization</param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate to be notified before any library method accesses the cache. This gives an option to the delegate to deserialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. This provides the same functionality as SetBeforeAccess but it provides for an async/task-based callback. </summary> <param name="beforeAccess">Delegate set in order to handle the cache deserialization</param> <remarks>In the case where the delegate is used to deserialize the cache, it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate to be notified after any library method accesses the cache. This gives an option to the delegate to serialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. This provides the same functionality as SetAfterAccess but it provides for an async/task-based callback. </summary> <param name="afterAccess">Delegate set in order to handle the cache serialization in the case where the <see cref="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"/> member of the cache is <c>true</c></param> <remarks>In the case where the delegate is used to serialize the cache entirely (not just a row), it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeWriteAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate called before any library method writes to the cache. This gives an option to the delegate to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the delegate registered with <see cref="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"/> This provides the same functionality as SetBeforeWrite but it provides for an async/task-based callback. </summary> <param name="beforeWrite">Delegate set in order to prepare the cache serialization</param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> and is accessible in TokenCacheNotificationArgs. </summary> <param name="msalV3State">Byte stream representation of the cache</param> <param name="shouldClearExistingCache"> Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state. </param> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV2"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV2(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/> and is accessible in TokenCacheNotificationArgs. </summary> <param name="msalV2State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeAdalV3"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeAdalV3(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> and is accessible in TokenCacheNotificationArgs. See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <param name="adalV3State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.Serialize"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>. See https://aka.ms/msal-net-4x-cache-breaking-change /// </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.Deserialize(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>. See https://aka.ms/msal-net-4x-cache-breaking-change /// </summary> <param name="msalV2State"></param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeUnifiedAndAdalCache"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> and <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/> See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeUnifiedAndAdalCache(Microsoft.Identity.Client.Cache.CacheData)"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/> and <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <param name="cacheData"></param> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.FindRefreshTokenAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters,System.String)"> <summary> Returns a RT for the request. If familyId is specified, it tries to return the FRT. </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsFociMemberAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters,System.String)"> <summary> FOCI - check in the app metadata to see if the app is part of the family </summary> <returns>null if unknown, true or false if app metadata has details</returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.HasTokensNoLocks"> <summary> Shows if MSAL's in-memory token cache has any kind of RT or non-expired AT. Does not trigger a cache notification. Ignores ADAL's cache. </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsAppSubscribedToSerializationEvents"> <summary> True when MSAL has been configured to fire the serialization events. This can be done by the app developer or by MSAL itself (on UWP). </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsExternalSerializationConfiguredByUser"> <summary> True when the app developer subscribed to token cache serialization events. </summary> </member> <member name="T:Microsoft.Identity.Client.ITokenCacheSerializer"> <summary> This interface will be available in TokenCacheNotificationArgs callback to enable serialization/deserialization of the cache. </summary> <remarks> The methods in this class are not thread safe. It is expected that they will be called from the token cache callbacks, registered via SetBeforeAccess, SetAfterAccess. These callbacks thread safe because they are triggered sequentially. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"> <summary> Serializes the token cache to the MSAL.NET 3.x cache format, which is compatible with other MSAL desktop libraries, including MSAL.NET 4.x, MSAL for Python and MSAL for Java. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <returns>Byte stream representation of the cache</returns> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"> <summary> Deserializes the token cache to the MSAL.NET 3.x cache format, which is compatible with other MSAL desktop libraries, including MSAL.NET 4.x, MSAL for Python and MSAL for Java. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <param name="msalV3State">Byte stream representation of the cache</param> <param name="shouldClearExistingCache"> Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state. </param> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"> <summary> Serializes the token cache to the ADAL.NET 3.x cache format. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"> <summary> Deserializes the token cache to the ADAL.NET 3.x cache format. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <param name="adalV3State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"> <summary> Serializes the token cache to the MSAL.NET 2.x unified cache format, which is compatible with ADAL.NET v4 and other MSAL.NET v2 applications. If you need to maintain SSO between an application using ADAL 3.x or MSAL 2.x and this application using MSAL 3.x, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> or <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"> <summary> Deserializes the token cache to the MSAL.NET 2.x cache format, which is compatible with ADAL.NET v4 and other MSAL.NET v2 applications. If you need to maintain SSO between an application using ADAL 3.x or MSAL 2.x and this application using MSAL 3.x, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> or <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <param name="msalV2State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes"> <summary> The Kerberos key types used in this assembly. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.None"> <summary> None. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.DecCbcCrc"> <summary> dec-cbc-crc ([RFC3961] section 6.2.3) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.DesCbcMd5"> <summary> des-cbc-md5 ([RFC3961] section 6.2.1) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.Aes128CtsHmacSha196"> <summary> aes128-cts-hmac-sha1-96 ([RFC3962] section 6) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.Aes256CtsHmacSha196"> <summary> aes256-cts-hmac-sha1-96 ([RFC3962] section 6) </summary> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"> <summary> Class for Kerberos tickets that are included as claims and used as a supplemental token in an OAuth/OIDC protocol response. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientKey"> <summary> Get or Sets the client key used to encrypt the client portion of the ticket. This is optional. This will be null if KeyType is null. This MUST be protected in the protocol response. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KeyType"> <summary> Get or Sets the client key type.This is optional.This will be null if ClientKey is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KerberosMessageBuffer"> <summary> Get or Sets the Base64 encoded KERB_MESSAGE_BUFFER </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ErrorMessage"> <summary> Get or Sets the error message that server encountered when creating a ticket granting ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.Realm"> <summary> Get or Sets the Kerberos realm/domain name. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ServicePrincipalName"> <summary> Get or Sets the target service principal name (SPN). </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientName"> <summary> Get or Sets the client name. Depending on the ticket, this can be either a UserPrincipalName or SamAccountName. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> class. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor(System.String)"> <summary> Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> class with error message. </summary> <param name="errorMessage">Error message to be set.</param> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ToString"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager"> <summary> Helper class to manage Kerberos Ticket Claims. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.FromIdToken(System.String)"> <summary> Creates a <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> object from given ID token string.. </summary> <param name="idToken">ID token string.</param> <returns>A <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> object if a Kerberos Ticket Claim exists in the given idToken parameter and is parsed correctly. Null, otherwise.</returns> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.SaveToWindowsTicketCache(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket)"> <summary> Save current Kerberos Ticket to current user's Ticket Cache. </summary> <param name="ticket">Kerberos ticket object to save.</param> <remarks>Can throws <see cref="T:System.ArgumentException"/> when given ticket parameter is not a valid Kerberos Supplemental Ticket. Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while saving ticket information into Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.SaveToWindowsTicketCache(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket,System.Int64)"> <summary> Save current Kerberos Ticket to current user's Ticket Cache. Windows only. </summary> <param name="ticket">Kerberos ticket object to save.</param> <param name="logonId">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> <remarks>Can throw <see cref="T:System.ArgumentException"/> when given ticket parameter is not a valid Kerberos Supplemental Ticket. Can throw <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while saving ticket information into Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketFromWindowsTicketCache(System.String)"> <summary> Reads a Kerberos Service Ticket associated with given service principal name from current user's Ticket Cache. Windows only. </summary> <param name="servicePrincipalName">Service principal name to find associated Kerberos Ticket.</param> <returns>Byte stream of searched Kerberos Ticket information if exists. Null, otherwise.</returns> <remarks> Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while searching ticket information from Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketFromWindowsTicketCache(System.String,System.Int64)"> <summary> Reads a Kerberos Service Ticket associated with given service principal name from current user's Ticket Cache. </summary> <param name="servicePrincipalName">Service principal name to find associated Kerberos Ticket.</param> <param name="logonId">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> <returns>Byte stream of searched Kerberos Ticket information if exists. Null, otherwise.</returns> <remarks> Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while searching ticket information from Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKrbCred(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket)"> <summary> Gets the KRB-CRED Kerberos Ticket information as byte stream. </summary> <param name="ticket">Kerberos ticket object to save.</param> <returns>Byte stream representaion of KRB-CRED Kerberos Ticket if it contains valid ticket information. Null, otherwise.</returns> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.AddKerberosTicketClaim(Microsoft.Identity.Client.OAuth2.OAuth2Client,Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters)"> <summary> Add Claims to body parameter for POST request. </summary> <param name="oAuth2Client"><see cref="T:Microsoft.Identity.Client.OAuth2.OAuth2Client"/> object for Token request.</param> <param name="requestParams"><see cref="T:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters"/> containing request parameters.</param> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketClaim(System.String,Microsoft.Identity.Client.Kerberos.KerberosTicketContainer)"> <summary> Generate a Kerberos Ticket Claim string. </summary> <param name="servicePrincipalName">Service principal name to use.</param> <param name="ticketContainer">Ticket container to use.</param> <returns>A Kerberos Ticket Claim string if valid service principal name was given. Empty string, otherwise.</returns> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer"> <summary> Declares the type of container to use for Kerberos Ticket Claim. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer.IdToken"> <summary> Use the Id token as the Kerberos Ticket container. (NOTE) MSAL will read out Kerberos Service Ticket from received id token, cache into current user's ticket cache, and return it as KerberosSupplementalTicket object in AuthenticationResult. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer.AccessToken"> <summary> Use the Access Token as the Kerberos Ticket container. (NOTE) MSAL will not read out Kerberos Service Ticket from received access token. Caller should handle received access token directly to use for next service request. </summary> </member> <member name="T:Microsoft.Identity.Client.LogCallback"> <summary> Callback delegate that allows application developers to consume logs, and handle them in a custom manner. This callback is set using <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/>. If <c>PiiLoggingEnabled</c> is set to <c>true</c>, when registering the callback this method will receive the messages twice: once with the <c>containsPii</c> parameter equals <c>false</c> and the message without PII, and a second time with the <c>containsPii</c> parameter equals to <c>true</c> and the message might contain PII. In some cases (when the message does not contain PII), the message will be the same. For details see https://aka.ms/msal-net-logging </summary> <param name="level">Log level of the log message to process</param> <param name="message">Pre-formatted log message</param> <param name="containsPii">Indicates if the log message contains Organizational Identifiable Information (OII) or Personally Identifiable Information (PII) nor not. If <see cref="P:Microsoft.Identity.Client.Logger.PiiLoggingEnabled"/> is set to <c>false</c> then this value is always false. Otherwise it will be <c>true</c> when the message contains PII.</param> <seealso cref="T:Microsoft.Identity.Client.Logger"/> </member> <member name="T:Microsoft.Identity.Client.LogLevel"> <summary> Level of the log messages. For details see https://aka.ms/msal-net-logging </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Always"> <summary> Always Log Level </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Error"> <summary> Error Log level </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Warning"> <summary> Warning Log level </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Info"> <summary> Information Log level </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Verbose"> <summary> Verbose Log level </summary> </member> <member name="T:Microsoft.Identity.Client.Metrics"> <summary> MSAL-wide metrics. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromIdP"> <summary> Total tokens obtained by MSAL from the identity provider. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromCache"> <summary> Total tokens obtained by MSAL from cache. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromBroker"> <summary> Total tokens obtained by MSAL from broker. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalDurationInMs"> <summary> Total time, in milliseconds, spent in MSAL for all requests. Aggregate of <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs"/>. </summary> </member> <member name="T:Microsoft.Identity.Client.IUser"> <summary> In MSAL.NET 1.x, was representing a User. From MSAL 2.x use <see cref="T:Microsoft.Identity.Client.IAccount"/> which represents an account (a user has several accounts). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.DisplayableId"> <summary> In MSAL.NET 1.x was the displayable ID of a user. From MSAL 2.x use the <see cref="P:Microsoft.Identity.Client.IAccount.Username"/> of an account. See https://aka.ms/msal-net-2-released for more details </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.Name"> <summary> In MSAL.NET 1.x was the name of the user (which was not very useful as the concatenation of some claims). From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.IAccount.Username"/>. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.IdentityProvider"> <summary> In MSAL.NET 1.x was the URL of the identity provider (e.g. https://login.microsoftonline.com/tenantId). From MSAL.NET 2.x use <see cref="P:Microsoft.Identity.Client.IAccount.Environment"/> which retrieves the host only (e.g. login.microsoftonline.com). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.Identifier"> <summary> In MSAL.NET 1.x was an identifier for the user in the guest tenant. From MSAL.NET 2.x, use <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/><see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> to get the user identifier (globally unique across tenants). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"> <summary> Contains parameters used by the MSAL call accessing the cache. See also <see cref="T:ITokenCacheSerializer"/> which contains methods to customize the cache serialization. For more details about the token cache see https://aka.ms/msal-net-web-token-cache </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.User"> <summary> In MSAL.NET 1.x, returned the user who signed in to get the authentication result. From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.Account"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken,System.Guid)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.TokenCache"> <summary> Gets the <see cref="T:Microsoft.Identity.Client.ITokenCacheSerializer"/> involved in the transaction </summary> <remarks><see cref="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.TokenCache" > objects</see> implement this interface.</remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.ClientId"> <summary> Gets the ClientId (application ID) of the application involved in the cache transaction </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.Account"> <summary> Gets the account involved in the cache transaction. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.HasStateChanged"> <summary> Indicates whether the state of the cache has changed, for example when tokens are being added or removed. Not all cache operations modify the state of the cache. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.IsApplicationCache"> <summary> Indicates whether the cache change occurred in the UserTokenCache or in the AppTokenCache. </summary> <remarks> The Application Cache is used in Client Credential grant, which is not available on all platforms. See https://aka.ms/msal-net-app-cache-serialization for details. </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.SuggestedCacheKey"> <summary> A suggested token cache key, which can be used with general purpose storage mechanisms that allow storing key-value pairs and key based retrieval. Useful in applications that store 1 token cache per user, the recommended pattern for web apps. The value is: <list type="bullet"> <item><description>the homeAccountId for AcquireTokenSilent, GetAccount(homeAccountId), RemoveAccount and when writing tokens on confidential client calls</description></item> <item><description>clientID + "_AppTokenCache" for AcquireTokenForClient</description></item> <item><description>clientID_tenantID + "_AppTokenCache" for AcquireTokenForClient when tenant specific authority</description></item> <item><description>the hash of the original token for AcquireTokenOnBehalfOf</description></item> </list> </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.HasTokens"> <summary> Is true when at least one non-expired access token exists in the cache. </summary> <remarks> If this flag is false in the OnAfterAccessAsync notification, the *application* token cache - used by client_credentials flow / AcquireTokenForClient - can be deleted. MSAL takes into consideration access tokens expiration when computing this flag, but not refresh token expiration, which is not known to MSAL. </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.CancellationToken"> <summary> The cancellation token that was passed to AcquireToken* flow via ExecuteAsync(CancellationToken). Can be passed along to the custom token cache implementation. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.CorrelationId"> <summary> The correlation id associated with the request. See <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithCorrelationId(System.Guid)"/> </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.SuggestedCacheExpiry"> <summary> Suggested value of the expiry, to help determining the cache eviction time. This value is <b>only</b> set on the <code>OnAfterAccess</code> delegate, on a cache write operation (that is when <code>args.HasStateChanged</code> is <code>true</code>) and when the cache write is triggered from the <code>AcquireTokenForClient</code> method. In all other cases it's <code>null</code>, as there is a refresh token, and therefore the access tokens are refreshable. </summary> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplication"> <summary> Abstract class containing common API methods and properties. For details see https://aka.ms/msal-net-client-applications </summary> <summary> Class to be used to acquire tokens in desktop or mobile applications (Desktop / UWP / Xamarin.iOS / Xamarin.Android). public client applications are not trusted to safely keep application secrets, and therefore they only access web APIs in the name of the user only. For details see https://aka.ms/msal-net-client-applications </summary> <remarks> <list type="bullet"> <item><description>Contrary to <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, public clients are unable to hold configuration time secrets, and as a result have no client secret</description></item> <item><description>The redirect URL is pre-proposed by the library. It does not need to be passed in the constructor</description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByUsernamePasswordAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> In ADAL.NET, acquires security token from the authority, using the username/password authentication, with the password sent in clear. In MSAL 2.x, only the method that accepts a SecureString parameter is supported. See https://aka.ms/msal-net-up for more details. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf.</param> <param name="password">User password.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.#ctor(System.String)"> <summary> Constructor of the application. It will use https://login.microsoftonline.com/common as the default authority. </summary> <param name="clientId">Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.#ctor(System.String,System.String)"> <summary> Constructor of the application. </summary> <param name="clientId">Client ID (also named Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> <param name="authority">Authority of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c>, where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in user of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to signing users with any work and school accounts or Microsoft personal account</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to signing users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to signing users with only personal Microsoft account (live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal </param> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire token for the specified scopes. The user is required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for a login with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for an account with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and login</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a login with control of the UI prompt and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for an account with control of the UI prompt and possiblity of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByUsernamePasswordAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a security token from the authority, via Username/Password Authentication. Available only on .net desktop and .net core. See https://aka.ms/msal-net-up for details. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <param name="securePassword">User password.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra parameters. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra query parameters and cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.Microsoft#Identity#Client#IByRefreshToken#AcquireTokenByRefreshTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it and the refresh token into the application user token cache, where it will be available for further AcquireTokenSilentAsync calls. This method can be used in migration to MSAL from ADAL v2 and in various integration scenarios where you have a RefreshToken available. (see https://aka.ms/msal-net-migration-adal2-msal2) </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token (for example previously obtained from ADAL 2.x)</param> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <remarks> On Windows Universal Platform, the following capabilities need to be provided: Enterprise Authentication, Private Networks (Client and Server), User Account Information Supported on .net desktop and UWP </remarks> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user account for which to acquire a token with Integrated Windows authentication. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.#ctor(System.String,System.String,Microsoft.Identity.Client.TokenCache)"> <summary> Constructor to create application instance. This constructor is only available for Desktop and NetCore apps </summary> <param name="clientId">Client id of the application</param> <param name="authority">Default authority to be used for the application</param> <param name="userTokenCache">Instance of TokenCache.</param> </member> <member name="P:Microsoft.Identity.Client.PublicClientApplication.OperatingSystemAccount"> <summary> Currently only the Windows broker is able to login with the current user, see https://aka.ms/msal-net-wam for details. A special account value that indicates that the current Operating System account should be used to login the user. Not all operating systems and authentication flows support this concept, in which case calling `AcquireTokenSilent` will throw an <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/>. </summary> </member> <member name="P:Microsoft.Identity.Client.PublicClientApplication.IsSystemWebViewAvailable"> <summary> Returns true if MSAL can use a system browser. </summary> <remarks> On Windows, Mac and Linux a system browser can always be used, except in cases where there is no UI, e.g. SSH connection. On Android, the browser must support tabs. </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.IsEmbeddedWebViewAvailable"> <summary> Returns true if MSAL can use an embedded webview (browser). </summary> <remarks> Currently there are no embedded webviews on Mac and Linux. On Windows, app developers or users should install the WebView2 runtime and this property will inform if the runtime is available, see https://aka.ms/msal-net-webview2 </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.IsUserInteractive"> <summary> Returns false when the program runs in headless OS, for example when SSH-ed into a Linux machine. Browsers (webviews) and brokers cannot be used if there is no UI support. Instead, please use <see cref="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"/> </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.IsBrokerAvailable"> <summary> Returns true if a broker can be used. </summary> <remarks> On Windows, the broker (WAM) can be used on Win10 and is always installed. On Mac, Linux and older versions of Windows a broker is not available. On mobile, the device must be Intune joined and Authenticator or Company Portal must be installed. </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire a token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant. You can also pass optional parameters by calling: <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"/> to specify the user experience when signing-in, <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"/> to specify if you want to use the embedded web browser or the system default browser, <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"/> to configure the user experience when using the Default browser, <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/> to prevent the select account dialog from appearing in the case you want to sign-in a specific account, <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> if you want to let the user pre-consent to additional scopes (which won't be returned in the access token), <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device. This is done in two steps: <list type="bullet"> <item><description>The method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> You can also pass optional parameters by calling: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> You can also pass optional parameters by calling: <see cref="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithUsername(System.String)"/> to pass the identifier of the user account for which to acquire a token with Integrated Windows authentication. This is generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com. This is normally not needed, but some Windows administrators set policies preventing applications from looking-up the signed-in user in Windows, and in that case the username needs to be passed. You can also chain with <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a security token from the authority, via Username/Password Authentication. See https://aka.ms/msal-net-up for details. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="password">User password as a secure string.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also pass optional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the STS, and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application construction. </remarks> </member> <member name="T:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate"> <summary> Component to be used with confidential client applications like web apps/APIs. This component supports Subject Name + Issuer authentication in order to help, in the future, Azure AD certificates rollover. </summary> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method enables application developers to achieve easy certificates roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). </summary> <param name="scopes">Array of scopes requested for resource</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method attempts to look up valid access token in the cache unless<paramref name="forceRefresh"/> is true This method enables application developers to achieve easy certificates roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V2 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V2 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="T:Microsoft.Identity.Client.UIBehavior"> <summary> Structure containing static members that you can use to specify how the interactive overrides of AcquireTokenAsync in <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> should prompt the user. </summary> </member> <member name="T:Microsoft.Identity.Client.Logger"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Logger.LogCallback"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Logger.Level"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Logger.PiiLoggingEnabled"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Logger.DefaultLoggingEnabled"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Telemetry"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Telemetry.Receiver"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Telemetry.GetInstance"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Telemetry.TelemetryOnFailureOnly"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Telemetry.RegisterReceiver(Microsoft.Identity.Client.Telemetry.Receiver)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Telemetry.HasRegisteredReceiver"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Telemetry.Microsoft#Identity#Client#TelemetryCore#ITelemetryReceiver#HandleTelemetryEvents(System.Collections.Generic.List{System.Collections.Generic.Dictionary{System.String,System.String}})"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.ClientAssertionCertificate"> <summary> Certificate for a client assertion. This class is used in one of the constructors of <see cref="T:Microsoft.Identity.Client.ClientCredential"/>. ClientCredential is itself used in the constructor of <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> to pass to Azure AD a shared secret (registered in the Azure AD application) </summary> <seealso cref="T:Microsoft.Identity.Client.ClientCredential"/> for the constructor of <seealso cref="T:Microsoft.Identity.Client.ClientCredential"/> with a certificate, and <seealso cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> <remarks>To understand the difference between public client applications and confidential client applications, see https://aka.ms/msal-net-client-applications</remarks> </member> <member name="M:Microsoft.Identity.Client.ClientAssertionCertificate.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Constructor to create certificate information used in <see cref="T:Microsoft.Identity.Client.ClientCredential"/> to instantiate a <see cref="T:Microsoft.Identity.Client.ClientCredential"/> used in the constructors of <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> </member> <member name="P:Microsoft.Identity.Client.ClientAssertionCertificate.MinKeySizeInBits"> <summary> Gets minimum X509 certificate key size in bits </summary> </member> <member name="P:Microsoft.Identity.Client.ClientAssertionCertificate.Certificate"> <summary> Gets the X509 certificate used as credentials to prove the identity of the application to Azure AD. </summary> </member> <member name="T:Microsoft.Identity.Client.ClientCredential"> <summary> Meant to be used in confidential client applications, an instance of <c>ClientCredential</c> is passed to the constructors of (<see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>) as credentials proving that the application (the client) is what it claims it is. These credentials can be either a client secret (an application password) or a certificate. This class has one constructor for each case. These credentials are added in the application registration portal (in the secret section). </summary> </member> <member name="M:Microsoft.Identity.Client.ClientCredential.#ctor(Microsoft.Identity.Client.ClientAssertionCertificate)"> <summary> Constructor of client (application) credentials from a <see cref="T:Microsoft.Identity.Client.ClientAssertionCertificate"/> </summary> <param name="certificate">contains information about the certificate previously shared with AAD at application registration to prove the identity of the application (the client) requesting the tokens.</param> </member> <member name="M:Microsoft.Identity.Client.ClientCredential.#ctor(System.String)"> <summary> Constructor of client (application) credentials from a client secret, also known as the application password. </summary> <param name="secret">Secret string previously shared with AAD at application registration to prove the identity of the application (the client) requesting the tokens.</param> </member> <member name="T:Microsoft.Identity.Client.UIParent"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.UIParent.#ctor"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.UIParent.#ctor(System.Object,System.Boolean)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.UIParent.IsSystemWebviewAvailable"> <summary> Checks Android device for chrome packages. Returns true if chrome package for launching system webview is enabled on device. Returns false if chrome package is not found. </summary> <example> The following code decides, in a Xamarin.Forms app, which browser to use based on the presence of the required packages. <code> bool useSystemBrowser = UIParent.IsSystemWebviewAvailable(); App.UIParent = new UIParent(Xamarin.Forms.Forms.Context as Activity, !useSystemBrowser); </code> </example> </member> <member name="T:Microsoft.Identity.Client.TokenCache"> <summary> Token cache storing access and refresh tokens for accounts This class is used in the constructors of <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> and <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>. In the case of ConfidentialClientApplication, two instances are used, one for the user token cache, and one for the application token cache (in the case of applications using the client credential flows). </summary> <summary> IMPORTANT: this class is performance critical; any changes must be benchmarked using Microsoft.Identity.Test.Performace. More information about how to test and what data to look for is in https://aka.ms/msal-net-performance-testing. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"> <summary> Gets or sets the flag indicating whether the state of the cache has changed. MSAL methods set this flag after any change. Caller applications should reset the flag after serializing and persisting the state of the cache. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SerializeUnifiedAndAdalCache"> <summary> Serializes the entire token cache in both the ADAL V3 and unified cache formats. </summary> <returns>Serialized token cache <see cref="T:Microsoft.Identity.Client.Cache.CacheData"/></returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.TokenCache.DeserializeUnifiedAndAdalCache(Microsoft.Identity.Client.Cache.CacheData)"> <summary> Deserializes the token cache from a serialization blob in both format (ADAL V3 format, and unified cache format) </summary> <param name="cacheData">Array of bytes containing serialize cache data</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.TokenCache.Serialize"> <summary> Serializes using the <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> serializer. Obsolete: Please use specialized Serialization methods. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> replaces <see cref="M:Microsoft.Identity.Client.TokenCache.Serialize"/>. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> Is our recommended way of serializing/deserializing. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/> For interoperability with ADAL.NET v3. </summary> <returns>array of bytes, <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/></returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.TokenCache.Deserialize(System.Byte[])"> <summary> Deserializes the token cache from a serialization blob in the unified cache format Obsolete: Please use specialized Deserialization methods. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/> replaces <see cref="M:Microsoft.Identity.Client.TokenCache.Deserialize(System.Byte[])"/> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> Is our recommended way of serializing/deserializing. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> For interoperability with ADAL.NET v3 </summary> <param name="msalV2State">Array of bytes containing serialized MSAL.NET V2 cache data</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. <paramref name="msalV2State"/>Is a Json blob containing access tokens, refresh tokens, id tokens and accounts information. </remarks> </member> <member name="T:Microsoft.Identity.Client.TokenCache.TokenCacheNotification"> <summary> Notification for certain token cache interactions during token acquisition. This delegate is used in particular to provide a custom token cache serialization </summary> <param name="args">Arguments related to the cache item impacted</param> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SerializeAdalV3"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.DeserializeAdalV3(System.Byte[])"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SerializeMsalV2"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.DeserializeMsalV2(System.Byte[])"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SerializeMsalV3"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"> <summary> This is removed in MSAL.NET v4. Read more: https://aka.ms/msal-net-4x-cache-breaking-change </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCache.UsesDefaultSerialization"> <summary> Set to true on some platforms (UWP) where MSAL adds a serializer on its own. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.#ctor"> <summary> Constructor of a token cache. This constructor is left for compatibility with MSAL 2.x. The recommended way to get a cache is by using <see cref="P:Microsoft.Identity.Client.IClientApplicationBase.UserTokenCache"/> and <c>IConfidentialClientApplication.AppTokenCache</c> once the app is created. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.#ctor(Microsoft.Identity.Client.Internal.IServiceBundle,Microsoft.Identity.Client.Cache.ILegacyCachePersistence,System.Boolean,Microsoft.Identity.Client.Cache.CacheImpl.ICacheSerializationProvider)"> <summary> This method is so we can inject test ILegacyCachePersistence... </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetIosKeychainSecurityGroup(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.TokenCache.Microsoft#Identity#Client#ITokenCacheInternal#FindAccessTokenAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters)"> <summary> IMPORTANT: this class is performance critical; any changes must be benchmarked using Microsoft.Identity.Test.Performace. More information about how to test and what data to look for is in https://aka.ms/msal-net-performance-testing. Scenario: client_creds with default in-memory cache can get to ~500k tokens </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.ExpireAllAccessTokensForTestAsync"> <summary> For testing purposes only. Expires ALL access tokens in memory and fires OnAfterAccessAsync event with no cache key </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.Microsoft#Identity#Client#ITokenCacheInternal#GetAccountsAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters)"> <remarks> Get accounts should not make a network call, if possible. This can be achieved if all the environments in the token cache are known to MSAL, as MSAL keeps a list of known environments in <see cref="T:Microsoft.Identity.Client.Instance.Discovery.KnownMetadataProvider"/> </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCache.BeforeAccess"> <summary> Notification method called before any library method accesses the cache. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCache.BeforeWrite"> <summary> Notification method called before any library method writes to the cache. This notification can be used to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the <see cref="P:Microsoft.Identity.Client.TokenCache.AfterAccess"/>notification. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCache.AfterAccess"> <summary> Notification method called after any library method accesses the cache. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetBeforeAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified before any library method accesses the cache. This gives an option to the delegate to deserialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization </summary> <param name="beforeAccess">Delegate set in order to handle the cache deserialiation</param> <remarks>In the case where the delegate is used to deserialize the cache, it might want to call <see cref="M:Microsoft.Identity.Client.TokenCache.Deserialize(System.Byte[])"/></remarks> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified after any library method accesses the cache. This gives an option to the delegate to serialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization </summary> <param name="afterAccess">Delegate set in order to handle the cache serialization in the case where the <see cref="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"/> member of the cache is <c>true</c></param> <remarks>In the case where the delegate is used to serialize the cache entirely (not just a row), it might want to call <see cref="M:Microsoft.Identity.Client.TokenCache.Serialize"/></remarks> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetBeforeWrite(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate called before any library method writes to the cache. This gives an option to the delegate to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the delegate registered with <see cref="M:Microsoft.Identity.Client.TokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"/> </summary> <param name="beforeWrite">Delegate set in order to prepare the cache serialization</param> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetBeforeAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> </summary> <param name="beforeAccess"></param> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetAfterAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> </summary> <param name="afterAccess"></param> </member> <member name="M:Microsoft.Identity.Client.TokenCache.SetBeforeWriteAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> </summary> <param name="beforeWrite"></param> </member> <member name="T:Microsoft.Identity.Client.MsalClientException"> <summary> This exception class represents errors that are local to the library or the device. Contrary to <see cref="T:Microsoft.Identity.Client.MsalServiceException"/> which represent errors happening from the Azure AD service or the network. For more details, see https://aka.ms/msal-net-exceptions </summary> </member> <member name="M:Microsoft.Identity.Client.MsalClientException.#ctor(System.String)"> <summary> Initializes a new instance of the exception class with a specified error code. </summary> <param name="errorCode"> The error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param> </member> <member name="M:Microsoft.Identity.Client.MsalClientException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the exception class with a specified error code and error message. </summary> <param name="errorCode"> The error code returned by the service or generated by client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Client.MsalClientException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and inner exception. </summary> <param name="errorCode"> The error code returned by the service or generated by client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="innerException"></param> </member> <member name="T:Microsoft.Identity.Client.MsalError"> <summary> Error code returned as a property in MsalException </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidGrantError"> <summary> Standard OAuth2 protocol error code. It indicates that the application needs to expose the UI to the user so that the user does an interactive action in order to get a new token. <para>Mitigation:</para> If your application is a <see cref="T:IPublicClientApplication"/> call <c>AcquireTokenInteractive</c> perform an interactive authentication. If your application is a <see cref="T:ConfidentialClientApplication"/> chances are that the Claims member of the exception is not empty. See <see cref="P:MsalServiceException.Claims"/> for the right mitigation </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InteractionRequired"> <summary> Standard OAuth2 protocol error code. It indicates that the application needs to expose the UI to the user so the user can do an interactive log-in to get a token with updated claims. <para>Mitigation:</para> If your application is a <see cref="T:IPublicClientApplication"/> call <c>AcquireTokenInteractive</c> perform an interactive authentication. If your application is a <see cref="T:ConfidentialClientApplication"/> chances are that the Claims member of the exception is not empty. See <see cref="P:MsalServiceException.Claims"/> for the right mitigation </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoTokensFoundError"> <summary> No token was found in the token cache. <para>Mitigation:</para> If your application is a <see cref="T:Microsoft.Identity.Client.IPublicClientApplication"/> call <c>AcquireTokenInteractive</c> so that the user of your application signs-in and accepts consent. <list type="bullet"> <item><description> If it's a web app you should have previously called IConfidentialClientApplication.AcquireTokenByAuthorizationCode as described in https://aka.ms/msal-net-authorization-code. You need to make sure that you have requested the right scopes. For details See https://github.com/Azure-Samples/ms-identity-aspnetcore-webapp-tutorial </description></item> <item><description>This error should not happen in web APIs</description></item> </list> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UserNullError"> <summary> This error code comes back from <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> calls when a null user is passed as the <c>account</c> parameter. This can be because you have called AcquireTokenSilent with an <c>account</c> parameter set to <c>accounts.FirstOrDefault()</c> but <c>accounts</c> is empty. <para>Mitigation</para> Pass a different account, or otherwise call <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UserAssertionNullError"> <summary> This error code comes back from <see cref="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> calls when a null user assertion is passed as the <c>UserAssertion</c> parameter. <para>Mitigation</para> Pass a valid value for user assertion </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CurrentBrokerAccount"> <summary> This error code comes back from <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> calls when the <see cref="P:Microsoft.Identity.Client.PublicClientApplication.OperatingSystemAccount"/> user is passed as the <c>account</c> parameter. Only some brokers (WAM) can login the current user. <para>Mitigation</para> On Windows, use the broker via .WithBroker(true), use a different account, or otherwise call <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoAccountForLoginHint"> <summary> This error code denotes that no account was found having the given login hint. <para>What happens?</para> <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"/> or <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/> was called with a <c>loginHint</c> parameter which does not match any account in <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"/> <para>Mitigation</para> If you are certain about the loginHint, call <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.MultipleAccountsForLoginHint"> <summary> This error code denotes that multiple accounts were found having the same login hint and MSAL cannot choose one. Please use <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/> to specify the account </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TokenCacheNullError"> <summary> This error code comes back from <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> calls when the user cache had not been set in the application constructor. This should never happen in MSAL.NET 3.x as the cache is created by the application </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoPromptFailedError"> <summary> One of two conditions was encountered: <list type="bullet"> <item><description>The <c>Prompt.NoPrompt</c> was passed in an interactive token call, but the constraint could not be honored because user interaction is required, for instance because the user needs to re-sign-in, give consent for more scopes, or perform multiple factor authentication. </description></item> <item><description> An error occurred during a silent web authentication that prevented the authentication flow from completing in a short enough time frame. </description></item> </list> <para>Remediation:</para>call <c>AcquireTokenInteractive</c> so that the user of your application signs-in and accepts consent. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ServiceNotAvailable"> <summary> Service is unavailable and returned HTTP error code within the range of 500-599 <para>Mitigation</para> you can retry after a delay. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RequestTimeout"> <summary> The HTTP Request to the STS timed out. <para>Mitigation</para> you can retry after a delay. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RequestThrottled"> <summary> Service returned HTTP error code 429 which indicates the request has been throttled. For more details see https://aka.ms/msal-net-throttling </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UpnRequired"> <summary> loginHint should be a UPN <para>What happens?</para> An override of a token acquisition operation was called in <see cref="T:IPublicClientApplication"/> which takes a <c>loginHint</c> as a parameters, but this login hint was not using the UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c> expected by the service <para>Remediation</para> Make sure in your code that you enforce <c>loginHint</c> to be a UPN </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.MissingPassiveAuthEndpoint"> <summary> No passive auth endpoint was found in the OIDC configuration of the authority <para>What happens?</para> When the libraries go to the authority and get its open id connect configuration it expects to find a Passive Auth Endpoint entry, and could not find it. <para>remediation</para> Check that the authority configured for the application, or passed on some overrides of token acquisition tokens supporting authority override is correct </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidAuthority"> <summary> Invalid authority <para>What happens</para> When the library attempts to discover the authority and get the endpoints it needs to acquire a token, it got an un-authorize HTTP code or an unexpected response <para>remediation</para> Check that the authority configured for the application, or passed on some overrides of token acquisition tokens supporting authority override is correct </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidAuthorityType"> <summary> Invalid authority type. MSAL.NET does not know how to interact with the authority specified when the application was built. <para>Mitigation</para> Use a different authority </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UnknownError"> <summary> Unknown Error occurred. <para>Mitigation</para> None. You might want to inform the end user. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UnknownBrokerError"> <summary> Unknown broker error occurred. <para>Mitigation</para> None. You might want to inform the end user. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthenticationFailed"> <summary> Authentication failed. <para>What happens?</para> The authentication failed. For instance the user did not enter the right password <para>Mitigation</para> Inform the user to retry. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthorityValidationFailed"> <summary> Authority validation failed. <para>What happens?</para> The validation of the authority failed. This might be because the authority is not compliant with the OIDC standard, or there might be a security issue <para>Mitigation</para> Use a different authority. If you are absolutely sure that you can trust the authority you can use the <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> passing the <c>validateAuthority</c> parameter to <c>false</c> (not recommended) </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidOwnerWindowType"> <summary> Invalid owner window type. <para>What happens?</para> You used <c>"AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(object)</c> but the parameter you passed is invalid. <para>Remediation</para> On .NET Standard, the expected object is an <c>Activity</c> on Android, a <c>UIViewController</c> on iOS, a <c>NSWindow</c> on MAC, and a <c>IWin32Window</c> or <c>IntPr</c> on Windows. If you are in a WPF application, you can use <c>WindowInteropHelper(wpfControl).Handle</c> to get the window handle associated with a WPF control </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.EncodedTokenTooLong"> <summary> Encoded token too long. <para>What happens</para> In a confidential client application call, the client assertion built by MSAL is longer than the max possible length for a JWT token. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UserMismatch"> <summary> User Mismatch. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.FailedToRefreshToken"> <summary> Failed to refresh token. <para>What happens?</para> The token could not be refreshed. This can be because the user has not used the application for a long time. and therefore the refresh token maintained in the token cache has expired <para>Mitigation</para> If you are in a public client application, that supports interactivity, send an interactive request <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/>. Otherwise, use a different method to acquire tokens. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.FailedToAcquireTokenSilentlyFromBroker"> <summary> Failed to acquire token silently. Used in broker scenarios. <para>What happens</para> you called <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"/> and your mobile (Xamarin) application leverages the broker (Microsoft Authenticator or Microsoft Company Portal), but the broker was not able to acquire the token silently. <para>Mitigation</para> Call <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RedirectUriValidationFailed"> <summary> RedirectUri validation failed. <para>What happens?</para> The redirect URI / reply URI is invalid <para>How to fix</para> Pass a valid redirect URI. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthenticationUiFailed"> <summary> The request could not be preformed because of an unknown failure in the UI flow.* <para>Mitigation</para> Inform the user. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InternalError"> <summary> Internal error </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AccessingWsMetadataExchangeFailed"> <summary> Accessing WS Metadata Exchange Failed. <para>What happens?</para> You tried to use <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> and the account is a federated account. <para>Mitigation</para> None. The WS metadata was not found or does not correspond to what was expected. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.FederatedServiceReturnedError"> <summary> Federated service returned error. <para>Mitigation</para> None. The federated service returned an error. You can try to look at the Body of the exception for a better understanding of the error and choose the mitigation </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UserRealmDiscoveryFailed"> <summary> User Realm Discovery Failed. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RopcDoesNotSupportMsaAccounts"> <summary> Resource Owner Password Credential (ROPC) grant attempted with an MSA (Microsoft personal) account. ROPC does not support MSA accounts. See https://aka.ms/msal-net-ropc for details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.MissingFederationMetadataUrl"> <summary> Federation Metadata URL is missing for federated user. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ParsingWsMetadataExchangeFailed"> <summary> Parsing WS Metadata Exchange Failed. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WsTrustEndpointNotFoundInMetadataDocument"> <summary> WS-Trust Endpoint Not Found in Metadata Document. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ParsingWsTrustResponseFailed"> <summary> You can get this error when using <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> In the case of a Federated user (that is owned by a federated IdP, as opposed to a managed user owned in an Azure AD tenant) ID3242: The security token could not be authenticated or authorized. The user does not exist or has entered the wrong password </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.IntegratedWindowsAuthenticationFailed"> <summary> This can occur if there is an configuration issue in the ADFS environment where this is authenticating. See https://aka.ms/msal-net-iwa-troubleshooting for more details </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UnknownUserType"> <summary> <para>What happens</para> You can get this error when using <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> The user is not recognized as a managed user, or a federated user. Azure AD was not able to identify the IdP that needs to process the user <para>Mitigation</para> Inform the user. the login that the user provided might be incorrect. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UnknownUser"> <summary> <para>What happens</para> You can get this error when using <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> The user is not known by the IdP <para>Mitigation</para> Inform the user. The login that the user provided might be incorrect (for instance empty) </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.GetUserNameFailed"> <summary> Failed to get user name. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.PasswordRequiredForManagedUserError"> <summary> Password is required for managed user. <para>What happens?</para> If can got this error when using <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> and you (or the user) did not provide a password. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidRequest"> <summary> Request is invalid. <para>What happens?</para> This can happen because you are using a token acquisition method which is not compatible with the authority. For instance: you called <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> but you used an authority ending with '/common' or '/consumers' as this requires a tenanted authority or '/organizations'. <para>Mitigation</para> Adjust the authority to the AcquireTokenXX method you use (don't use 'common' or 'consumers' with <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"/> <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UapCannotFindDomainUser"> <summary> Cannot access the user from the OS (UWP) <para>What happens</para> You called <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"/>, but the domain user name could not be found. <para>Mitigation</para> This might be because you need to add more capabilities to your UWP application in the Package.appxmanifest. See https://aka.ms/msal-net-uwp </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UapCannotFindUpn"> <summary> Cannot get the user from the OS (UWP) <para>What happens</para> You called <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"/>, but the domain user name could not be found. <para>Mitigation</para> This might be because you need to add more capabilities to your UWP application in the Package.appxmanifest. See https://aka.ms/msal-net-uwp </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NonParsableOAuthError"> <summary> An error response was returned by the OAuth2 server and it could not be parsed </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CodeExpired"> <summary> <para>What happens?</para> In the context of Device code flow (See https://aka.ms/msal-net-device-code-flow), this error happens when the device code expired before the user signed-in on another device (this is usually after 15 mins). <para>Mitigation</para> None. Inform the user that they took too long to sign-in at the provided URL and enter the provided code. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.IntegratedWindowsAuthNotSupportedForManagedUser"> <summary> Integrated Windows Auth is only supported for "federated" users </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ActivityRequired"> <summary> On Android, you need to call <c>AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(object)</c> passing the activity. See https://aka.ms/msal-interactive-android </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BrokerResponseHashMismatch"> <summary> Broker response hash did not match </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BrokerResponseReturnedError"> <summary> Broker response returned an error </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BrokerNonceMismatch"> <summary> Broker response nonce does not match the request nonce sent by MSAL.NET for iOS broker >= v6.3.19 </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CannotInvokeBroker"> <summary> MSAL is not able to invoke the broker. Possible reasons are the broker is not installed on the user's device, or there were issues with the UiParent or CallerViewController being null. See https://aka.ms/msal-brokers </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoAndroidBrokerAccountFound"> <summary> MSAL is not able to find a suitable account to use with broker </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoAndroidBrokerInstalledOnDevice"> <summary> MSAL cannot find the broker application to authenticate accounts. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NullIntentReturnedFromAndroidBroker"> <summary> Null intent was returned so broker activity cannot be launched </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AndroidBrokerSignatureVerificationFailed"> <summary> Failed to validate android broker signature </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AndroidBrokerOperationFailed"> <summary> Failed To Complete Android Broker Operation </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoUsernameOrAccountIDProvidedForSilentAndroidBrokerAuthentication"> <summary> Unable to query the Android account manager because no username or home account ID is provided in the silent authentication request. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.HttpStatusNotFound"> <summary> Error code used when the HTTP response returns HttpStatusCode.NotFound </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.HttpStatusCodeNotOk"> <summary> ErrorCode used when the HTTP response returns something different from 200 (OK) </summary> <remarks> HttpStatusCode.NotFound have a specific error code. <see cref="F:Microsoft.Identity.Client.MsalError.HttpStatusNotFound"/> </remarks> </member> <member name="F:Microsoft.Identity.Client.MsalError.CustomWebUiReturnedInvalidUri"> <summary> Error code used when the <see cref="T:Microsoft.Identity.Client.Extensibility.ICustomWebUi"/> has returned a URI, but it is invalid - it is either null or has no code. Consider throwing an exception if you are unable to intercept the URI containing the code. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CustomWebUiRedirectUriMismatch"> <summary> Error code used when the CustomWebUI has returned a URI, but it does not match the Authority and AbsolutePath of the configured redirect URI. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AccessDenied"> <summary> Access denied. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CannotAccessUserInformationOrUserNotDomainJoined"> <summary> Cannot Access User Information or the user is not a user domain. <para>What happens?</para> You tried to use <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"/> but the user is not a domain user (the machine is not domain or AAD joined) </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.DefaultRedirectUriIsInvalid"> <summary> RedirectUri validation failed. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoRedirectUri"> <summary> No Redirect URI. <para>What happens?</para> You need to provide a Reply URI / Redirect URI, but have not called <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithRedirectUri(System.String)"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.MultipleTokensMatchedError"> <summary> Multiple Tokens were matched. <para>What happens?</para>This exception happens in the case of applications managing several identities, when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or one of its overrides and the user token cache contains multiple tokens for this client application and the specified Account, but from different authorities. <para>Mitigation [App Development]</para>specify the authority to use in the acquire token operation </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NonHttpsRedirectNotSupported"> <summary> Non HTTPS redirects are not supported <para>What happens?</para>This error happens when you have registered a non-HTTPS redirect URI for the public client application other than <c>urn:ietf:wg:oauth:2.0:oob</c> <para>Mitigation [App registration and development]</para>Register in the application a Reply URL starting with "https://" </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NetworkNotAvailableError"> <summary> The request could not be preformed because the network is down. <para>Mitigation [App development]</para> In the application you could either inform the user that there are network issues or retry later </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.B2CAuthorityHostMismatch"> <summary> The B2C authority host is not the same as the one used when creating the client application. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthorityHostMismatch"> <summary> The cloud (authority url host) defined at the application level cannot be different than the cloud at the request level. <para>What happens?</para>You did not define an authority at the application level, so it defaults to the public cloud (login.microsoft.com), but the authority at the request level is for a different cloud. Only the tenant can be changed at the request level. <para>Mitigation</para>Add .WithAuthority("https://login.windows-ppe.net/common) at the application level and specify the tenant at the request level: .WithAuthority("https://login.windows-ppe.net/1234-567-890-12345678). </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.DuplicateQueryParameterError"> <summary> Duplicate query parameter was found in extraQueryParameters. <para>What happens?</para> You have used <c>extraQueryParameter</c> of overrides of token acquisition operations in public client and confidential client application and are passing a parameter which is already present in the URL (either because you had it in another way, or the library added it). <para>Mitigation [App Development]</para> RemoveAccount the duplicate parameter from the token acquisition override. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthenticationUiFailedError"> <summary> The request could not be performed because of a failure in the UI flow. <para>What happens?</para>The library failed to invoke the Web View required to perform interactive authentication. The exception might include the reason <para>Mitigation</para>If the exception includes the reason, you could inform the user. This might be, for instance, a browser implementing chrome tabs is missing on the Android phone (that's only an example: this exception can apply to other platforms as well) </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthenticationCanceledError"> <summary> Authentication canceled. <para>What happens?</para>The user had canceled the authentication, for instance by closing the authentication dialog <para>Mitigation</para>None, you cannot get a token to call the protected API. You might want to inform the user </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.JsonParseError"> <summary> JSON parsing failed. <para>What happens?</para>A JSON blob read from the token cache or received from the STS was not parseable. This can happen when reading the token cache, or receiving an IDToken from the STS. <para>Mitigation</para>Make sure that the token cache was not tampered </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidJwtError"> <summary> JWT was invalid. <para>What happens?</para>The library expected a JWT (for instance a token from the cache, or received from the STS), but the format is invalid <para>Mitigation</para>Make sure that the token cache was not tampered </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.StateMismatchError"> <summary> State returned from the STS was different from the one sent by the library <para>What happens?</para>The library sends to the STS a state associated to a request, and expects the reply to be consistent. This errors indicates that the reply is not associated with the request. This could indicate an attempt to replay a response <para>Mitigation</para> None </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TenantDiscoveryFailedError"> <summary> Tenant discovery failed. <para>What happens?</para>While reading the OpenId configuration associated with the authority, the Authorize endpoint, or Token endpoint, or the Issuer was not found <para>Mitigation</para>This indicates and authority which is not Open ID Connect compliant. Specify a different authority in the constructor of the application, or the token acquisition override /// </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.PlatformNotSupported"> <summary> The library is loaded on a platform which is not supported. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidAuthorizationUri"> <summary> An authorization Uri has been intercepted, but it cannot be parsed. See the log for more details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.LoopbackRedirectUri"> <summary> <para>What happens?</para>The current redirect URL is not a loopback URL. <para>Mitigation</para> To use the OS browser, a loopback URL, with or without a port, must be configured both during app registration and when initializing the IPublicClientApplication object. See https://aka.ms/msal-net-os-browser for details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.LoopbackResponseUriMismatch"> <summary> <para>What happens?</para>MSAL has intercepted a Uri possibly containing an authorization code, but it does not match the configured redirect URL. <para>Mitigation</para>If you are using an ICustomWebUi implementation, make sure the redirect URL matches the URL containing the auth code. If you are not using an ICustomWebUI, this could be a man-in-the middle attack. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.LinuxXdgOpen"> <summary> <para>What happens?</para>MSAL tried to open the browser on Linux using the xdg-open, gnome-open, or kfmclient tools, but failed. <para>Mitigation</para>Make sure you can open a page using xdg-open tool. See https://aka.ms/msal-net-os-browser for details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WebviewUnavailable"> <summary> The selected WebView is not available on this platform. You can switch to a different WebView using <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"/>. See https://aka.ms/msal-net-os-browser for details </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.SystemWebviewOptionsNotApplicable"> <summary> <para>What happens?</para>You configured MSAL interactive authentication to use an embedded WebView and you also configured <see cref="T:Microsoft.Identity.Client.SystemWebViewOptions"/>. These are mutually exclusive. <para>Mitigation</para>Either set <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"/> to true or do not use <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"/> </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ClientCredentialAuthenticationTypesAreMutuallyExclusive"> <summary> <para>What happens?</para>You configured MSAL confidential client authentication with more than one authentication type (Certificate, Secret, Client Assertion) </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ClientCredentialAuthenticationTypeMustBeDefined"> <summary> <para>What happens?</para>You configured MSAL confidential client authentication without an authentication type (Certificate, Secret, Client Assertion) <para>Mitigation</para>Either call ConfidentialClientApplicationBuilder.WithClientSecret, ConfidentialClientApplicationBuilder.WithCertificate, ConfidentialClientApplicationBuilder.WithClientAssertion </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BasicAction"> <summary> Issue can be resolved by user interaction during the interactive authentication flow. See https://aka.ms/msal-net-UiRequiredException for details </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AdditionalAction"> <summary> Issue can be resolved by additional remedial interaction with the system, outside of the interactive authentication flow. Interactive authentication is still required to inform the user of what is needed. Calling application may choose to hide flows that require additional_action if the user is unlikely to complete the remedial action. Example: </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.MessageOnly"> <summary> Issue cannot be resolved at this time. Launching interactive authentication flow will show a message explaining the condition. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.UserPasswordExpired"> <summary> User's password has expired. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ConsentRequired"> <summary> User consent is missing, or has been revoked. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BadToken"> <summary> Internal to MSALs. Indicates that no further silent calls should be made with this refresh token. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TokenExpired"> <summary> Internal to MSALs. Indicates that no further silent calls should be made with this refresh token. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ProtectionPolicyRequired"> <summary> Internal to MSALs. Needed in ios/android to complete the end-to-end true MAM flow. This suberror code is re-mapped to a different top level error code (IntuneAppProtectionPoliciesRequired), and not InteractionRequired </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ClientMismatch"> <summary> Internal to MSALs. Used in scenarios where an application is using family refresh token even though it is not part of FOCI (or vice versa). Needed to handle cases where app changes FOCI membership after being shipped. This is handled internally and doesn't need to be exposed to the calling app. Please see FOCI design document for more details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.DeviceAuthenticationFailed"> <summary> Internal to MSALs. Indicates that device should be re-registered. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidInstance"> <summary> AAD service error indicating that the configured authority does not exist </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidUserInstanceMetadata"> <summary> <para>What happens?</para>You have configured your own instance metadata, but the json provided seems to be invalid. <para>Mitigation</para>See https://aka.ms/msal-net-custom-instance-metadata for an example of a valid json that can be used. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ValidateAuthorityOrCustomMetadata"> <summary> <para>What happens?</para>You have configured your own instance metadata, and have also set validate authority to true. These are mutually exclusive. <para>Mitigation</para>Set the validate authority flag to false. See https://aka.ms/msal-net-custom-instance-metadata for more details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.NoClientId"> <summary> <para>What happens?</para>You haven't set a client ID. <para>Mitigation</para>Use the application ID (a GUID) from the application portal as client ID in this SDK </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ClientIdMustBeAGuid"> <summary> <para>What happens?</para>You've specified a client ID that is not a <see cref="T:System.Guid"/> <para>Mitigation</para>Use the application ID (a GUID) from the application portal as client ID in this SDK </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TelemetryConfigOrTelemetryCallback"> <summary> <para>What happens?</para>You have configured both a telemetry callback and a telemetry config. <para>Mitigation</para>Only one telemetry mechanism can be configured. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidClient"> <summary> Azure AD service error indicating a configuration issue. <para>Mitigation</para>See error message for details, then take corrective action in the app registration portal See https://aka.ms/msal-net-invalid-client for details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.SSHCertUsedAsHttpHeader"> <summary> <para>What happens?</para>You have configured MSAL to request SSH certificates from AAD, and you are trying to format an HTTP authentication header. <para>Mitigation</para>SSH certificates should not used as Bearer tokens. Developers are responsible for sending the certificates to the target machines. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WABError"> <summary> <para>What happens?</para>Windows Authentication Broker, which handles the interaction between the user and AAD, has failed. <para>Mitigation</para>See the error message for more details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TokenTypeMismatch"> <summary> <para>What happens?</para>You asked for one type of token, but did not receive it. <para>Mitigation</para>This happens if the Identity Provider (AAD, B2C, ADFS etc.) does not support / implement the requested token type. In case of ADFS, consider upgrading to the latest version. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AccessTokenTypeMissing"> <summary> <para>What happens?</para>The response from the token endpoint does not contain the token_type parameter. <para>Mitigation</para>This happens if the identity provider (AAD, B2C, ADFS, etc.) did not include the access token type in the token response. Verify the configuration of the identity provider. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ExperimentalFeature"> <summary> <para>What happens?</para>You are trying to use a feature which was marked as experimental <para>Mitigation</para>When creating the PublicClientApplication or ConfidentialClientApplication, use .WithExperimentalFeatures() option. See https://aka.ms/msal-net-experimental-features for details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.BrokerApplicationRequired"> <summary> <para>What happens?</para>A broker application is required, but one could not be found or communicated with. <para>Mitigation</para>Install a broker application, such as Authenticator, from the application store </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.FailedToGetBrokerResponse"> <summary> <para>What happens?</para>You are trying to authenticate with the broker but MSAL is unable to read the response from the broker. <para>Mitigation</para>The currently installed broker may not support MSAL.Xamarin, you need to ensure that you have installed either Intune Company Portal (5.0.4689.0 or greater) or Microsoft Authenticator (6.2001.0140 or greater). see https://aka.ms/Brokered-Authentication-for-Android" </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidJsonClaimsFormat"> <summary> <para>What happens?</para>You have configured a claims request, but the claims string is not in JSON format <para>Mitigation</para>Ensure that the claims parameter is valid JSON. Inspect the inner exception for details about JSON parsing. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthorityTypeMismatch"> <summary> <para>What happens?</para>The authority configured at the application level is different than the authority configured at the request level <para>Mitigation</para>Ensure the same authority type is used </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.AuthorityTenantSpecifiedTwice"> <summary> <para>What happens?</para>You specified a tenant twice - once in WithAuthority() and once using WithTenant() <para>Mitigation</para>Specify the tenant once. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CustomMetadataInstanceOrUri"> <summary> <para>What happens?</para>You have configured your own instance metadata using both an Uri and a string. Only one is supported. <para>Mitigation</para>Call WithInstanceDiscoveryMetadata only once. See https://aka.ms/msal-net-custom-instance-metadata for more details. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.ScopesRequired"> <summary> <para>What happens?</para>No scopes have been requested <para>Mitigation</para>At least one scope must be specified for this authentication flow </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CertWithoutPrivateKey"> <summary> <para>What happens?</para>The certificate provided does not have a private key. <para>Mitigation</para>Ensure the certificate has a private key. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.DeviceCertificateNotFound"> <summary> Device certificate not found. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InvalidAdalCacheMultipleRTs"> <summary> <para>What happens?</para>The ADAL cache is invalid as it contains multiple refresh token entries for one user. <para>Mitigation</para>Delete the ADAL cache. If you do not maintain an ADAL cache, this may be a bug in MSAL. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RegionDiscoveryFailed"> <summary> Region discovery failed. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RegionDiscoveryNotEnabled"> <summary> <para>What happens?</para>WithAzureRegion is set to true <para>Mitigation</para>Region discovery cannot be performed for ADFS authority. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.CryptoNet45"> <summary> <para>What happens?</para>MSAL cannot use the certificate for signing. <para>Mitigation</para>Possible cause: use of CNG certificates with .Net classic 4.6 or lower. Either target a higher version of .NET desktop - 4.6.1 and above, or use a different certificate type (non-CNG) or sign your own assertion as described at https://aka.ms/msal-net-signed-assertion </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WamUiThread"> <summary> When calling AcquireTokenInteractive with the WAM broker, the call must be made from the UI thread. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WamNoB2C"> <summary> The Windows broker (WAM) is only supported in conjunction with "work and school" accounts and with Microsoft accounts. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WamInteractiveError"> <summary> WAM service exception that can occur when calling AcquireTokenInteractive </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WamPickerError"> <summary> WAM service exception that can occur when calling AcquireTokenInteractive and the account picker pops up </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WebView2NotInstalled"> <summary> <para>What happens?</para>The embedded browser cannot be started because a runtime component is missing. <para>Mitigation</para>"The embedded browser needs WebView2 runtime to be installed. An end user of the app can download and install the WebView2 runtime from https://go.microsoft.com/fwlink/p/?LinkId=2124703 and restart the app. or the app developer can install the WebView2 runtime https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.WebView2LoaderNotFound"> <summary> <para>What happens?</para>The embedded WebView2 browser cannot be started because a runtime component cannot be loaded. <para>Mitigation</para> For troubleshooting details, see https://aka.ms/msal-net-webview2 . </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RegionalAuthorityValidation"> <summary> <para>What happens?</para>You configured both Regional Authority and Authority Validation. Authority validation is not currently supported for regional authorities. <para>Mitigation</para>Set the validateAuthority flag to false to use Azure Regional authority. Do not disable authority validation if you read the authority from an untrusted source, for example from the WWWAuthenticate header of an HTTP request that resulted in a 401 response. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.HttpListenerError"> <summary> An HttpListenerException occurred while listening for the system browser to complete the login. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.InitializeProcessSecurityError"> <summary> <para>What happens?</para>Failure setting process security to enable WAM Account Picker in an elevated process. <para>Mitigation</para>For troubleshooting details, see https://aka.ms/msal-net-wam . </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.StaticCacheWithExternalSerialization"> <summary> <para>What happens?</para>You configured MSAL cache serialization at the same time with a static internal cache via <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithCacheOptions(Microsoft.Identity.Client.CacheOptions)"/> These are mutually exclusive. <para>Mitigation</para> Use only one option. Web site and web API scenarios should rely on external cache serialization, as internal cache serialization cannot scale. See https://aka.ms/msal-net-cca-token-cache-serialization </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.TenantOverrideNonAad"> <summary> <para>What happens?</para>You configured WithTenant at the request level, but the application is using a non-AAD authority These are mutually exclusive. <para>Mitigation</para> WithTenantId can only be used in conjunction with AAD authorities </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.RegionalAndAuthorityOverride"> <summary> <para>What happens?</para>You configured WithAuthority at the request level, and also WithAzureRegion. This is not supported when the environment changes from application to request."/> <para>Mitigation</para> Use WithTenantId at the request level instead. </summary> </member> <member name="F:Microsoft.Identity.Client.MsalError.OboCacheKeyNotInCacheError"> <summary> <para>What happens?</para>The token cache does not contain a token with an OBO cache key that matches the <c>longRunningProcessSessionKey</c> passed into <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/>. <para>Mitigation</para> Call <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"/> with this <c>longRunningProcessSessionKey</c> first or call <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/> with an already used <c>longRunningProcessSessionKey</c>. </summary> </member> <member name="T:Microsoft.Identity.Client.MsalErrorMessage"> <summary> The active directory authentication error message. </summary> </member> <member name="T:Microsoft.Identity.Client.MsalException"> <summary> Base exception type thrown when an error occurs during token acquisition. For more details, see https://aka.ms/msal-net-exceptions </summary> <remarks>Avoid throwing this exception. Instead throw the more specialized <see cref="T:Microsoft.Identity.Client.MsalClientException"/> or <see cref="T:Microsoft.Identity.Client.MsalServiceException"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.MsalException.#ctor"> <summary> Initializes a new instance of the exception class. </summary> </member> <member name="M:Microsoft.Identity.Client.MsalException.#ctor(System.String)"> <summary> Initializes a new instance of the exception class with a specified error code. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> </member> <member name="M:Microsoft.Identity.Client.MsalException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the exception class with a specified error code and error message. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Client.MsalException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="innerException"> The exception that is the cause of the current exception, or a null reference if no inner exception is specified. </param> </member> <member name="P:Microsoft.Identity.Client.MsalException.ErrorCode"> <summary> Gets the protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. Values for this code are typically provided in constant strings in the derived exceptions types with explanations of mitigation. </summary> </member> <member name="M:Microsoft.Identity.Client.MsalException.ToString"> <summary> Creates and returns a string representation of the current exception. </summary> <returns>A string representation of the current exception.</returns> </member> <member name="M:Microsoft.Identity.Client.MsalException.ToJsonString"> <summary> Allows serialization of most values of the exception into JSON. </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.MsalException.FromJsonString(System.String)"> <summary> Allows re-hydration of the MsalException (or one of its derived types) from JSON generated by ToJsonString(). </summary> <param name="json"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.MsalServiceException"> <summary> Exception type thrown when service returns an error response or other networking errors occur. For more details, see https://aka.ms/msal-net-exceptions </summary> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The protocol error code returned by the service or generated by client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.#ctor(System.String,System.String,System.Int32)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="statusCode">Status code of the resposne received from the service.</param> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="innerException"> The exception that is the cause of the current exception, or a null reference if no inner exception is specified. </param> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.#ctor(System.String,System.String,System.Int32,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="statusCode">HTTP status code of the resposne received from the service.</param> <param name="innerException"> The exception that is the cause of the current exception, or a null reference if no inner exception is specified. </param> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.#ctor(System.String,System.String,System.Int32,System.String,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="errorCode"> The protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="statusCode">The status code of the request.</param> <param name="claims">The claims challenge returned back from the service.</param> <param name="innerException"> The exception that is the cause of the current exception, or a null reference if no inner exception is specified. </param> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.StatusCode"> <summary> Gets the status code returned from HTTP layer. This status code is either the <c>HttpStatusCode</c> in the inner <see cref="T:System.Net.Http.HttpRequestException"/> response or the NavigateError Event Status Code in a browser based flow (See http://msdn.microsoft.com/en-us/library/bb268233(v=vs.85).aspx). You can use this code for purposes such as implementing retry logic or error investigation. </summary> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.Claims"> <summary> Additional claims requested by the service. When this property is not null or empty, this means that the service requires the user to provide additional claims, such as doing two factor authentication. The are two cases: <list type="bullent"> <item><description> If your application is a <see cref="T:Microsoft.Identity.Client.IPublicClientApplication"/>, you should just call <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"/> and add the <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithClaims(System.String)"/> modifier. </description></item> <item>><description>If your application is a <see cref="T:Microsoft.Identity.Client.IConfidentialClientApplication"/>, (therefore doing the On-Behalf-Of flow), you should throw an HTTP unauthorize exception with a message containing the claims</description></item> </list> For more details see https://aka.ms/msal-net-claim-challenge </summary> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.ResponseBody"> <summary> Raw response body received from the server. </summary> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.Headers"> <summary> Contains the HTTP headers from the server response that indicated an error. </summary> <remarks> When the server returns a 429 Too Many Requests error, a Retry-After should be set. It is important to read and respect the time specified in the Retry-After header to avoid a retry storm. </remarks> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.CorrelationId"> <summary> An ID that can used to piece up a single authentication flow. </summary> </member> <member name="P:Microsoft.Identity.Client.MsalServiceException.SubError"> <remarks> The suberror should not be exposed for public consumption yet, as STS needs to do some work first. </remarks> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.IsAadUnavailable"> <summary> As per discussion with Evo, AAD </summary> </member> <member name="M:Microsoft.Identity.Client.MsalServiceException.ToString"> <summary> Creates and returns a string representation of the current exception. </summary> <returns>A string representation of the current exception.</returns> </member> <member name="T:Microsoft.Identity.Client.MsalThrottledServiceException"> <summary> Exception type thrown when MSAL detects that an application is trying to acquire a token too often, as a result of: - A previous request resulted in an HTTP response containing a Retry-After header which was not followed. - A previous request resulted in an HTTP 429 or 5xx, which indicates a problem with the server. The properties of this exception are identical to the original exception For more details see https://aka.ms/msal-net-throttling </summary> </member> <member name="M:Microsoft.Identity.Client.MsalThrottledServiceException.#ctor(Microsoft.Identity.Client.MsalServiceException)"> <summary> Constructor </summary> </member> <member name="P:Microsoft.Identity.Client.MsalThrottledServiceException.OriginalServiceException"> <summary> The original service exception that triggered the throttling. </summary> </member> <member name="T:Microsoft.Identity.Client.MsalThrottledUiRequiredException"> <summary> Exception type thrown when MSAL detects that an application is trying to acquire a token even though an <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/> was recently thrown. To mitigate this, when a <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/> is encountered, the application should switch to acquiring a token interactively. To better understand why the <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException" /> was thrown, inspect the <see cref="P:Microsoft.Identity.Client.MsalUiRequiredException.Classification"/> property. The properties of this exception are identical to the original exception For more details see https://aka.ms/msal-net-throttling </summary> </member> <member name="M:Microsoft.Identity.Client.MsalThrottledUiRequiredException.#ctor(Microsoft.Identity.Client.MsalUiRequiredException)"> <summary> Constructor </summary> </member> <member name="P:Microsoft.Identity.Client.MsalThrottledUiRequiredException.OriginalServiceException"> <summary> The original exception that triggered the throttling. </summary> </member> <member name="T:Microsoft.Identity.Client.MsalUiRequiredException"> <summary> This exception class is to inform developers that UI interaction is required for authentication to succeed. It's thrown when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or one of its overrides, and when the token does not exists in the cache, or the user needs to provide more content, or perform multiple factor authentication based on Azure AD policies, etc.. For more details, see https://aka.ms/msal-net-exceptions </summary> </member> <member name="M:Microsoft.Identity.Client.MsalUiRequiredException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the exception class with a specified error code and error message. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Client.MsalUiRequiredException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="innerException">Represents the root cause of the exception.</param> </member> <member name="M:Microsoft.Identity.Client.MsalUiRequiredException.#ctor(System.String,System.String,System.Exception,Microsoft.Identity.Client.UiRequiredExceptionClassification)"> <summary> Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> <param name="innerException">Represents the root cause of the exception.</param> <param name="classification">A higher level description for this exception, that allows handling code to understand what type of action it needs to take to resolve the issue. </param> </member> <member name="P:Microsoft.Identity.Client.MsalUiRequiredException.Classification"> <summary> Classification of the conditional access error, enabling you to do more actions or inform the user depending on your scenario. See https://aka.ms/msal-net-UiRequiredException for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.OAuth2.MsalTokenResponse.FamilyId"> <summary> Optional field, FOCI support. </summary> </member> <member name="M:Microsoft.Identity.Client.OAuth2.MsalTokenResponse.CreateFromAndroidBrokerResponse(System.String,System.String)"> <remarks> This method does not belong here - it is more tied to the Android code. However, that code is not unit testable, and this one is. The values of the JSON response are based on https://github.com/AzureAD/microsoft-authentication-library-common-for-android/blob/dev/common/src/main/java/com/microsoft/identity/common/internal/broker/BrokerResult.java </remarks> </member> <member name="T:Microsoft.Identity.Client.OAuth2.OAuth2Client"> <summary> Responsible for talking to all the Identity provider endpoints: - instance discovery - endpoint metadata - mex - /token endpoint via TokenClient - device code endpoint </summary> </member> <member name="P:Microsoft.Identity.Client.OAuth2.OAuth2ResponseBase.ErrorCodes"> <summary> Do not expose these in the MsalException because Evo does not guarantee that the error codes remain the same. </summary> </member> <member name="T:Microsoft.Identity.Client.OAuth2.OAuth2Error"> <summary> OAuth2 errors that are only used internally. All error codes used when propagating exceptions should be made public. </summary> </member> <member name="F:Microsoft.Identity.Client.OAuth2.Throttling.HttpStatusProvider.s_throttleDuration"> <summary> Default timespan that blocks an application, if HTTP 429 and HTTP 5xx was received and Retry-After HTTP header was NOT returned by AAD. </summary> </member> <member name="P:Microsoft.Identity.Client.OAuth2.Throttling.HttpStatusProvider.ThrottlingCache"> <summary> Exposed only for testing purposes </summary> </member> <member name="M:Microsoft.Identity.Client.OAuth2.Throttling.IThrottlingProvider.ResetCache"> <summary> For test purposes, so that the static state can be reset </summary> </member> <member name="T:Microsoft.Identity.Client.OAuth2.Throttling.RetryAfterProvider"> <summary> The Retry-After provider observes all service exceptions from all flows and looks for a header like: RetryAfter X seconds. It then enforces this header, by throttling for X seconds. </summary> </member> <member name="T:Microsoft.Identity.Client.OAuth2.Throttling.SingletonThrottlingManager"> <summary> Throttling is the action through which MSAL blocks applications from making repeated bad requests to the server. This works by MSAL detecting certain conditions when the server returns an error. If a similar request is then issued under the same condition, the same server error is returned by MSAL, without contacting the server. Throttling occurs in the following conditions: <list type="bullet"> <item><description>After receiving an RetryAfter header</description></item> <item><description>After receiving 429, 5xx HTTP status.</description></item> </list> This class manages the throttling providers and is itself a provider </summary> <remarks> Client Throttling spec https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/issues/1624 </remarks> </member> <member name="M:Microsoft.Identity.Client.OAuth2.Throttling.ThrottleCommon.GetRequestStrictThumbprint(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.String,System.String)"> <summary> The strict thumbprint is based on: ClientId Authority Resource Scope Account </summary> </member> <member name="F:Microsoft.Identity.Client.OAuth2.Throttling.ThrottlingCache.s_cleanupCacheInterval"> <summary> To prevent the cache from becoming too large, purge expired entries every X seconds </summary> </member> <member name="F:Microsoft.Identity.Client.OAuth2.Throttling.UiRequiredProvider.s_uiRequiredExpiration"> <summary> Default number of seconds that application returns the cached response, in case of UI required requests. </summary> </member> <member name="P:Microsoft.Identity.Client.OAuth2.Throttling.UiRequiredProvider.ThrottlingCache"> <summary> Exposed only for testing purposes </summary> </member> <member name="M:Microsoft.Identity.Client.OAuth2.Throttling.UiRequiredProvider.IsRequestSupported(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters)"> <summary> MsalUiRequiredException is thrown from AcquireTokenSilent, based on certain error codes from the server when contacting the token endpoint. Currently, throttling will only apply to public client applications at first. </summary> </member> <member name="M:Microsoft.Identity.Client.OAuth2.Throttling.UiRequiredProvider.GetRequestStrictThumbprint(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.String,Microsoft.Identity.Client.PlatformsCommon.Interfaces.ICryptographyManager)"> <summary> The strict thumbprint is based on: ClientId Authority (env + tenant) Scopes hash(RT) or UPN for IWA (not supported) </summary> </member> <member name="T:Microsoft.Identity.Client.OAuth2.TokenClient"> <summary> Responsible for talking to the /token endpoint </summary> </member> <member name="F:Microsoft.Identity.Client.OAuth2.TokenClient._requestInProgress"> <summary> Used to avoid sending duplicate "last request" telemetry from a multi-threaded environment </summary> </member> <member name="M:Microsoft.Identity.Client.OAuth2.TokenClient.AddThrottlingHeader"> <summary> A client side library needs to communicate to the server side that it has implemented enforcement of HTTP 429 and Retry-After header. Because if the server-side detects loops, then it can break the loop by sending either HTTP 429 or Retry-After header with a different HTTP status. Right now, the server side breaks the loops by invalid_grant response, which breaks protocol under some condition and also causes unexplained prompt. </summary> </member> <member name="T:Microsoft.Identity.Client.OsCapabilitiesExtensions"> <summary> Extension methods </summary> </member> <member name="M:Microsoft.Identity.Client.OsCapabilitiesExtensions.IsSystemWebViewAvailable(Microsoft.Identity.Client.IPublicClientApplication)"> <summary> Returns true if MSAL can use a system browser. </summary> <remarks> On Windows, Mac and Linux a system browser can always be used, except in cases where there is no UI, e.g. SSH connection. On Android, the browser must support tabs. </remarks> </member> <member name="M:Microsoft.Identity.Client.OsCapabilitiesExtensions.IsEmbeddedWebViewAvailable(Microsoft.Identity.Client.IPublicClientApplication)"> <summary> Returns true if MSAL can use an embedded webview (browser). </summary> <remarks> Currently there are no embedded webviews on Mac and Linux. On Windows, app developers or users should install the WebView2 runtime and this property will inform if the runtime is available, see https://aka.ms/msal-net-webview2 </remarks> </member> <member name="M:Microsoft.Identity.Client.OsCapabilitiesExtensions.IsUserInteractive(Microsoft.Identity.Client.IPublicClientApplication)"> <summary> Returns false when the program runs in headless OS, for example when SSH-ed into a Linux machine. Browsers (webviews) and brokers cannot be used if there is no UI support. Instead, please use <see cref="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"/> or <see cref="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"/> </summary> </member> <member name="M:Microsoft.Identity.Client.OsCapabilitiesExtensions.GetCertificate(Microsoft.Identity.Client.IConfidentialClientApplication)"> <summary> Returns the certificate used to create this <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, if any. </summary> </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Factories.PlatformProxyFactory"> <summary> Returns the platform / os specific implementation of a PlatformProxy. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Factories.PlatformProxyFactory.CreatePlatformProxy(Microsoft.Identity.Client.Core.ICoreLogger)"> <summary> Gets the platform proxy, which can be used to perform platform specific operations </summary> </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy"> <summary> Common operations for extracting platform / operating system specifics. Scope: per app </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetDeviceModel"> <summary> Gets the device model. On some TFMs this is not returned for security reasons. </summary> <returns>device model or null</returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetUserPrincipalNameAsync"> <summary> Gets the UPN of the user currently logged into the OS </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetCallingApplicationName"> <summary> Returns the name of the calling assembly </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetCallingApplicationVersion"> <summary> Returns the version of the calling assembly </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetDeviceId"> <summary> Returns a device identifier. Varies by platform. </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetDefaultRedirectUri(System.String,System.Boolean)"> <summary> Gets the default redirect URI for the platform, which sometimes includes the clientId </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetProductName"> <summary> Returns the MSAL platform, e.g. MSAL.NetCore, MSAL.Desktop. </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.GetRuntimeVersion"> <summary> Returns the framework runtime version on which the app is running, e.g. .NET Core 3.1.3, .NET Framework 4.8. </summary> <returns>Runtime version</returns> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.StartDefaultOsBrowserAsync(System.String)"> <summary> Go to a URL using the OS default browser. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.CanBrokerSupportSilentAuth"> <summary> Most brokers take care of both silent auth and interactive auth, however some (iOS) does not support silent auth and gives the RT back to MSAL. </summary> <returns></returns> </member> <member name="P:Microsoft.Identity.Client.PlatformsCommon.Interfaces.IPlatformProxy.BrokerSupportsWamAccounts"> <summary> WAM broker has a deeper integration into MSAL because MSAL needs to store WAM account IDs in the token cache. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetWebUiFactory(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetDeviceModel"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetOperatingSystem"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetProcessorArchitecture"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetUserPrincipalNameAsync"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetCallingApplicationName"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetCallingApplicationVersion"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetDeviceId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetDefaultRedirectUri(System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetProductName"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.GetRuntimeVersion"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.CreateLegacyCachePersistence"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.CryptographyManager"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.PlatformLogger"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.PlatformsCommon.Shared.AbstractPlatformProxy.LegacyCacheRequiresSerialization"> <summary> On Android, iOS and UWP, MSAL will save the legacy ADAL cache in a known location. On other platforms, the app developer must use the serialization callbacks </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.DeviceAuthHelper.GetBypassChallengeResponse(System.Net.Http.Headers.HttpResponseHeaders)"> <summary> Constructs a bypass response to the PKeyAuth challenge on platforms where the challenge cannot be completed. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.DeviceAuthHelper.GetBypassChallengeResponse(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Constructs a bypass response to the PKeyAuth challenge on platforms where the challenge cannot be completed. </summary> </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor"> <summary> Stores tokens for an application. Partitions the access token collection by a key of client ID with tenant ID. App metadata collection is not partitioned. Refresh token, ID token, and account related methods are no-op. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.SaveRefreshToken(Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem)"> <summary> This method is not supported for the app token cache because there are no refresh tokens in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.SaveIdToken(Microsoft.Identity.Client.Cache.Items.MsalIdTokenCacheItem)"> <summary> This method is not supported for the app token cache because there are no ID tokens in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.SaveAccount(Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem)"> <summary> This method is not supported for the app token cache because there are no user accounts in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.GetIdToken(Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem)"> <summary> This method is not supported for the app token cache because there are no ID tokens in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.GetAccount(Microsoft.Identity.Client.Cache.Keys.MsalAccountCacheKey)"> <summary> This method is not supported for the app token cache because there are no user accounts in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.DeleteRefreshToken(Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem)"> <summary> This method is not supported for the app token cache because there are no refresh tokens in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.DeleteIdToken(Microsoft.Identity.Client.Cache.Items.MsalIdTokenCacheItem)"> <summary> This method is not supported for the app token cache because there are no ID tokens in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.DeleteAccount(Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem)"> <summary> This method is not supported for the app token cache because there are no user accounts in a client credential flow. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedAppTokenCacheAccessor.GetAllAccessTokens(System.String)"> <summary> WARNING: if partitonKey = null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </summary> </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor"> <summary> Stores tokens for users. Partitions the access and refresh token collections by a user assertion hash in case of OBO and by home account ID otherwise. Partitions the ID token and account collections by home account ID. App metadata collection is not partitioned. </summary> </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor.GetAllAccessTokens(System.String)"> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor.GetAllRefreshTokens(System.String)"> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor.GetAllIdTokens(System.String)"> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor.GetAllAccounts(System.String)"> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </member> <member name="M:Microsoft.Identity.Client.PlatformsCommon.Shared.InMemoryPartitionedUserTokenCacheAccessor.HasAccessOrRefreshTokens"> WARNING: this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Shared.NullDeviceAuthManager"> <summary> Used for platforms that do not implement PKeyAuth. </summary> </member> <member name="T:Microsoft.Identity.Client.PlatformsCommon.Shared.SimpleHttpClientFactory"> <summary> A simple implementation of the HttpClient factory that uses a managed HttpClientHandler </summary> <remarks> This implementation is not suitable for high-scale applications / confidential client scenarios because a static HttpClient might run into DNS issues (and creating new HttpClients leads to a port exhaustion issue). Mobile platforms should use HttpClientHandlers that are platform specific. .NET Core should use the IHttpClientFactory, but MSAL cannot take a dependency on it as it has too many dependencies itself. </remarks> </member> <member name="T:Microsoft.Identity.Client.PreserveAttribute"> <summary> Attribute that will be picked up by the Xamarin Linker, as a hint for the linker to not remove the type. Needs to be added to types that get created by reflection, e.g. JSON serialization types </summary> <remarks>It's important to not change the name and the 2 fields of this class. The linker looks for these.</remarks> </member> <member name="T:Microsoft.Identity.Client.Prompt"> <summary> Structure containing static members that you can use to specify how the interactive overrides of AcquireTokenAsync in <see cref="T:Microsoft.Identity.Client.IPublicClientApplication" /> should prompt the user. </summary> </member> <member name="F:Microsoft.Identity.Client.Prompt.SelectAccount"> <summary> AcquireToken will send <c>prompt=select_account</c> to the authorization server's authorize endpoint. which would present to the user a list of accounts from which one can be selected for authentication. </summary> <remarks> This is the default prompt for backwards compatibility reasons. Please use <see cref="F:Microsoft.Identity.Client.Prompt.NoPrompt"/> for the best user experience. </remarks> </member> <member name="F:Microsoft.Identity.Client.Prompt.ForceLogin"> <summary> The user will be prompted for credentials by the service. It is achieved by sending <c>prompt=login</c> to the authorize endpoint. </summary> </member> <member name="F:Microsoft.Identity.Client.Prompt.Consent"> <summary> The user will be prompted to consent, even if consent was granted before. It is achieved by sending <c>prompt=consent</c> to the authorization server's authorize endpoint. </summary> </member> <member name="F:Microsoft.Identity.Client.Prompt.NoPrompt"> <summary> Let the identity service decide on the best user experience, based on browser cookies and on the login hint, which can be specified using WithAccount() or WithLoginHint() </summary> <remarks>This is the recommended prompt</remarks> </member> <member name="F:Microsoft.Identity.Client.Prompt.Create"> <summary> AcquireToken will send <c>prompt=create</c> to the authorization server's authorize endpoint which would trigger a sign-up experience, used for External Identities. </summary> <remarks>More details at https://aka.ms/msal-net-prompt-create. </remarks> </member> <member name="F:Microsoft.Identity.Client.Prompt.Never"> <summary> Only available on .NET platform. AcquireToken will send <c>prompt=attempt_none</c> to the authorization server's authorize endpoint and the library will use a hidden WebView (and its cookies) to authenticate the user. This can fail, and in that case a <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/> will be thrown. </summary> </member> <member name="M:Microsoft.Identity.Client.Prompt.Equals(System.Object)"> <summary> Equals method override to compare Prompt structs </summary> <param name="obj">object to compare against</param> <returns>true if object are equal.</returns> </member> <member name="M:Microsoft.Identity.Client.Prompt.GetHashCode"> <summary> Override to compute hash code </summary> <returns>hash code of the PromptValue</returns> </member> <member name="M:Microsoft.Identity.Client.Prompt.op_Equality(Microsoft.Identity.Client.Prompt,Microsoft.Identity.Client.Prompt)"> <summary> Operator overload to check equality </summary> <param name="x">first value</param> <param name="y">second value</param> <returns>true if the objects are equal</returns> </member> <member name="M:Microsoft.Identity.Client.Prompt.op_Inequality(Microsoft.Identity.Client.Prompt,Microsoft.Identity.Client.Prompt)"> <summary> Operator overload to check inequality </summary> <param name="x">first value</param> <param name="y">second value</param> <returns>true if the objects are not equal</returns> </member> <member name="T:Microsoft.Identity.Client.TelemetryCallback"> <summary> This callback is for the raw telemetry events (app, HTTP, cache) that we want to aggregate using MATS. </summary> <param name="events"></param> </member> <member name="T:Microsoft.Identity.Client.TelemetryCore.Http.HttpTelemetryManager"> <summary> Responsible for recording API events and formatting CSV with telemetry. </summary> <remarks> Not fully thread safe - it is possible that multiple threads request the "previous requests" data at the same time. It is the responsibility of the caller to protect against this. </remarks> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.Http.HttpTelemetryManager.GetLastRequestHeader"> <summary> CSV expected format: 3|silent_successful_count|failed_requests|errors|platform_fields failed_request is: api_id_1,correlation_id_1,api_id_2,correlation_id_2|error_1,error_2 </summary> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.Http.HttpTelemetryManager.GetCurrentRequestHeader(Microsoft.Identity.Client.TelemetryCore.Internal.Events.ApiEvent)"> <summary> Expected format: 5|api_id,cache_info,region_used,region_autodetection,region_outcome|platform_config platform_config: is_token_cache_serialized,is_legacy_cache_enabled </summary> </member> <member name="T:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager"> <summary> Controls the HTTP telemetry that MSAL sends to AAD via HTTP headers when contacting the /token endpoint. </summary> <remarks> - It is assumed that one manager is created for each application and shared between requests - Implementer must be thread safe, since one app can fire multiple requests </remarks> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager.RecordStoppedEvent(Microsoft.Identity.Client.TelemetryCore.Internal.Events.ApiEvent)"> <summary> Record a stopped event </summary> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager.GetCurrentRequestHeader(Microsoft.Identity.Client.TelemetryCore.Internal.Events.ApiEvent)"> <summary> Csv string with details about the current header (api used, force refresh flag) </summary> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager.GetLastRequestHeader"> <summary> Csv string with details about the previous failed requests made: api, correlation id, error </summary> <remarks> If AAD returns OK or a normal error (e.g. interaction required), then telemetry is recorded. If AAD returns a 5xx or 429 HTTP error (i.e. AAD is down), then telemetry has not been recorded and MSAL will continue to hold on to this data until a successful request is made </remarks> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager.ResetPreviousUnsentData"> <summary> Resets the state of failed requests. See <see cref="M:Microsoft.Identity.Client.TelemetryCore.IHttpTelemetryManager.GetLastRequestHeader"/> for more details </summary> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.Internal.ActionComparer.IsEquivalentClass(Microsoft.Identity.Client.TelemetryCore.Internal.ActionPropertyBag,Microsoft.Identity.Client.TelemetryCore.Internal.ActionPropertyBag)"> <summary> Returns true if the actions are the same, either are ready for upload, and either is not aggregable. This is used to determine whether or not we should aggregate this particular property bag of event data. </summary> <param name="action1"></param> <param name="action2"></param> <returns></returns> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.Internal.Events.HttpEvent.RequestIdHeader"> <summary> GUID included in request header </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.Internal.Events.HttpEvent.TokenAge"> <summary> Floating-point value with a unit of milliseconds indicating the refresh token age </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.Internal.Events.HttpEvent.SpeInfo"> <summary> Indicates whether the request was executed on a ring serving SPE traffic. An empty string indicates this occurred on an outer ring, and the string "I" indicates the request occurred on the inner ring </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.Internal.Events.HttpEvent.ServerErrorCode"> <summary> Error code sent by ESTS </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.Internal.Events.HttpEvent.ServerSubErrorCode"> <summary> Error code which gives more detailed information about server error code </summary> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.TelemetryManager.EventKey.Equals(Microsoft.Identity.Client.TelemetryCore.TelemetryManager.EventKey)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.TelemetryManager.EventKey.GetHashCode"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.TelemetryCore.TelemetryManager.EventKey.Equals(System.Object)"> <inheritdoc /> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.XmsCliTelemInfo.Version"> <summary> Monotonically increasing integer specifying x-ms-cliteleminfo header version </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.XmsCliTelemInfo.ServerErrorCode"> <summary> Bundle id for server error. </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.XmsCliTelemInfo.ServerSubErrorCode"> <summary> Bundle id for server suberror. </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.XmsCliTelemInfo.TokenAge"> <summary> Bundle id for refresh token age. Floating-point value with a unit of milliseconds </summary> </member> <member name="P:Microsoft.Identity.Client.TelemetryCore.XmsCliTelemInfo.SpeInfo"> <summary> Bundle id for spe_ring info. Indicates whether the request was executed on a ring serving SPE traffic. An empty string indicates this occurred on an outer ring, and the string "I" indicates the request occurred on the inner ring </summary> </member> <member name="T:Microsoft.Identity.Client.TenantProfile"> <summary> Represents an account in a specific tenant. The same account can exist in its home tenant and also as a guest in multiple other tenants. Access tokens and Id Tokens are tenant specific and this object provides high level information about all the ID tokens associated with the account. </summary> </member> <member name="P:Microsoft.Identity.Client.TenantProfile.Oid"> <summary> The immutable identifier for an user account, in a specific tenant. This ID uniquely identifies the user across applications - two different applications signing in the same user will receive the same value in the oid claim. The user will have a different object ID in each tenant - they're considered different accounts, even though the user logs into each account with the same credentials. </summary> </member> <member name="P:Microsoft.Identity.Client.TenantProfile.TenantId"> <summary> Represents the tenant that the user is signing in to. For work and school accounts, the GUID is the immutable tenant ID of the organization that the user is signing in to. For sign-ins to the personal Microsoft account tenant (services like Xbox, Teams for Life, or Outlook), the value is 9188040d-6c67-4c5b-b112-36a304b66dad. </summary> </member> <member name="P:Microsoft.Identity.Client.TenantProfile.ClaimsPrincipal"> <summary> All the claims present in the ID Token associated with this profile. </summary> </member> <member name="P:Microsoft.Identity.Client.TenantProfile.IsHomeTenant"> <summary> Returns <c>true</c> if this profile is associated with the user's home tenant. </summary> </member> <member name="T:Microsoft.Identity.Client.TokenCacheExtensions"> <summary> Extension methods for ITokenCache </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheExtensions.SetCacheOptions(Microsoft.Identity.Client.ITokenCache,Microsoft.Identity.Client.CacheOptions)"> <summary> Options for MSAL token caches. MSAL maintains a token cache internally in memory. By default, this cache object is part of each instance of <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> or <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>. This method allows customization of the in-memory token cache of MSAL. MSAL's memory cache is different than token cache serialization. Cache serialization pulls the tokens from a cache (e.g. Redis, Cosmos, or a file on disk), where they are stored in JSON format, into MSAL's internal memory cache. Memory cache operations do not involve JSON operations. External cache serialization remains the recommended way to handle desktop apps, web site and web APIs, as it provides persistence. These options do not currently control external cache serialization. Detailed guidance for each application type and platform: https://aka.ms/msal-net-token-cache-serialization </summary> <param name="tokenCache">Either the UserTokenCache or the AppTokenCache, for which these options apply.</param> <param name="options">Options for the internal MSAL token caches. </param> </member> <member name="T:Microsoft.Identity.Client.TokenSource"> <summary> Specifies the source of the access and Id tokens in the authentication result. </summary> </member> <member name="F:Microsoft.Identity.Client.TokenSource.IdentityProvider"> <summary> The source of the access and Id token is Identity Provider - Azure Active Directory (AAD), ADFS or AAD B2C. </summary> </member> <member name="F:Microsoft.Identity.Client.TokenSource.Cache"> <summary> The source of access and Id token is MSAL's cache. </summary> </member> <member name="F:Microsoft.Identity.Client.TokenSource.Broker"> <summary> The source of the access and Id token is a broker application - Authenticator or Company Portal. Brokers are supported only on Android and iOS. </summary> </member> <member name="T:Microsoft.Identity.Client.UiRequiredExceptionClassification"> <summary> Details about the cause of an <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/>, giving a hint about what the user can expect when they go through interactive authentication. See https://aka.ms/msal-net-UiRequiredException for details. </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.None"> <summary> No further details are provided. It is possible that the user will be able to resolve the issue by launching interactive authentication. See https://aka.ms/msal-net-UiRequiredException for details </summary> <remarks>This is also the classification when no account or valid login hint is passed to AcquireTokenSilent</remarks> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.MessageOnly"> <summary> Issue cannot be resolved at this time. Launching interactive authentication flow will show a message explaining the condition. See https://aka.ms/msal-net-UiRequiredException for details </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.BasicAction"> <summary> Issue can be resolved by user interaction during the interactive authentication flow. See https://aka.ms/msal-net-UiRequiredException for details </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.AdditionalAction"> <summary> Issue can be resolved by additional remedial interaction with the system, outside of the interactive authentication flow. Starting an interactive authentication flow will show the user what they need to do, but it is possible that the user is unable to complete the action. See https://aka.ms/msal-net-UiRequiredException for details </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.ConsentRequired"> <summary> User consent is missing, or has been revoked. Issue can be resolved by user consenting during the interactive authentication flow. See https://aka.ms/msal-net-UiRequiredException for details </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.UserPasswordExpired"> <summary> User's password has expired. Issue can be resolved by user during the interactive authentication flow. See https://aka.ms/msal-net-UiRequiredException for details. </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.PromptNeverFailed"> <summary> <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"/> was used with Prompt.Never value, however this could not be honored by the server. Please use a different prompt behavior, such as <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount"/> See https://aka.ms/msal-net-UiRequiredException for details. </summary> </member> <member name="F:Microsoft.Identity.Client.UiRequiredExceptionClassification.AcquireTokenSilentFailed"> <summary> An AcquireTokenSilent call failed. This is usually part of the pattern of calling AcquireTokenSilent for getting a token from the cache, followed by an a different AcquireToken call for getting a token from AAD. See the error message for details. See https://aka.ms/msal-net-UiRequiredException for details. </summary> </member> <member name="P:Microsoft.Identity.Client.UI.AuthorizationResult.State"> <summary> A string that is added to each Authorization Request and is expected to be sent back along with the authorization code. MSAL is responsible for validating that the state sent is identical to the state received. </summary> <remarks> This is in addition to PKCE, which is validated by the server to ensure that the system redeeming the auth code is the same as the system who asked for it. It protects against XSRF https://openid.net/specs/openid-connect-core-1_0.html </remarks> </member> <member name="M:Microsoft.Identity.Client.UI.CustomWebUiHandler.AcquireAuthorizationAsync(System.Uri,System.Uri,Microsoft.Identity.Client.Internal.RequestContext,System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.UI.CustomWebUiHandler.UpdateRedirectUri(System.Uri)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.UI.IWebUI.UpdateRedirectUri(System.Uri)"> <summary> Extra validations on the redirect URI, for example system web views cannot work with the urn:oob... URI because there is no way of knowing which app to get back to. WebUIs can update the URI, for example use http://localhost:1234 instead of http://localhost. Throws, if URI is invalid. </summary> </member> <member name="T:Microsoft.Identity.Client.UserAssertion"> <seealso cref="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> </member> <member name="M:Microsoft.Identity.Client.UserAssertion.#ctor(System.String)"> <summary> Constructor from a JWT assertion. For other assertion types (SAML), use the other constructor <see cref="M:Microsoft.Identity.Client.UserAssertion.#ctor(System.String,System.String)"/> </summary> <param name="jwtBearerToken">JWT bearer token used to access the Web application itself</param> </member> <member name="M:Microsoft.Identity.Client.UserAssertion.#ctor(System.String,System.String)"> <summary> Constructor of a UserAssertion specifying the assertionType in addition to the assertion </summary> <param name="assertion">Assertion representing the user.</param> <param name="assertionType">Type of the assertion representing the user. Accepted types are currently: <list type="bullet"> <item><term>urn:ietf:params:oauth:grant-type:jwt-bearer</term><description>JWT bearer token. Passing this is equivalent to using the other (simpler) constructor</description></item> <item><term>urn:ietf:params:oauth:grant-type:saml1_1-bearer</term><description>SAML 1.1 bearer token</description></item> <item><term>urn:ietf:params:oauth:grant-type:saml2-bearer</term><description>SAML 2 bearer token</description></item> </list></param> </member> <member name="P:Microsoft.Identity.Client.UserAssertion.Assertion"> <summary> Gets the assertion. </summary> </member> <member name="P:Microsoft.Identity.Client.UserAssertion.AssertionType"> <summary> Gets the assertion type. </summary> </member> <member name="F:Microsoft.Identity.Client.Utils.Base64UrlHelpers.s_base64Table"> <summary> Encoding table </summary> </member> <member name="M:Microsoft.Identity.Client.Utils.Base64UrlHelpers.Encode(System.String)"> <summary> The following functions perform base64url encoding which differs from regular base64 encoding as follows * padding is skipped so the pad character '=' doesn't have to be percent encoded * the 62nd and 63rd regular base64 encoding characters ('+' and '/') are replace with ('-' and '_') The changes make the encoding alphabet file and URL safe. </summary> <param name="arg">string to encode.</param> <returns>Base64Url encoding of the UTF8 bytes.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.Base64UrlHelpers.Encode(System.Byte[],System.Int32,System.Int32)"> <summary> Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify the subset as an offset in the input array, and the number of elements in the array to convert. </summary> <param name="inArray">An array of 8-bit unsigned integers.</param> <param name="length">An offset in inArray.</param> <param name="offset">The number of elements of inArray to convert.</param> <returns>The string representation in base 64 url encoding of length elements of inArray, starting at position offset.</returns> <exception cref="T:System.ArgumentNullException">'inArray' is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception> </member> <member name="M:Microsoft.Identity.Client.Utils.Base64UrlHelpers.Encode(System.Byte[])"> <summary> Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify the subset as an offset in the input array, and the number of elements in the array to convert. </summary> <param name="inArray">An array of 8-bit unsigned integers.</param> <returns>The string representation in base 64 url encoding of length elements of inArray, starting at position offset.</returns> <exception cref="T:System.ArgumentNullException">'inArray' is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception> </member> <member name="M:Microsoft.Identity.Client.Utils.Base64UrlHelpers.DecodeBytes(System.String)"> <summary> Converts the specified string, which encodes binary data as base-64-url digits, to an equivalent 8-bit unsigned integer array.</summary> <param name="str">base64Url encoded string.</param> <returns>UTF8 bytes.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.Base64UrlHelpers.Decode(System.String)"> <summary> Decodes the string from Base64UrlEncoded to UTF8. </summary> <param name="arg">string to decode.</param> <returns>UTF8 string.</returns> </member> <member name="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"> <summary> Represents a thread-safe hash-based unique collection. </summary> <typeparam name="T">The type of the items in the collection.</typeparam> <remarks> All public members of <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> are thread-safe and may be used concurrently from multiple threads. Based on the implementation from: https://github.com/i3arnon/ConcurrentHashSet/blob/main/src/ConcurrentHashSet/ConcurrentHashSet.cs </remarks> </member> <member name="P:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.Count"> <summary> Gets the number of items contained in the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>. </summary> <value>The number of items contained in the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</value> <remarks>Count has snapshot semantics and represents the number of items in the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> at the moment when Count was accessed.</remarks> </member> <member name="P:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.IsEmpty"> <summary> Gets a value that indicates whether the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> is empty. </summary> <value>true if the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> is empty; otherwise, false.</value> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that is empty, has the default concurrency level, has the default initial capacity, and uses the default comparer for the item type. </summary> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Int32,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that is empty, has the specified concurrency level and capacity, and uses the default comparer for the item type. </summary> <param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> concurrently.</param> <param name="capacity">The initial number of elements that the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> can contain.</param> <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="concurrencyLevel"/> is less than 1.</exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="capacity"/> is less than 0.</exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable{T}"/>, has the default concurrency level, has the default initial capacity, and uses the default comparer for the item type. </summary> <param name="collection">The <see cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to the new <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</param> <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference.</exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEqualityComparer{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that is empty, has the specified concurrency level and capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>. </summary> <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/> implementation to use when comparing items.</param> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable"/>, has the default concurrency level, has the default initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>. </summary> <param name="collection">The <see cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to the new <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</param> <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/> implementation to use when comparing items.</param> <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference (Nothing in Visual Basic). </exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable"/>, has the specified concurrency level, has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>. </summary> <param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> concurrently.</param> <param name="collection">The <see cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to the new <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</param> <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/> implementation to use when comparing items.</param> <exception cref="T:System.ArgumentNullException"> <paramref name="collection"/> is a null reference. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="concurrencyLevel"/> is less than 1. </exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.#ctor(System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> class that is empty, has the specified concurrency level, has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>. </summary> <param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> concurrently.</param> <param name="capacity">The initial number of elements that the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> can contain.</param> <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/> implementation to use when comparing items.</param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="concurrencyLevel"/> is less than 1. -or- <paramref name="capacity"/> is less than 0. </exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.Add(`0)"> <summary> Adds the specified item to the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>. </summary> <param name="item">The item to add.</param> <returns>true if the items was added to the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> successfully; false if it already exists.</returns> <exception cref="T:System.OverflowException">The <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> contains too many items.</exception> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.Clear"> <summary> Removes all items from the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>. </summary> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.Contains(`0)"> <summary> Determines whether the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> contains the specified item. </summary> <param name="item">The item to locate in the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</param> <returns>true if the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/> contains the item; otherwise, false.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.TryRemove(`0)"> <summary> Attempts to remove the item from the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>. </summary> <param name="item">The item to remove.</param> <returns>true if an item was removed successfully; otherwise, false.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.GetEnumerator"> <summary>Returns an enumerator that iterates through the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</summary> <returns>An enumerator for the <see cref="T:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1"/>.</returns> <remarks> The enumerator returned from the collection is safe to use concurrently with reads and writes to the collection, however it does not represent a moment-in-time snapshot of the collection. The contents exposed through the enumerator may contain modifications made to the collection after <see cref="M:Microsoft.Identity.Client.Utils.ConcurrentHashSet`1.GetEnumerator"/> was called. </remarks> </member> <member name="T:Microsoft.Identity.Client.Utils.OptionalSemaphoreSlim"> <summary> An object that either wraps a SemaphoreSlim for synchronization or ignores synchronization completely and just keeps track of Wait / Release operations. </summary> </member> <member name="T:Microsoft.Identity.Client.Utils.RetryOperationHelper"> <summary> Provides functionality to automatically try the given piece of logic some number of times before re-throwing the exception. This is useful for any piece of code which may experience transient failures. Be cautious of passing code with two distinct actions given that if the second or subsequent piece of logic fails, the first will also be retried upon each retry. </summary> <remarks> Copied from https://github.com/microsoft/RetryOperationHelper/blob/master/RetryOperationHelper/RetryOperationHelper.cs </remarks> </member> <member name="M:Microsoft.Identity.Client.Utils.RetryOperationHelper.ExecuteWithRetryAsync``1(System.Func{System.Threading.Tasks.Task{``0}},System.Int32,System.Nullable{System.TimeSpan},System.Action{System.Int32,System.Exception},System.Collections.Generic.ISet{System.Type})"> <summary>Executes asynchronous function with retry logic.</summary> <param name="func">The asynchronous function to be executed.</param> <param name="maxAttempts">The maximum number of attempts.</param> <param name="retryInterval">Timespan to wait between attempts of the operation</param> <param name="onAttemptFailed">The callback executed when an attempt is failed.</param> <param name="allowedExceptions">Allowed exceptions</param> <typeparam name="T">The result type.</typeparam> <returns>The <see cref="T:System.Threading.Tasks.Task"/> producing the result.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.RetryOperationHelper.ExecuteWithRetryAsync(System.Func{System.Threading.Tasks.Task},System.Int32,System.Nullable{System.TimeSpan},System.Action{System.Int32,System.Exception},System.Collections.Generic.ISet{System.Type})"> <summary>Executes asynchronous function with retry logic.</summary> <param name="func">The asynchronous function to be executed.</param> <param name="maxAttempts">The maximum number of attempts.</param> <param name="retryInterval">Timespan to wait between attempts of the operation</param> <param name="onAttemptFailed">The retry handler.</param> <param name="allowedExceptions"></param> <returns>The <see cref="T:System.Threading.Tasks.Task"/> producing the result.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.StringExtensions.ToByteArray(System.String)"> <summary> Create an array of bytes representing the UTF-8 encoding of the given string. </summary> <param name="stringInput">String to get UTF-8 bytes for</param> <returns>Array of UTF-8 character bytes</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.StringExtensions.Replace(System.String,System.String,System.String,System.StringComparison)"> <summary> Culture aware String.Replace </summary> </member> <member name="M:Microsoft.Identity.Client.Utils.StringExtensions.Contains(System.String,System.String,System.StringComparison)"> <summary> Culture aware Contains </summary> </member> <member name="T:Microsoft.Identity.Client.Utils.Windows.WindowsNativeUtils"> <summary> Public Windows native methods </summary> </member> <member name="M:Microsoft.Identity.Client.Utils.Windows.WindowsNativeUtils.IsElevatedUser"> <summary> Tests whether the current user is a member of the Administrator's group. </summary> <returns>True if the current user is an Admin; false, otherwise.</returns> </member> <member name="M:Microsoft.Identity.Client.Utils.Windows.WindowsNativeUtils.InitializeProcessSecurity"> <summary> Registers security and sets the security values for the process. </summary> <remarks> Workaround to enable WAM Account Picker in an elevated process. </remarks> </member> <member name="M:Microsoft.Identity.Client.WsTrust.CommonNonInteractiveHandler.GetPlatformUserAsync"> <summary> Gets the currently logged in user. Works for Windows when user is AD or AAD joined. Throws otherwise if cannot be found. </summary> </member> <member name="T:Microsoft.Identity.Client.WsTrust.IWsTrustWebRequestManager"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.WsTrust.IWsTrustWebRequestManager.GetMexDocumentAsync(System.String,Microsoft.Identity.Client.Internal.RequestContext,System.String)"> <summary> </summary> <param name="federationMetadataUrl"></param> <param name="requestContext"></param> <param name="federationMetadata"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.WsTrust.IWsTrustWebRequestManager.GetWsTrustResponseAsync(Microsoft.Identity.Client.WsTrust.WsTrustEndpoint,System.String,Microsoft.Identity.Client.Internal.RequestContext)"> <summary> </summary> <param name="wsTrustEndpoint"></param> <param name="wsTrustRequest"></param> <param name="requestContext"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.WsTrust.IWsTrustWebRequestManager.GetUserRealmAsync(System.String,System.String,Microsoft.Identity.Client.Internal.RequestContext)"> <summary> </summary> <param name="userRealmUriPrefix"></param> <param name="userName"></param> <param name="requestContext"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.WsTrust.WsTrustWebRequestManager.GetMexDocumentAsync(System.String,Microsoft.Identity.Client.Internal.RequestContext,System.String)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.WsTrust.WsTrustWebRequestManager.GetWsTrustResponseAsync(Microsoft.Identity.Client.WsTrust.WsTrustEndpoint,System.String,Microsoft.Identity.Client.Internal.RequestContext)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.WwwAuthenticateParameters"> <summary> Parameters returned by the WWW-Authenticate header. This allows for dynamic scenarios such as claim challenge, CAE, CA auth context. See https://aka.ms/msal-net/wwwAuthenticate. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Resource"> <summary> Resource for which to request scopes. This is the App ID URI of the API that returned the WWW-Authenticate header. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Scopes"> <summary> Scopes to request. If it's not provided by the web API, it's computed from the Resource. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Authority"> <summary> Authority from which to request an access token. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Claims"> <summary> Claims demanded by the web API. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Error"> <summary> Error. </summary> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.Item(System.String)"> <summary> Return the <see cref="P:Microsoft.Identity.Client.WwwAuthenticateParameters.RawParameters"/> of key <paramref name="key"/>. </summary> <param name="key">Name of the raw parameter to retrieve.</param> <returns>The raw parameter if it exists, or throws a <see cref="T:System.Collections.Generic.KeyNotFoundException"/> otherwise. </returns> </member> <member name="P:Microsoft.Identity.Client.WwwAuthenticateParameters.RawParameters"> <summary> Dictionary of raw parameters in the WWW-Authenticate header (extracted from the WWW-Authenticate header string value, without any processing). This allows support for APIs which are not mappable easily to the standard or framework specific (Microsoft.Identity.Model, Microsoft.Identity.Web). </summary> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.GetTenantId"> <summary> Gets Azure AD tenant ID. </summary> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.CreateFromResponseHeaders(System.Net.Http.Headers.HttpResponseHeaders,System.String)"> <summary> Create WWW-Authenticate parameters from the HttpResponseHeaders. </summary> <param name="httpResponseHeaders">HttpResponseHeaders.</param> <param name="scheme">Authentication scheme. Default is "Bearer".</param> <returns>The parameters requested by the web API.</returns> <remarks>Currently it only supports the Bearer scheme</remarks> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.CreateFromWwwAuthenticateHeaderValue(System.String)"> <summary> Creates parameters from the WWW-Authenticate string. </summary> <param name="wwwAuthenticateValue">String contained in a WWW-Authenticate header.</param> <returns>The parameters requested by the web API.</returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.CreateFromResourceResponseAsync(System.String)"> <summary> Create the authenticate parameters by attempting to call the resource unauthenticated, and analyzing the response. </summary> <param name="resourceUri">URI of the resource.</param> <returns>WWW-Authenticate Parameters extracted from response to the unauthenticated call.</returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.CreateFromResourceResponseAsync(System.String,System.Threading.CancellationToken)"> <summary> Create the authenticate parameters by attempting to call the resource unauthenticated, and analyzing the response. </summary> <param name="resourceUri">URI of the resource.</param> <param name="cancellationToken">The cancellation token to cancel operation.</param> <returns>WWW-Authenticate Parameters extracted from response to the unauthenticated call.</returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.CreateFromResourceResponseAsync(System.Net.Http.HttpClient,System.String,System.Threading.CancellationToken)"> <summary> Create the authenticate parameters by attempting to call the resource unauthenticated, and analyzing the response. </summary> <param name="httpClient">Instance of <see cref="T:System.Net.Http.HttpClient"/> to make the request with.</param> <param name="resourceUri">URI of the resource.</param> <param name="cancellationToken">The cancellation token to cancel operation.</param> <returns>WWW-Authenticate Parameters extracted from response to the unauthenticated call.</returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.GetClaimChallengeFromResponseHeaders(System.Net.Http.Headers.HttpResponseHeaders,System.String)"> <summary> Gets the claim challenge from HTTP header. Used, for example, for CA auth context. </summary> <param name="httpResponseHeaders">The HTTP response headers.</param> <param name="scheme">Authentication scheme. Default is Bearer.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.ExtractKeyValuePair(System.String)"> <summary> Extracts a key value pair from an expression of the form a=b </summary> <param name="assignment">assignment</param> <returns>Key Value pair</returns> </member> <member name="M:Microsoft.Identity.Client.WwwAuthenticateParameters.GetJsonFragment(System.String)"> <summary> Checks if input is a base-64 encoded string. If it is one, decodes it to get a json fragment. </summary> <param name="inputString">Input string</param> <returns>a json fragment (original input string or decoded from base64 encoded).</returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Http.DnsSensitiveClientHandler.AddConnectionLeaseTimeout(System.Uri)"> <summary> Based on https://github.com/NimaAra/Easy.Common/blob/master/Easy.Common/RestClient.cs and the associated blog post https://nima-ara-blog.azurewebsites.net/beware-of-the-net-httpclient/ </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Http.EndpointCacheKey"> <summary> Based on https://github.com/NimaAra/Easy.Common/blob/master/Easy.Common/RestClient.cs </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode"> <summary> Padding modes </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode.None"> <summary> No padding </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode.Pkcs1"> <summary> PKCS #1 padding </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode.Oaep"> <summary> Optimal Asymmetric Encryption Padding </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode.Pss"> <summary> Probabilistic Signature Scheme padding </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative"> <summary> Native wrappers for bcrypt CNG APIs. The general pattern for this interop layer is that the BCryptNative type exports a wrapper method for consumers of the interop methods. This wrapper method puts a managed face on the raw P/Invokes, by translating from native structures to managed types and converting from error codes to exceptions. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.AlgorithmName"> <summary> Well known algorithm names </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.AlgorithmProviderOptions"> <summary> Flags for BCryptOpenAlgorithmProvider </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.AuthenticatedCipherModeInfoFlags"> <summary> Flags for use with the BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO structure </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.ChainingMode"> <summary> Well known chaining modes </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.ErrorCode"> <summary> Result codes from BCrypt APIs </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.KeyBlobMagicNumber"> <summary> Magic numbers for different key blobs </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.KeyBlobType"> <summary> Well known key blob tyes </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.ParameterTypes"> <summary> BCrypt parameter types (used in parameter lists) </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.BCryptNative.ProviderName"> <summary> Well known BCrypt provider names </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeBCryptAlgorithmHandle"> <summary> SafeHandle for a native BCRYPT_ALG_HANDLE </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeBCryptHashHandle"> <summary> SafeHandle for a BCRYPT_HASH_HANDLE. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeBCryptKeyHandle"> <summary> SafeHandle for a native BCRYPT_KEY_HANDLE. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.ICngAlgorithm.Provider"> <summary> Gets the algorithm or key storage provider being used for the implementation of the CNG algorithm. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.ICngAsymmetricAlgorithm"> <summary> Interface for asymmetric algorithms implemented over the CNG layer of Windows to provide CNG implementation details through. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.ICngAsymmetricAlgorithm.Key"> <summary> Get the CNG key being used by the asymmetric algorithm. </summary> <permission cref="T:System.Security.Permissions.SecurityPermission"> This method requires that the immediate caller have SecurityPermission/UnmanagedCode </permission> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptAlgorithmOperations"> <summary> Algorithm classes exposed by NCrypt </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative"> <summary> Native wrappers for ncrypt CNG APIs. The general pattern for this interop layer is that the NCryptNative type exports a wrapper method for consumers of the interop methods. This wrapper method puts a managed face on the raw P/Invokes, by translating from native structures to managed types and converting from error codes to exceptions. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.KeyPropertyName"> <summary> Well known key property names </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.NCryptAlgorithmClass"> <summary> NCrypt algorithm classes </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.ErrorCode"> <summary> Enum for some SECURITY_STATUS return codes </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.NCryptDecryptor`1"> <summary> Adapter to wrap specific NCryptDecrypt P/Invokes with specific padding info </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.NCryptEncryptor`1"> <summary> Adapter to wrap specific NCryptEncrypt P/Invokes with specific padding info </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.NCryptHashSigner`1"> <summary> Adapter to wrap specific NCryptSignHash P/Invokes with a specific padding info </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.SignHash``1(Microsoft.Win32.SafeHandles.SafeNCryptKeyHandle,System.Byte[],``0@,Microsoft.Identity.Client.Platforms.net45.Native.AsymmetricPaddingMode,Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.NCryptHashSigner{``0})"> <summary> Generic signature method, wrapped by signature calls for specific padding modes </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.SignHashPkcs1(Microsoft.Win32.SafeHandles.SafeNCryptKeyHandle,System.Byte[],System.String)"> <summary> Sign a hash, using PKCS1 padding </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.NCryptNative.SignHashPss(Microsoft.Win32.SafeHandles.SafeNCryptKeyHandle,System.Byte[],System.String,System.Int32)"> <summary> Sign a hash, using PSS padding </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeNCryptBuffer"> <summary> Handle for buffers that need to be released with NCryptFreeBuffer </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.SafeNCryptBuffer.ReadArray``1(System.UInt32)"> <summary> Helper method to read a structure out of the buffer, treating it as if it were an array of T. This method does not do any validation that the read data is within the buffer itself. Esentially, this method treats the safe handle as if it were a native T[], and returns handle[index]. It will add enough padding space such that each T will begin on a pointer-sized location. </summary> <typeparam name="T">type of structure to read from the buffer</typeparam> <param name="index">0 based index into the array to read the structure from</param> <returns>the value of the structure at the index into the array</returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.RSACng"> <summary> <para> The RSACng class provides a wrapper for the CNG implementation of the RSA algorithm. The interface provided by RSACng is derived from the <see cref="T:System.Security.Cryptography.RSA" /> base type, and not from the <see cref="T:System.Security.Cryptography.RSACryptoServiceProvider" /> class. Consequently, it is not a drop in replacement for existing uses of RSACryptoServiceProvider. </para> <para> RSACng uses a programming model more similar to the <see cref="T:System.Security.Cryptography.ECDsaCng" /> class than RSACryptoServiceProvider. For instance, unlike RSACryptoServiceProvider which has a key directly tied into the operations of the type itself, the key used by RsaCng is managed by a separate <see cref="T:System.Security.Cryptography.CngKey" /> object. Additionally, operations such as signing and verifying signatures take their parameters from a set of properties set on the RSACng object, similar to how ECDsaCng uses properties of its object to control the signing and verification operations. </para> <para> RSACng uses the NCrypt layer of CNG to do its work, and requires Windows Vista and the .NET Framework 3.5. </para> <para> Example usage: <example> // Create an RSA-SHA256 signature using the key stored in "MyKey" byte[] dataToSign = Encoding.UTF8.GetBytes("Data to sign"); using (CngKey signingKey = CngKey.Open("MyKey"); using (RSACng rsa = new RSACng(signingKey)) { rsa.SignatureHashAlgorithm = CngAlgorithm.Sha256; return rsa.SignData(dataToSign); } </example> </para> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.#ctor"> <summary> Create an RSACng algorithm with a random 2048 bit key pair. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.#ctor(System.Int32)"> <summary> Creates a new RSACng object that will use a randomly generated key of the specified size. Valid key sizes range from 384 to 16384 bits, in increments of 8. It's suggested that a minimum size of 2048 bits be used for all keys. </summary> <param name="keySize">size of hte key to generate, in bits</param> <exception cref="T:System.Security.Cryptography.CryptographicException">if <paramref name="keySize" /> is not valid</exception> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.#ctor(System.Security.Cryptography.CngKey)"> <summary> Creates a new RSACng object that will use the specified key. The key's <see cref="P:System.Security.Cryptography.CngKey.AlgorithmGroup" /> must be Rsa. </summary> <param name="key">key to use for RSA operations</param> <exception cref="T:System.ArgumentException">if <paramref name="key" /> is not an RSA key</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="key" /> is null</exception> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.EncryptionHashAlgorithm"> <summary> Sets the hash algorithm to use when encrypting or decrypting data using the OAEP padding method. This property is only used if data is encrypted or decrypted and the EncryptionPaddingMode is set to AsymmetricEncryptionPaddingMode.Oaep. The default value is Sha256. </summary> <exception cref="T:System.ArgumentNullException">if EncryptionHashAlgorithm is set to null</exception> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.EncryptionPaddingMode"> <summary> Sets the padding mode to use when encrypting or decrypting data. The default value is AsymmetricPaddingMode.Oaep. </summary> <exception cref="T:System.ArgumentNullException">if EncryptionPaddingMOde is set to null</exception> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.Key"> <summary> Gets the key that will be used by the RSA object for any cryptographic operation that it uses. This key object will be disposed if the key is reset, for instance by changing the KeySize property, using ImportParamers to create a new key, or by Disposing of the parent RSA object. Therefore, you should make sure that the key object is no longer used in these scenarios. This object will not be the same object as the CngKey passed to the RSACng constructor if that constructor was used, however it will point at the same CNG key. </summary> <permission cref="T:System.Security.Permissions.SecurityPermission"> SecurityPermission/UnmanagedCode is required to read this property. </permission> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.KeyHandle"> <summary> Helper property to get the NCrypt key handle </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.KeyExchangeAlgorithm"> <summary> Returns "RSA-PKCS1-KeyEx". This property should not be used. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.Provider"> <summary> Key storage provider being used for the algorithm </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignatureAlgorithm"> <summary> Returns "http://www.w3.org/2000/09/xmldsig#rsa-sha1". This property should not be used. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignatureHashAlgorithm"> <summary> Gets or sets the hash algorithm to use when signing or verifying data. The default value is Sha256. </summary> <exception cref="T:System.ArgumentNullException">if SignatureHashAlgorithm is set to null</exception> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignaturePaddingMode"> <summary> Gets or sets the padding mode to use when encrypting or decrypting data. The default value is AsymmetricPaddingMode.Pkcs1. </summary> <exception cref="T:System.ArgumentOutOfRangeException"> if SignaturePaddingMode is set to a mode other than Pkcs1 or Pss </exception> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignatureSaltBytes"> <summary> Gets or sets the number of bytes of salt to use when signing data or verifying a signature using the PSS padding mode. This property is only used if data is being signed or verified and the SignaturePaddingMode is set to AsymmetricEncryptionPaddingMode.Pss. The default value is 20 bytes. </summary> <exception cref="T:System.ArgumentOutOfRangeException"> if SignatureSaltBytes is set to a negative number </exception> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.Dispose(System.Boolean)"> <summary> Dispose implementation </summary> <param name="disposing"></param> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.BuildKeyContainerPermission(System.Security.Cryptography.CngKey,System.Security.Permissions.KeyContainerPermissionFlags)"> <summary> Build a key container permission that should be demanded before using the private key </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.CreateSignatureHashObject"> <summary> Create an object to hash signature data with </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignData(System.Byte[])"> <summary> SignData signs the given data after hashing it with the SignatureHashAlgorithm algorithm. </summary> <param name="data">data to sign</param> <exception cref="T:System.ArgumentNullException">if <paramref name="data" /> is null</exception> <exception cref="T:System.Security.Cryptography.CryptographicException">if <paramref name="data" /> could not be signed</exception> <exception cref="T:System.InvalidOperationException"> if SignatureHashAlgorithm is not MD5, SHA-1, SHA-256, SHA-384, or SHA-512 </exception> <permission cref="T:System.Security.Permissions.KeyContainerPermission"> This method will demand KeyContainerPermission if the key being used is not ephemeral. </permission> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignData(System.Byte[],System.Int32,System.Int32)"> <summary> SignData signs the given data after hashing it with the SignatureHashAlgorithm algorithm. </summary> <param name="data">data to sign</param> <param name="offset">offset into the data that the signature should begin covering</param> <param name="count">number of bytes to include in the signed data</param> <exception cref="T:System.ArgumentNullException">if <paramref name="data" /> is null</exception> <exception cref="T:System.ArgumentOutOfRangeException"> if <paramref name="offset" /> or <paramref name="count" /> are negative, or if <paramref name="count" /> specifies more bytes than are available in <paramref name="data" />. </exception> <exception cref="T:System.Security.Cryptography.CryptographicException">if <paramref name="data" /> could not be signed</exception> <exception cref="T:System.InvalidOperationException"> if SignatureHashAlgorithm is not MD5, SHA-1, SHA-256, SHA-384, or SHA-512 </exception> <permission cref="T:System.Security.Permissions.KeyContainerPermission"> This method will demand KeyContainerPermission if the key being used is not ephemeral. </permission> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignHash(System.Byte[])"> <summary> Sign data which was hashed using the SignatureHashAlgorithm; if the algorithm used to hash the data was different, use the SignHash(byte[], CngAlgorithm) overload instead. </summary> <param name="hash">hash to sign</param> <exception cref="T:System.ArgumentNullException">if <paramref name="hash" /> is null</exception> <exception cref="T:System.Security.Cryptography.CryptographicException">if <paramref name="hash" /> could not be signed</exception> <exception cref="T:System.InvalidOperationException"> if SignatureHashAlgorithm is not MD5, SHA-1, SHA-256, SHA-384, or SHA-512 </exception> <permission cref="T:System.Security.Permissions.KeyContainerPermission"> This method will demand KeyContainerPermission if the key being used is not ephemeral. </permission> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.SignHash(System.Byte[],System.Security.Cryptography.CngAlgorithm)"> <summary> Sign already hashed data, specifying the algorithm it was hashed with. This method does not use the SignatureHashAlgorithm property. </summary> <param name="hash">hash to sign</param> <param name="hashAlgorithm">algorithm <paramref name="hash" /> was signed with</param> <exception cref="T:System.ArgumentNullException"> if <paramref name="hash" /> or <paramref name="hashAlgorithm"/> are null </exception> <exception cref="T:System.Security.Cryptography.CryptographicException">if <paramref name="hash" /> could not be signed</exception> <permission cref="T:System.Security.Permissions.KeyContainerPermission"> This method will demand KeyContainerPermission if the key being used is not ephemeral. </permission> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.DecryptValue(System.Byte[])"> <summary> </summary> <param name="rgb"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.EncryptValue(System.Byte[])"> <summary> </summary> <param name="rgb"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.ExportParameters(System.Boolean)"> <summary> </summary> <param name="includePrivateParameters"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.RSACng.ImportParameters(System.Security.Cryptography.RSAParameters)"> <summary> </summary> <param name="parameters"></param> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeHandleWithBuffer"> <summary> Safe handle base class for safe handles which are associated with an additional data buffer that must be kept alive for the same amount of time as the handle itself. This is required rather than having a seperate safe handle own the key data buffer blob so that we can ensure that the key handle is disposed of before the key data buffer is freed. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.net45.Native.SafeHandleWithBuffer.DataBuffer"> <summary> Buffer that holds onto the key data object. This data must be allocated with CoAllocTaskMem, or the ReleaseBuffer method must be overriden to match the deallocation function with the allocation function. Once the buffer is assigned into the DataBuffer property, the safe handle owns the buffer and users of this property should not attempt to free the memory. This property should be set only once, otherwise the first data buffer will leak. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.SafeHandleWithBuffer.ReleaseBuffer"> <summary> Release the buffer associated with the handle </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.SafeHandleWithBuffer.ReleaseNativeHandle"> <summary> Release just the native handle associated with the safe handle </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeLibraryHandle"> <summary> SafeHandle for a native HMODULE </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.SafeLocalAllocHandle"> <summary> SafeHandle for memory allocated with LocalAlloc </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.Native.X509Native.AcquireCertificateKeyOptions"> <summary> Flags for the CryptAcquireCertificatePrivateKey API </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.X509Native.DuplicateCertContext(System.IntPtr)"> <summary> Duplicate the certificate context into a safe handle </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.Native.X509Native.AcquireCngPrivateKey(Microsoft.Identity.Client.Platforms.net45.SafeCertContextHandle)"> <summary> Get the private key of a certificate </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopCryptographyManager.GetCryptoProviderForSha256_Net45(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Create a <see cref="T:System.Security.Cryptography.RSACryptoServiceProvider"/> using the private key from the given <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>. </summary> <param name="certificate">Certificate including private key with which to initialize the <see cref="T:System.Security.Cryptography.RSACryptoServiceProvider"/> with</param> <returns><see cref="T:System.Security.Cryptography.RSACryptoServiceProvider"/> initialized with private key from <paramref name="certificate"/></returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopCryptographyManager.GetCngPrivateKey(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> <para> The GetCngPrivateKey method will return a <see cref="T:System.Security.Cryptography.CngKey" /> representing the private key of an X.509 certificate which has its private key stored with NCrypt rather than with CAPI. If the key is not stored with NCrypt or if there is no private key available, GetCngPrivateKey returns null. </para> <para> The HasCngKey method can be used to test if the certificate does have its private key stored with NCrypt. </para> <para> The X509Certificate that is used to get the key must be kept alive for the lifetime of the CngKey that is returned - otherwise the handle may be cleaned up when the certificate is finalized. </para> </summary> <permission cref="T:System.Security.Permissions.SecurityPermission">The caller of this method must have SecurityPermission/UnmanagedCode.</permission> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopCryptographyManager.GetCertificateContext(System.Security.Cryptography.X509Certificates.X509Certificate)"> <summary> Get a <see cref="T:System.Security.Cryptography.X509Certificates.SafeCertContextHandle" /> for the X509 certificate. The caller of this method owns the returned safe handle, and should dispose of it when they no longer need it. This handle can be used independently of the lifetime of the original X509 certificate. </summary> <permission cref="T:System.Security.Permissions.SecurityPermission"> The immediate caller must have SecurityPermission/UnmanagedCode to use this method </permission> </member> <member name="T:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy"> <summary> Platform / OS specific logic. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.#ctor(Microsoft.Identity.Client.Core.ICoreLogger)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.GetUserPrincipalNameAsync"> <summary> Get the user logged in to Windows or throws </summary> <returns>Upn or throws</returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.GetDefaultRedirectUri(System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.CreateLegacyCachePersistence"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.CreateWebUiFactory"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetDeviceModel"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetOperatingSystem"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetProcessorArchitecture"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetCallingApplicationName"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetCallingApplicationVersion"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetDeviceId"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetProductName"> <inheritdoc /> </member> <member name="M:Microsoft.Identity.Client.Platforms.net45.NetDesktopPlatformProxy.InternalGetCryptographyManager"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.Platforms.Shared.Desktop.OsBrowser.IUriInterceptor"> <summary> An abstraction over objects that are able to listen to localhost url (e.g. http://localhost:1234) and to retrieve the whole url, includiong query params (e.g. http://localhost:1234?code=auth_code_from_aad) </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Shared.Desktop.OsBrowser.IUriInterceptor.ListenToSingleRequestAndRespondAsync(System.Int32,System.String,System.Func{System.Uri,Microsoft.Identity.Client.Platforms.Shared.Desktop.OsBrowser.MessageAndHttpCode},System.Threading.CancellationToken)"> <summary> Listens to http://localhost:{port} and retrieve the entire url, including query params. Then push back a response such as a display message or a redirect. </summary> <remarks>Cancellation is very important as this is typically a long running unmonitored operation</remarks> <param name="port">the port to listen to</param> <param name="path">the path to listen in</param> <param name="responseProducer">The message to be displayed, or url to be redirected to will be created by this callback</param> <param name="cancellationToken">Cancellation token</param> <returns>Full redirect uri</returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventHandler"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventHandler"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.NavigationWaitMiliSecs"> <summary> This is how long we allow between completed navigations. </summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.NavigationOverallTimeout"> <summary> This is how long all redirect navigations are allowed to run for before a graceful termination of the entire browser based authentication process is attempted. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.WaitForCompletionOrTimeout(System.Threading.Thread)"> <summary> Waits on the UI Thread to complete normally for NavigationOverallTimeout. After it attempts shutdown the UI thread graceful followed by aborting the thread if a graceful shutdown is not successful. </summary> <param name="uiThread"></param> <returns>Returns true if the UI thread completed on its own before the timeout. Otherwise false.</returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.OnAuthenticate"> <summary> Callers expect the call to show the authentication dialog to be synchronous. This is easy in the interactive case as ShowDialog is a synchronous call. However, ShowDialog will always show the dialog. It can not be hidden. So it can not be used in the silent case. Instead we need to do the equivalent of creating our own modal dialog. We start a new thread, launch an invisible window on that thread. The original calling thread blocks until the secondary UI thread completes. </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.#ctor(System.Object)"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.NavigationWaitMiliSecs"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.CloseBrowser"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.SuppressBrowserSubDialogs"> <summary> Make sure that the browser control does not surface any of it's own dialogs. For instance bad certificate or javascript error dialogs. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.SignalDone(System.Exception)"> <summary> This method must only be called from the UI thread. Since this is the callers opportunity to call dispose on this object. Calling Dispose must be done on the same thread on which this object was constructed. </summary> <param name="exception"></param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.OnClosingUrl"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.OnNavigationCanceled(System.Int32)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.Dispose(System.Boolean)"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs"> <summary> Event arguments for <c>BeforeNavigate</c> event. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.#ctor(System.String,System.Byte[],System.String,System.Int32,System.String,System.Object)"> <summary> Initializes a new instance of <c>WebBrowserBeforeNavigateEventArgs</c>. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Url"> <summary> The URL to be navigated to. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.PostData"> <summary> The data to send to the server, if the HTTP POST transaction is used. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Headers"> <summary> Additional HTTP headers to send to the server </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Flags"> <summary> The following flag, or zero. beforeNavigateExternalFrameTarget (H0001) Internet Explorer 7 or later. This navigation is the result of an external window or tab that targets this browser. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.TargetFrameName"> <summary> The name of the frame in which to display the resource, or null if no named frame is targeted for the resource. </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.WebBrowserActiveXInstance"> <summary> A pointer to the IDispatch interface for the WebBrowserControl object that represents the window or frame. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.#ctor(System.String,System.String,System.Int32,System.Object)"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.TargetFrameName"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.Url"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.WebBrowserActiveXInstance"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.StatusCode"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog"> <summary> The browser dialog used for user authentication </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.#ctor(System.Object,Microsoft.Identity.Client.EmbeddedWebViewOptions)"> <summary> Default constructor </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnAuthenticate"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.ShowBrowser"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnClosingUrl"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnNavigationCanceled(System.Int32)"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.ownerWindow"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.#ctor(System.Object)"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowser"> <summary> Gets Web Browser control used by the dialog. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowserNavigateErrorHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnClosingUrl"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnNavigationCanceled(System.Int32)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnAuthenticate"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.InvokeHandlingOwnerWindow(System.Action)"> <summary> Some calls need to be made on the UI thread and this is the central place to check if we have an owner window and if so, ensure we invoke on that proper thread. </summary> <param name="action"></param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.Dispose(System.Boolean)"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.CreateExceptionForAuthenticationUiFailed(System.Int32)"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.NativeMethods"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.AcceptContextFlag"> <summary> Flags that specify the attributes required by the AcceptSecurityContext (CredSSP) function for a server to establish the context. https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.ContextStatus"> <summary> Result of AcceptSecurityContext (CredSSP) function call which lets the server component of a transport application establish a security context between the server and a remote client. https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.Credential"> <summary> Previously authenticated logon data used by a security principal to establish its own identity, such as a password, or a Kerberos protocol ticket. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.Credential.Current"> <summary> Create a new <see cref="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.Credential"/> object. </summary> <returns>Newly created <see cref="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.Credential"/> object.</returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.CredentialHandle"> <summary> Extension of a wrapper class for operating system handles. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.CredentialHandle.#ctor(System.Void*)"> <summary> Constructor. </summary> <param name="cred">Credential handle to initialize.</param> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.CredentialHandle.IsInvalid"> <summary> Checks the current contained handle is valid or not. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.CredentialHandle.ReleaseHandle"> <summary> Release contained internal resource object. </summary> <returns>True always.</returns> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.InitContextFlag"> <summary> Bit flags that indicate requests for the context for InitializeSecurityContext API call. https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-initializesecuritycontexta </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.SecStatus"> <summary> Status code returned from SSPI functions. https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-initializesecuritycontexta </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader"> <summary> Helper class to check Kerberos Ticket in user's Ticket Cache. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader.#ctor(System.String,System.Int64,System.String)"> <summary> Creates a <see cref="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader"/> object to read a Kerberos Ticket from Ticket Cache. </summary> <param name="spn">Service principal name of ticket to read out from Ticket Cache.</param> <param name="logonId">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> <param name="package">The name of the LSA authentication package that will be interacted with.</param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader.RequestToken"> <summary> Read out a Kerberos Ticket. </summary> <returns>Byte stream of Kereros Ticket if exists. Null otherwise.</returns> <remarks> Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if any error occurs while interfacing with Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader.Dispose(System.Boolean)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheReader.Dispose"> <summary> Clean up all data members used for interaction with Ticket Cache. </summary> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter"> <summary> Provides a layer to interact with the LSA functions used to create logon sessions and manipulate the ticket caches. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.Connect(System.String)"> <summary> Create a new instance of the interop as a standard unprivileged caller. </summary> <param name="package">The name of the LSA authentication package that will be interacted with.</param> <returns>Returns an instance of the <see cref="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter"/> class.</returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.ImportCredential(System.Byte[],System.Int64)"> <summary> Import a kerberos ticket containing one or more tickets into the current user ticket cache. </summary> <param name="ticketBytes">The ticket to import into the cache.</param> <param name="luid">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.LsaCallAuthenticationPackage(System.Void*,System.Int32)"> <summary> Call Auth package to cache given Kerberos ticket. </summary> <param name="pBuffer">Pointer to Kerberos Ticket to cache.</param> <param name="bufferSize">Length of Kerberos Ticket data.</param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.Dispose(System.Boolean)"> <summary> Dispose all interment members. </summary> <param name="disposing">True if Dispose() called by the user. False, otherwise.</param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.Finalize"> <summary> Deletes current object. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos.TicketCacheWriter.Dispose"> <inheritdoc /> </member> <member name="T:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler"> <summary>Provides a scheduler that uses STA threads.</summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler._threads"> <summary>The STA threads used by the scheduler.</summary> </member> <member name="F:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler._tasks"> <summary>Stores the queued tasks to be executed by our pool of STA threads.</summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.#ctor(System.Int32)"> <summary>Initializes a new instance of the StaTaskScheduler class with the specified concurrency level.</summary> <param name="numberOfThreads">The number of threads that should be created and used by this scheduler.</param> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.MaximumConcurrencyLevel"> <summary>Gets the maximum concurrency level supported by this scheduler.</summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.Dispose"> <summary> Cleans up the scheduler by indicating that no more tasks will be queued. This method blocks until all threads successfully shutdown. </summary> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.QueueTask(System.Threading.Tasks.Task)"> <summary>Queues a Task to be executed by this scheduler.</summary> <param name="task">The task to be executed.</param> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.GetScheduledTasks"> <summary>Provides a list of the scheduled tasks for the debugger to consume.</summary> <returns>An enumerable of all tasks currently scheduled.</returns> </member> <member name="M:Microsoft.Identity.Client.Platforms.Features.DesktopOs.StaTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)"> <summary>Determines whether a Task may be inlined.</summary> <param name="task">The task to be executed.</param> <param name="taskWasPreviouslyQueued">Whether the task was previously queued.</param> <returns>true if the task was successfully inlined; otherwise, false.</returns> </member> <member name="P:Microsoft.Identity.Client.Platforms.Features.DesktopOs.WindowsDpiHelper.ZoomPercent"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Json.Bson.BsonObjectId"> <summary> Represents a BSON Oid (object id). </summary> </member> <member name="P:Microsoft.Identity.Json.Bson.BsonObjectId.Value"> <summary> Gets or sets the value of the Oid. </summary> <value>The value of the Oid.</value> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonObjectId.#ctor(System.Byte[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonObjectId"/> class. </summary> <param name="value">The Oid value.</param> </member> <member name="T:Microsoft.Identity.Json.Bson.BsonReader"> <summary> Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. </summary> </member> <member name="P:Microsoft.Identity.Json.Bson.BsonReader.JsonNet35BinaryCompatibility"> <summary> Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. </summary> <value> <c>true</c> if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Bson.BsonReader.ReadRootValueAsArray"> <summary> Gets or sets a value indicating whether the root object will be read as a JSON array. </summary> <value> <c>true</c> if the root object will be read as a JSON array; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Bson.BsonReader.DateTimeKindHandling"> <summary> Gets or sets the <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON. </summary> <value>The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</value> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.#ctor(System.IO.Stream)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonReader"/> class. </summary> <param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonReader"/> class. </summary> <param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonReader"/> class. </summary> <param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param> <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param> <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonReader"/> class. </summary> <param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param> <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param> <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.Read"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.Stream"/>. </summary> <returns> <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read. </returns> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonReader.Close"> <summary> Changes the reader's state to <see cref="F:Microsoft.Identity.Json.JsonReader.State.Closed"/>. If <see cref="P:Microsoft.Identity.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed. </summary> </member> <member name="T:Microsoft.Identity.Json.Bson.BsonWriter"> <summary> Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. </summary> </member> <member name="P:Microsoft.Identity.Json.Bson.BsonWriter.DateTimeKindHandling"> <summary> Gets or sets the <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON. When set to <see cref="F:System.DateTimeKind.Unspecified" /> no conversion will occur. </summary> <value>The <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.</value> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.#ctor(System.IO.Stream)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonWriter"/> class. </summary> <param name="stream">The <see cref="T:System.IO.Stream"/> to write to.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.#ctor(System.IO.BinaryWriter)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Bson.BsonWriter"/> class. </summary> <param name="writer">The <see cref="T:System.IO.BinaryWriter"/> to write to.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.Flush"> <summary> Flushes whatever is in the buffer to the underlying <see cref="T:System.IO.Stream"/> and also flushes the underlying stream. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteEnd(Microsoft.Identity.Json.JsonToken)"> <summary> Writes the end. </summary> <param name="token">The token.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteComment(System.String)"> <summary> Writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteStartConstructor(System.String)"> <summary> Writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteRaw(System.String)"> <summary> Writes raw JSON. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteRawValue(System.String)"> <summary> Writes raw JSON where a value is expected and updates the writer's state. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteStartArray"> <summary> Writes the beginning of a JSON array. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteStartObject"> <summary> Writes the beginning of a JSON object. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WritePropertyName(System.String)"> <summary> Writes the property name of a name/value pair on a JSON object. </summary> <param name="name">The name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.Close"> <summary> Closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed. If <see cref="P:Microsoft.Identity.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Object)"> <summary> Writes a <see cref="T:System.Object"/> value. An error will raised if the value cannot be written as a single JSON token. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteNull"> <summary> Writes a null value. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteUndefined"> <summary> Writes an undefined value. </summary> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.String)"> <summary> Writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Int32)"> <summary> Writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.UInt32)"> <summary> Writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Int64)"> <summary> Writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.UInt64)"> <summary> Writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Single)"> <summary> Writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Double)"> <summary> Writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Boolean)"> <summary> Writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Int16)"> <summary> Writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.UInt16)"> <summary> Writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Char)"> <summary> Writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Byte)"> <summary> Writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.SByte)"> <summary> Writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Decimal)"> <summary> Writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.DateTime)"> <summary> Writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.DateTimeOffset)"> <summary> Writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Byte[])"> <summary> Writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Guid)"> <summary> Writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.TimeSpan)"> <summary> Writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteValue(System.Uri)"> <summary> Writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteObjectId(System.Byte[])"> <summary> Writes a <see cref="T:System.Byte"/>[] value that represents a BSON object id. </summary> <param name="value">The Object ID value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Bson.BsonWriter.WriteRegex(System.String,System.String)"> <summary> Writes a BSON regex. </summary> <param name="pattern">The regex pattern.</param> <param name="options">The regex options.</param> </member> <member name="T:Microsoft.Identity.Json.ConstructorHandling"> <summary> Specifies how constructors are used when initializing objects during deserialization by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.ConstructorHandling.Default"> <summary> First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. </summary> </member> <member name="F:Microsoft.Identity.Json.ConstructorHandling.AllowNonPublicDefaultConstructor"> <summary> Json.NET will use a non-public default constructor before falling back to a parameterized constructor. </summary> </member> <member name="T:Microsoft.Identity.Json.Converters.BinaryConverter"> <summary> Converts a binary value to and from a base 64 string value. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.BinaryConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.BinaryConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.BinaryConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.BsonObjectIdConverter"> <summary> Converts a <see cref="T:Microsoft.Identity.Json.Bson.BsonObjectId"/> to and from JSON and BSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.BsonObjectIdConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.BsonObjectIdConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.BsonObjectIdConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.CustomCreationConverter`1"> <summary> Creates a custom object. </summary> <typeparam name="T">The object type to convert.</typeparam> </member> <member name="M:Microsoft.Identity.Json.Converters.CustomCreationConverter`1.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.CustomCreationConverter`1.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.CustomCreationConverter`1.Create(System.Type)"> <summary> Creates an object which will then be populated by the serializer. </summary> <param name="objectType">Type of the object.</param> <returns>The created object.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.CustomCreationConverter`1.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.Converters.CustomCreationConverter`1.CanWrite"> <summary> Gets a value indicating whether this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON. </summary> <value> <c>true</c> if this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>. </value> </member> <member name="T:Microsoft.Identity.Json.Converters.DataSetConverter"> <summary> Converts a <see cref="T:System.Data.DataSet"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.DataSetConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.DataSetConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.DataSetConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified value type. </summary> <param name="valueType">Type of the value.</param> <returns> <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.DataTableConverter"> <summary> Converts a <see cref="T:System.Data.DataTable"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.DataTableConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.DataTableConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.DataTableConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified value type. </summary> <param name="valueType">Type of the value.</param> <returns> <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.DateTimeConverterBase"> <summary> Provides a base class for converting a <see cref="T:System.DateTime"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.DateTimeConverterBase.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.DiscriminatedUnionConverter"> <summary> Converts a F# discriminated union type to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.DiscriminatedUnionConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.DiscriminatedUnionConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.DiscriminatedUnionConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.EntityKeyMemberConverter"> <summary> Converts an Entity Framework <see cref="T:System.Data.EntityKeyMember"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.EntityKeyMemberConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.EntityKeyMemberConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.EntityKeyMemberConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.ExpandoObjectConverter"> <summary> Converts an <see cref="T:System.Dynamic.ExpandoObject"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.ExpandoObjectConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.ExpandoObjectConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.ExpandoObjectConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.Converters.ExpandoObjectConverter.CanWrite"> <summary> Gets a value indicating whether this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON. </summary> <value> <c>true</c> if this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>. </value> </member> <member name="T:Microsoft.Identity.Json.Converters.IsoDateTimeConverter"> <summary> Converts a <see cref="T:System.DateTime"/> to and from the ISO 8601 date format (e.g. <c>"2008-04-12T12:53Z"</c>). </summary> </member> <member name="P:Microsoft.Identity.Json.Converters.IsoDateTimeConverter.DateTimeStyles"> <summary> Gets or sets the date time styles used when converting a date to and from JSON. </summary> <value>The date time styles used when converting a date to and from JSON.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.IsoDateTimeConverter.DateTimeFormat"> <summary> Gets or sets the date time format used when converting a date to and from JSON. </summary> <value>The date time format used when converting a date to and from JSON.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.IsoDateTimeConverter.Culture"> <summary> Gets or sets the culture used when converting a date to and from JSON. </summary> <value>The culture used when converting a date to and from JSON.</value> </member> <member name="M:Microsoft.Identity.Json.Converters.IsoDateTimeConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.IsoDateTimeConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="T:Microsoft.Identity.Json.Converters.JavaScriptDateTimeConverter"> <summary> Converts a <see cref="T:System.DateTime"/> to and from a JavaScript <c>Date</c> constructor (e.g. <c>new Date(52231943)</c>). </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.JavaScriptDateTimeConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.JavaScriptDateTimeConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing property value of the JSON that is being converted.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="T:Microsoft.Identity.Json.Converters.KeyValuePairConverter"> <summary> Converts a <see cref="T:System.Collections.Generic.KeyValuePair`2"/> to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.KeyValuePairConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.KeyValuePairConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.KeyValuePairConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.RegexConverter"> <summary> Converts a <see cref="T:System.Text.RegularExpressions.Regex"/> to and from JSON and BSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.RegexConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.RegexConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.RegexConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.StringEnumConverter"> <summary> Converts an <see cref="T:System.Enum"/> to and from its name string value. </summary> </member> <member name="P:Microsoft.Identity.Json.Converters.StringEnumConverter.CamelCaseText"> <summary> Gets or sets a value indicating whether the written enum text should be camel case. The default value is <c>false</c>. </summary> <value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.StringEnumConverter.NamingStrategy"> <summary> Gets or sets the naming strategy used to resolve how enum text is written. </summary> <value>The naming strategy used to resolve how enum text is written.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.StringEnumConverter.AllowIntegerValues"> <summary> Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. The default value is <c>true</c>. </summary> <value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor(System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> <param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor(Microsoft.Identity.Json.Serialization.NamingStrategy,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> <param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param> <param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> <param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> used to write enum text.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> <param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> used to write enum text.</param> <param name="namingStrategyParameters"> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> that exactly matches the number, order, and type of these parameters. </param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Converters.StringEnumConverter"/> class. </summary> <param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> used to write enum text.</param> <param name="namingStrategyParameters"> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> that exactly matches the number, order, and type of these parameters. </param> <param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.StringEnumConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.UnixDateTimeConverter"> <summary> Converts a <see cref="T:System.DateTime"/> to and from Unix epoch time </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.UnixDateTimeConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.UnixDateTimeConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing property value of the JSON that is being converted.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="T:Microsoft.Identity.Json.Converters.VersionConverter"> <summary> Converts a <see cref="T:System.Version"/> to and from a string (e.g. <c>"1.2.3.4"</c>). </summary> </member> <member name="M:Microsoft.Identity.Json.Converters.VersionConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.VersionConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing property value of the JSON that is being converted.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.VersionConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Converters.XmlNodeConverter"> <summary> Converts XML to and from JSON. </summary> </member> <member name="P:Microsoft.Identity.Json.Converters.XmlNodeConverter.DeserializeRootElementName"> <summary> Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. </summary> <value>The name of the deserialized root element.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.XmlNodeConverter.WriteArrayAttribute"> <summary> Gets or sets a value to indicate whether to write the Json.NET array attribute. This attribute helps preserve arrays when converting the written XML back to JSON. </summary> <value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.XmlNodeConverter.OmitRootObject"> <summary> Gets or sets a value indicating whether to write the root JSON object. </summary> <value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters"> <summary> Gets or sets a value indicating whether to encode special characters when converting JSON to XML. If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify XML namespaces, attributes or processing directives. Instead special characters are encoded and written as part of the XML element name. </summary> <value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.Identity.Json.Converters.XmlNodeConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="serializer">The calling serializer.</param> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Converters.XmlNodeConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.XmlNodeConverter.IsNamespaceAttribute(System.String,System.String@)"> <summary> Checks if the <paramref name="attributeName"/> is a namespace attribute. </summary> <param name="attributeName">Attribute name to test.</param> <param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param> <returns><c>true</c> if attribute name is for a namespace attribute, otherwise <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Converters.XmlNodeConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified value type. </summary> <param name="valueType">Type of the value.</param> <returns> <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.DateFormatHandling"> <summary> Specifies how dates are formatted when writing JSON text. </summary> </member> <member name="F:Microsoft.Identity.Json.DateFormatHandling.IsoDateFormat"> <summary> Dates are written in the ISO 8601 format, e.g. <c>"2012-03-21T05:40Z"</c>. </summary> </member> <member name="F:Microsoft.Identity.Json.DateFormatHandling.MicrosoftDateFormat"> <summary> Dates are written in the Microsoft JSON format, e.g. <c>"\/Date(1198908717056)\/"</c>. </summary> </member> <member name="T:Microsoft.Identity.Json.DateParseHandling"> <summary> Specifies how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON text. </summary> </member> <member name="F:Microsoft.Identity.Json.DateParseHandling.None"> <summary> Date formatted strings are not parsed to a date type and are read as strings. </summary> </member> <member name="F:Microsoft.Identity.Json.DateParseHandling.DateTime"> <summary> Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Microsoft.Identity.Json.DateParseHandling.DateTime"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.DateParseHandling.DateTimeOffset"> <summary> Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Microsoft.Identity.Json.DateParseHandling.DateTimeOffset"/>. </summary> </member> <member name="T:Microsoft.Identity.Json.DateTimeZoneHandling"> <summary> Specifies how to treat the time value when converting between string and <see cref="T:System.DateTime"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.DateTimeZoneHandling.Local"> <summary> Treat as local time. If the <see cref="T:System.DateTime"/> object represents a Coordinated Universal Time (UTC), it is converted to the local time. </summary> </member> <member name="F:Microsoft.Identity.Json.DateTimeZoneHandling.Utc"> <summary> Treat as a UTC. If the <see cref="T:System.DateTime"/> object represents a local time, it is converted to a UTC. </summary> </member> <member name="F:Microsoft.Identity.Json.DateTimeZoneHandling.Unspecified"> <summary> Treat as a local time if a <see cref="T:System.DateTime"/> is being converted to a string. If a string is being converted to <see cref="T:System.DateTime"/>, convert to a local time if a time zone is specified. </summary> </member> <member name="F:Microsoft.Identity.Json.DateTimeZoneHandling.RoundtripKind"> <summary> Time zone information should be preserved when converting. </summary> </member> <member name="T:Microsoft.Identity.Json.DefaultJsonNameTable"> <summary> The default JSON name table implementation. </summary> </member> <member name="M:Microsoft.Identity.Json.DefaultJsonNameTable.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.DefaultJsonNameTable"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)"> <summary> Gets the string containing the same characters as the specified range of characters in the given array. </summary> <param name="key">The character array containing the name to find.</param> <param name="start">The zero-based index into the array specifying the first character of the name.</param> <param name="length">The number of characters in the name.</param> </member> <member name="M:Microsoft.Identity.Json.DefaultJsonNameTable.Add(System.String)"> <summary> Adds the specified string into name table. </summary> <param name="key">The string to add.</param> <remarks>This method is not thread-safe.</remarks> </member> <member name="T:Microsoft.Identity.Json.DefaultValueHandling"> <summary> Specifies default value handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingObject" title="DefaultValueHandling Class" /> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingExample" title="DefaultValueHandling Ignore Example" /> </example> </member> <member name="F:Microsoft.Identity.Json.DefaultValueHandling.Include"> <summary> Include members where the member value is the same as the member's default value when serializing objects. Included members are written to JSON. Has no effect when deserializing. </summary> </member> <member name="F:Microsoft.Identity.Json.DefaultValueHandling.Ignore"> <summary> Ignore members where the member value is the same as the member's default value when serializing objects so that it is not written to JSON. This option will ignore all default values (e.g. <c>null</c> for objects and nullable types; <c>0</c> for integers, decimals and floating point numbers; and <c>false</c> for booleans). The default value ignored can be changed by placing the <see cref="T:System.ComponentModel.DefaultValueAttribute"/> on the property. </summary> </member> <member name="F:Microsoft.Identity.Json.DefaultValueHandling.Populate"> <summary> Members with a default value but no JSON will be set to their default value when deserializing. </summary> </member> <member name="F:Microsoft.Identity.Json.DefaultValueHandling.IgnoreAndPopulate"> <summary> Ignore members where the member value is the same as the member's default value when serializing objects and set members to their default value when deserializing. </summary> </member> <member name="T:Microsoft.Identity.Json.FloatFormatHandling"> <summary> Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/> with <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.FloatFormatHandling.String"> <summary> Write special floating point values as strings in JSON, e.g. <c>"NaN"</c>, <c>"Infinity"</c>, <c>"-Infinity"</c>. </summary> </member> <member name="F:Microsoft.Identity.Json.FloatFormatHandling.Symbol"> <summary> Write special floating point values as symbols in JSON, e.g. <c>NaN</c>, <c>Infinity</c>, <c>-Infinity</c>. Note that this will produce non-valid JSON. </summary> </member> <member name="F:Microsoft.Identity.Json.FloatFormatHandling.DefaultValue"> <summary> Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="T:System.Double"/> property, <c>null</c> for a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> property. </summary> </member> <member name="T:Microsoft.Identity.Json.FloatParseHandling"> <summary> Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary> </member> <member name="F:Microsoft.Identity.Json.FloatParseHandling.Double"> <summary> Floating point numbers are parsed to <see cref="F:Microsoft.Identity.Json.FloatParseHandling.Double"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.FloatParseHandling.Decimal"> <summary> Floating point numbers are parsed to <see cref="F:Microsoft.Identity.Json.FloatParseHandling.Decimal"/>. </summary> </member> <member name="T:Microsoft.Identity.Json.Formatting"> <summary> Specifies formatting options for the <see cref="T:Microsoft.Identity.Json.JsonTextWriter"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.Formatting.None"> <summary> No special formatting is applied. This is the default. </summary> </member> <member name="F:Microsoft.Identity.Json.Formatting.Indented"> <summary> Causes child objects to be indented according to the <see cref="P:Microsoft.Identity.Json.JsonTextWriter.Indentation"/> and <see cref="P:Microsoft.Identity.Json.JsonTextWriter.IndentChar"/> settings. </summary> </member> <member name="T:Microsoft.Identity.Json.IArrayPool`1"> <summary> Provides an interface for using pooled arrays. </summary> <typeparam name="T">The array type content.</typeparam> </member> <member name="M:Microsoft.Identity.Json.IArrayPool`1.Rent(System.Int32)"> <summary> Rent an array from the pool. This array must be returned when it is no longer needed. </summary> <param name="minimumLength">The minimum required length of the array. The returned array may be longer.</param> <returns>The rented array from the pool. This array must be returned when it is no longer needed.</returns> </member> <member name="M:Microsoft.Identity.Json.IArrayPool`1.Return(`0[])"> <summary> Return an array to the pool. </summary> <param name="array">The array that is being returned.</param> </member> <member name="T:Microsoft.Identity.Json.IJsonLineInfo"> <summary> Provides an interface to enable a class to return line and position information. </summary> </member> <member name="M:Microsoft.Identity.Json.IJsonLineInfo.HasLineInfo"> <summary> Gets a value indicating whether the class can return line information. </summary> <returns> <c>true</c> if <see cref="P:Microsoft.Identity.Json.IJsonLineInfo.LineNumber"/> and <see cref="P:Microsoft.Identity.Json.IJsonLineInfo.LinePosition"/> can be provided; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.IJsonLineInfo.LineNumber"> <summary> Gets the current line number. </summary> <value>The current line number or 0 if no line information is available (for example, when <see cref="M:Microsoft.Identity.Json.IJsonLineInfo.HasLineInfo"/> returns <c>false</c>).</value> </member> <member name="P:Microsoft.Identity.Json.IJsonLineInfo.LinePosition"> <summary> Gets the current line position. </summary> <value>The current line position or 0 if no line information is available (for example, when <see cref="M:Microsoft.Identity.Json.IJsonLineInfo.HasLineInfo"/> returns <c>false</c>).</value> </member> <member name="T:Microsoft.Identity.Json.JsonArrayAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> how to serialize the collection. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonArrayAttribute.AllowNullItems"> <summary> Gets or sets a value indicating whether null items are allowed in the collection. </summary> <value><c>true</c> if null items are allowed in the collection; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.Identity.Json.JsonArrayAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonArrayAttribute"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonArrayAttribute.#ctor(System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonObjectAttribute"/> class with a flag indicating whether the array can contain null items. </summary> <param name="allowNullItems">A flag indicating whether the array can contain null items.</param> </member> <member name="M:Microsoft.Identity.Json.JsonArrayAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonArrayAttribute"/> class with the specified container Id. </summary> <param name="id">The container Id.</param> </member> <member name="T:Microsoft.Identity.Json.JsonConstructorAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to use the specified constructor when deserializing that object. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonContainerAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> how to serialize the object. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.Id"> <summary> Gets or sets the id. </summary> <value>The id.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.Title"> <summary> Gets or sets the title. </summary> <value>The title.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.Description"> <summary> Gets or sets the description. </summary> <value>The description.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemConverterType"> <summary> Gets or sets the collection's items converter. </summary> <value>The collection's items converter.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemConverterParameters"> <summary> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> described by <see cref="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemConverterType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> that exactly matches the number, order, and type of these parameters. </summary> <example> <code> [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] </code> </example> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.NamingStrategyType"> <summary> Gets or sets the <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/>. </summary> <value>The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/>.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.NamingStrategyParameters"> <summary> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> described by <see cref="P:Microsoft.Identity.Json.JsonContainerAttribute.NamingStrategyType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> that exactly matches the number, order, and type of these parameters. </summary> <example> <code> [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] </code> </example> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.IsReference"> <summary> Gets or sets a value that indicates whether to preserve object references. </summary> <value> <c>true</c> to keep object reference; otherwise, <c>false</c>. The default is <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemIsReference"> <summary> Gets or sets a value that indicates whether to preserve collection's items references. </summary> <value> <c>true</c> to keep collection's items object references; otherwise, <c>false</c>. The default is <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemReferenceLoopHandling"> <summary> Gets or sets the reference loop handling used when serializing the collection's items. </summary> <value>The reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonContainerAttribute.ItemTypeNameHandling"> <summary> Gets or sets the type name handling used when serializing the collection's items. </summary> <value>The type name handling.</value> </member> <member name="M:Microsoft.Identity.Json.JsonContainerAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonContainerAttribute"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonContainerAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonContainerAttribute"/> class with the specified container Id. </summary> <param name="id">The container Id.</param> </member> <member name="T:Microsoft.Identity.Json.JsonConvert"> <summary> Provides methods for converting between .NET types and JSON types. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" /> </example> </member> <member name="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"> <summary> Gets or sets a function that creates default <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. Default settings are automatically used by serialization methods on <see cref="T:Microsoft.Identity.Json.JsonConvert"/>, and <see cref="M:Microsoft.Identity.Json.Linq.JToken.ToObject``1"/> and <see cref="M:Microsoft.Identity.Json.Linq.JToken.FromObject(System.Object)"/> on <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. To serialize without using any default settings create a <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> with <see cref="M:Microsoft.Identity.Json.JsonSerializer.Create"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.True"> <summary> Represents JavaScript's boolean value <c>true</c> as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.False"> <summary> Represents JavaScript's boolean value <c>false</c> as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.Null"> <summary> Represents JavaScript's <c>null</c> as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.Undefined"> <summary> Represents JavaScript's <c>undefined</c> as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.PositiveInfinity"> <summary> Represents JavaScript's positive infinity as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.NegativeInfinity"> <summary> Represents JavaScript's negative infinity as a string. This field is read-only. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonConvert.NaN"> <summary> Represents JavaScript's <c>NaN</c> as a string. This field is read-only. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.DateTime)"> <summary> Converts the <see cref="T:System.DateTime"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.DateTime,Microsoft.Identity.Json.DateFormatHandling,Microsoft.Identity.Json.DateTimeZoneHandling)"> <summary> Converts the <see cref="T:System.DateTime"/> to its JSON string representation using the <see cref="T:Microsoft.Identity.Json.DateFormatHandling"/> specified. </summary> <param name="value">The value to convert.</param> <param name="format">The format the date will be converted to.</param> <param name="timeZoneHandling">The time zone handling when the date is converted to a string.</param> <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.DateTimeOffset)"> <summary> Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.DateTimeOffset,Microsoft.Identity.Json.DateFormatHandling)"> <summary> Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation using the <see cref="T:Microsoft.Identity.Json.DateFormatHandling"/> specified. </summary> <param name="value">The value to convert.</param> <param name="format">The format the date will be converted to.</param> <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Boolean)"> <summary> Converts the <see cref="T:System.Boolean"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Boolean"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Char)"> <summary> Converts the <see cref="T:System.Char"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Char"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Enum)"> <summary> Converts the <see cref="T:System.Enum"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Enum"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Int32)"> <summary> Converts the <see cref="T:System.Int32"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Int32"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Int16)"> <summary> Converts the <see cref="T:System.Int16"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Int16"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.UInt16)"> <summary> Converts the <see cref="T:System.UInt16"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.UInt16"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.UInt32)"> <summary> Converts the <see cref="T:System.UInt32"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.UInt32"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Int64)"> <summary> Converts the <see cref="T:System.Int64"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Int64"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.UInt64)"> <summary> Converts the <see cref="T:System.UInt64"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.UInt64"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Single)"> <summary> Converts the <see cref="T:System.Single"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Single"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Double)"> <summary> Converts the <see cref="T:System.Double"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Double"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Byte)"> <summary> Converts the <see cref="T:System.Byte"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Byte"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.SByte)"> <summary> Converts the <see cref="T:System.SByte"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Decimal)"> <summary> Converts the <see cref="T:System.Decimal"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Guid)"> <summary> Converts the <see cref="T:System.Guid"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Guid"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.TimeSpan)"> <summary> Converts the <see cref="T:System.TimeSpan"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.TimeSpan"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Uri)"> <summary> Converts the <see cref="T:System.Uri"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Uri"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.String)"> <summary> Converts the <see cref="T:System.String"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.String,System.Char)"> <summary> Converts the <see cref="T:System.String"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <param name="delimiter">The string delimiter character.</param> <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.String,System.Char,Microsoft.Identity.Json.StringEscapeHandling)"> <summary> Converts the <see cref="T:System.String"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <param name="delimiter">The string delimiter character.</param> <param name="stringEscapeHandling">The string escape handling.</param> <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.ToString(System.Object)"> <summary> Converts the <see cref="T:System.Object"/> to its JSON string representation. </summary> <param name="value">The value to convert.</param> <returns>A JSON string representation of the <see cref="T:System.Object"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object)"> <summary> Serializes the specified object to a JSON string. </summary> <param name="value">The object to serialize.</param> <returns>A JSON string representation of the object.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,Microsoft.Identity.Json.Formatting)"> <summary> Serializes the specified object to a JSON string using formatting. </summary> <param name="value">The object to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <returns> A JSON string representation of the object. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,Microsoft.Identity.Json.JsonConverter[])"> <summary> Serializes the specified object to a JSON string using a collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> <param name="value">The object to serialize.</param> <param name="converters">A collection of converters used while serializing.</param> <returns>A JSON string representation of the object.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,Microsoft.Identity.Json.Formatting,Microsoft.Identity.Json.JsonConverter[])"> <summary> Serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> <param name="value">The object to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <param name="converters">A collection of converters used while serializing.</param> <returns>A JSON string representation of the object.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Serializes the specified object to a JSON string using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The object to serialize.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to serialize the object. If this is <c>null</c>, default serialization settings will be used.</param> <returns> A JSON string representation of the object. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,System.Type,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The object to serialize.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to serialize the object. If this is <c>null</c>, default serialization settings will be used.</param> <param name="type"> The type of the value being serialized. This parameter is used when <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Microsoft.Identity.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match. Specifying the type is optional. </param> <returns> A JSON string representation of the object. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,Microsoft.Identity.Json.Formatting,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Serializes the specified object to a JSON string using formatting and <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The object to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to serialize the object. If this is <c>null</c>, default serialization settings will be used.</param> <returns> A JSON string representation of the object. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,System.Type,Microsoft.Identity.Json.Formatting,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The object to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to serialize the object. If this is <c>null</c>, default serialization settings will be used.</param> <param name="type"> The type of the value being serialized. This parameter is used when <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Microsoft.Identity.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match. Specifying the type is optional. </param> <returns> A JSON string representation of the object. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject(System.String)"> <summary> Deserializes the JSON to a .NET object. </summary> <param name="value">The JSON to deserialize.</param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject(System.String,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Deserializes the JSON to a .NET object using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The JSON to deserialize.</param> <param name="settings"> The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to deserialize the object. If this is <c>null</c>, default serialization settings will be used. </param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject(System.String,System.Type)"> <summary> Deserializes the JSON to the specified .NET type. </summary> <param name="value">The JSON to deserialize.</param> <param name="type">The <see cref="T:System.Type"/> of object being deserialized.</param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject``1(System.String)"> <summary> Deserializes the JSON to the specified .NET type. </summary> <typeparam name="T">The type of the object to deserialize to.</typeparam> <param name="value">The JSON to deserialize.</param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0)"> <summary> Deserializes the JSON to the given anonymous type. </summary> <typeparam name="T"> The anonymous type to deserialize to. This can't be specified traditionally and must be inferred from the anonymous type passed as a parameter. </typeparam> <param name="value">The JSON to deserialize.</param> <param name="anonymousTypeObject">The anonymous type object.</param> <returns>The deserialized anonymous type from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Deserializes the JSON to the given anonymous type using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <typeparam name="T"> The anonymous type to deserialize to. This can't be specified traditionally and must be inferred from the anonymous type passed as a parameter. </typeparam> <param name="value">The JSON to deserialize.</param> <param name="anonymousTypeObject">The anonymous type object.</param> <param name="settings"> The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to deserialize the object. If this is <c>null</c>, default serialization settings will be used. </param> <returns>The deserialized anonymous type from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject``1(System.String,Microsoft.Identity.Json.JsonConverter[])"> <summary> Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> <typeparam name="T">The type of the object to deserialize to.</typeparam> <param name="value">The JSON to deserialize.</param> <param name="converters">Converters to use while deserializing.</param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject``1(System.String,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Deserializes the JSON to the specified .NET type using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <typeparam name="T">The type of the object to deserialize to.</typeparam> <param name="value">The object to deserialize.</param> <param name="settings"> The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to deserialize the object. If this is <c>null</c>, default serialization settings will be used. </param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject(System.String,System.Type,Microsoft.Identity.Json.JsonConverter[])"> <summary> Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> <param name="value">The JSON to deserialize.</param> <param name="type">The type of the object to deserialize.</param> <param name="converters">Converters to use while deserializing.</param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeObject(System.String,System.Type,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Deserializes the JSON to the specified .NET type using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The JSON to deserialize.</param> <param name="type">The type of the object to deserialize to.</param> <param name="settings"> The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to deserialize the object. If this is <c>null</c>, default serialization settings will be used. </param> <returns>The deserialized object from the JSON string.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.PopulateObject(System.String,System.Object)"> <summary> Populates the object with values from the JSON string. </summary> <param name="value">The JSON to populate values from.</param> <param name="target">The target object to populate values onto.</param> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.PopulateObject(System.String,System.Object,Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Populates the object with values from the JSON string using <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="value">The JSON to populate values from.</param> <param name="target">The target object to populate values onto.</param> <param name="settings"> The <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> used to deserialize the object. If this is <c>null</c>, default serialization settings will be used. </param> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)"> <summary> Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string. </summary> <param name="node">The node to serialize.</param> <returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Microsoft.Identity.Json.Formatting)"> <summary> Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting. </summary> <param name="node">The node to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Microsoft.Identity.Json.Formatting,System.Boolean)"> <summary> Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>. </summary> <param name="node">The node to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <param name="omitRootObject">Omits writing the root object.</param> <returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXmlNode(System.String)"> <summary> Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string. </summary> <param name="value">The JSON string.</param> <returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)"> <summary> Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)"> <summary> Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/> and writes a Json.NET array attribute for collections. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <param name="writeArrayAttribute"> A value to indicate whether to write the Json.NET array attribute. This attribute helps preserve arrays when converting the written XML back to JSON. </param> <returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)"> <summary> Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>, writes a Json.NET array attribute for collections, and encodes special characters. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <param name="writeArrayAttribute"> A value to indicate whether to write the Json.NET array attribute. This attribute helps preserve arrays when converting the written XML back to JSON. </param> <param name="encodeSpecialCharacters"> A value to indicate whether to encode special characters when converting JSON to XML. If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify XML namespaces, attributes or processing directives. Instead special characters are encoded and written as part of the XML element name. </param> <returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)"> <summary> Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string. </summary> <param name="node">The node to convert to JSON.</param> <returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Microsoft.Identity.Json.Formatting)"> <summary> Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting. </summary> <param name="node">The node to convert to JSON.</param> <param name="formatting">Indicates how the output should be formatted.</param> <returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Microsoft.Identity.Json.Formatting,System.Boolean)"> <summary> Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>. </summary> <param name="node">The node to serialize.</param> <param name="formatting">Indicates how the output should be formatted.</param> <param name="omitRootObject">Omits writing the root object.</param> <returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXNode(System.String)"> <summary> Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string. </summary> <param name="value">The JSON string.</param> <returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXNode(System.String,System.String)"> <summary> Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean)"> <summary> Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/> and writes a Json.NET array attribute for collections. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <param name="writeArrayAttribute"> A value to indicate whether to write the Json.NET array attribute. This attribute helps preserve arrays when converting the written XML back to JSON. </param> <returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)"> <summary> Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>, writes a Json.NET array attribute for collections, and encodes special characters. </summary> <param name="value">The JSON string.</param> <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> <param name="writeArrayAttribute"> A value to indicate whether to write the Json.NET array attribute. This attribute helps preserve arrays when converting the written XML back to JSON. </param> <param name="encodeSpecialCharacters"> A value to indicate whether to encode special characters when converting JSON to XML. If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify XML namespaces, attributes or processing directives. Instead special characters are encoded and written as part of the XML element name. </param> <returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns> </member> <member name="T:Microsoft.Identity.Json.JsonConverter"> <summary> Converts an object to and from JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonConverter.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.JsonConverter.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.JsonConverter.CanRead"> <summary> Gets a value indicating whether this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can read JSON. </summary> <value><c>true</c> if this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can read JSON; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.JsonConverter.CanWrite"> <summary> Gets a value indicating whether this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON. </summary> <value><c>true</c> if this <see cref="T:Microsoft.Identity.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.</value> </member> <member name="T:Microsoft.Identity.Json.JsonConverter`1"> <summary> Converts an object to and from JSON. </summary> <typeparam name="T">The object type to convert.</typeparam> </member> <member name="M:Microsoft.Identity.Json.JsonConverter`1.WriteJson(Microsoft.Identity.Json.JsonWriter,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.JsonConverter`1.WriteJson(Microsoft.Identity.Json.JsonWriter,`0,Microsoft.Identity.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:Microsoft.Identity.Json.JsonConverter`1.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConverter`1.ReadJson(Microsoft.Identity.Json.JsonReader,System.Type,`0,System.Boolean,Microsoft.Identity.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read. If there is no existing value then <c>null</c> will be used.</param> <param name="hasExistingValue">The existing value has a value.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonConverter`1.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.JsonConverterAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to use the specified <see cref="T:Microsoft.Identity.Json.JsonConverter"/> when serializing the member or class. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonConverterAttribute.ConverterType"> <summary> Gets the <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> <value>The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.JsonConverter"/>.</value> </member> <member name="P:Microsoft.Identity.Json.JsonConverterAttribute.ConverterParameters"> <summary> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> described by <see cref="P:Microsoft.Identity.Json.JsonConverterAttribute.ConverterType"/>. If <c>null</c>, the default constructor is used. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonConverterAttribute.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonConverterAttribute"/> class. </summary> <param name="converterType">Type of the <see cref="T:Microsoft.Identity.Json.JsonConverter"/>.</param> </member> <member name="M:Microsoft.Identity.Json.JsonConverterAttribute.#ctor(System.Type,System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonConverterAttribute"/> class. </summary> <param name="converterType">Type of the <see cref="T:Microsoft.Identity.Json.JsonConverter"/>.</param> <param name="converterParameters">Parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. Can be <c>null</c>.</param> </member> <member name="T:Microsoft.Identity.Json.JsonConverterCollection"> <summary> Represents a collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonDictionaryAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> how to serialize the collection. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonDictionaryAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonDictionaryAttribute"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonDictionaryAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonDictionaryAttribute"/> class with the specified container Id. </summary> <param name="id">The container Id.</param> </member> <member name="T:Microsoft.Identity.Json.JsonException"> <summary> The exception thrown when an error occurs during JSON serialization or deserialization. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonException"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Json.JsonException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="M:Microsoft.Identity.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonException"/> class. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> </member> <member name="T:Microsoft.Identity.Json.JsonExtensionDataAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to deserialize properties with no matching class member into the specified collection and write values during serialization. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonExtensionDataAttribute.WriteData"> <summary> Gets or sets a value that indicates whether to write extension data when serializing the object. </summary> <value> <c>true</c> to write extension data when serializing the object; otherwise, <c>false</c>. The default is <c>true</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonExtensionDataAttribute.ReadData"> <summary> Gets or sets a value that indicates whether to read extension data when deserializing the object. </summary> <value> <c>true</c> to read extension data when deserializing the object; otherwise, <c>false</c>. The default is <c>true</c>. </value> </member> <member name="M:Microsoft.Identity.Json.JsonExtensionDataAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonExtensionDataAttribute"/> class. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonIgnoreAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> not to serialize the public field or public read/write property value. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonNameTable"> <summary> Base class for a table of atomized string objects. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)"> <summary> Gets the string containing the same characters as the specified range of characters in the given array. </summary> <param name="key">The character array containing the name to find.</param> <param name="start">The zero-based index into the array specifying the first character of the name.</param> <param name="length">The number of characters in the name.</param> </member> <member name="T:Microsoft.Identity.Json.JsonObjectAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> how to serialize the object. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonObjectAttribute.MemberSerialization"> <summary> Gets or sets the member serialization. </summary> <value>The member serialization.</value> </member> <member name="P:Microsoft.Identity.Json.JsonObjectAttribute.ItemNullValueHandling"> <summary> Gets or sets how the object's properties with null values are handled during serialization and deserialization. </summary> <value>How the object's properties with null values are handled during serialization and deserialization.</value> </member> <member name="P:Microsoft.Identity.Json.JsonObjectAttribute.ItemRequired"> <summary> Gets or sets a value that indicates whether the object's properties are required. </summary> <value> A value indicating whether the object's properties are required. </value> </member> <member name="M:Microsoft.Identity.Json.JsonObjectAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonObjectAttribute"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonObjectAttribute.#ctor(Microsoft.Identity.Json.MemberSerialization)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonObjectAttribute"/> class with the specified member serialization. </summary> <param name="memberSerialization">The member serialization.</param> </member> <member name="M:Microsoft.Identity.Json.JsonObjectAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonObjectAttribute"/> class with the specified container Id. </summary> <param name="id">The container Id.</param> </member> <member name="T:Microsoft.Identity.Json.JsonPropertyAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to always serialize the member with the specified name. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemConverterType"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> type used when serializing the property's collection items. </summary> <value>The collection's items <see cref="T:Microsoft.Identity.Json.JsonConverter"/> type.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemConverterParameters"> <summary> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> described by <see cref="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemConverterType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> that exactly matches the number, order, and type of these parameters. </summary> <example> <code> [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] </code> </example> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.NamingStrategyType"> <summary> Gets or sets the <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/>. </summary> <value>The <see cref="T:System.Type"/> of the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/>.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.NamingStrategyParameters"> <summary> The parameter list to use when constructing the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> described by <see cref="P:Microsoft.Identity.Json.JsonPropertyAttribute.NamingStrategyType"/>. If <c>null</c>, the default constructor is used. When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Microsoft.Identity.Json.Serialization.NamingStrategy"/> that exactly matches the number, order, and type of these parameters. </summary> <example> <code> [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] </code> </example> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.NullValueHandling"> <summary> Gets or sets the null value handling used when serializing this property. </summary> <value>The null value handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.DefaultValueHandling"> <summary> Gets or sets the default value handling used when serializing this property. </summary> <value>The default value handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ReferenceLoopHandling"> <summary> Gets or sets the reference loop handling used when serializing this property. </summary> <value>The reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ObjectCreationHandling"> <summary> Gets or sets the object creation handling used when deserializing this property. </summary> <value>The object creation handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.TypeNameHandling"> <summary> Gets or sets the type name handling used when serializing this property. </summary> <value>The type name handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.IsReference"> <summary> Gets or sets whether this property's value is serialized as a reference. </summary> <value>Whether this property's value is serialized as a reference.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.Order"> <summary> Gets or sets the order of serialization of a member. </summary> <value>The numeric order of serialization.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.Required"> <summary> Gets or sets a value indicating whether this property is required. </summary> <value> A value indicating whether this property is required. </value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.PropertyName"> <summary> Gets or sets the name of the property. </summary> <value>The name of the property.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemReferenceLoopHandling"> <summary> Gets or sets the reference loop handling used when serializing the property's collection items. </summary> <value>The collection's items reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemTypeNameHandling"> <summary> Gets or sets the type name handling used when serializing the property's collection items. </summary> <value>The collection's items type name handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonPropertyAttribute.ItemIsReference"> <summary> Gets or sets whether this property's collection items are serialized as a reference. </summary> <value>Whether this property's collection items are serialized as a reference.</value> </member> <member name="M:Microsoft.Identity.Json.JsonPropertyAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonPropertyAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/> class with the specified name. </summary> <param name="propertyName">Name of the property.</param> </member> <member name="T:Microsoft.Identity.Json.JsonReader"> <summary> Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.SkipAsync(System.Threading.CancellationToken)"> <summary> Asynchronously skips the children of the current token. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsBooleanAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsBytesAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Byte"/>[]. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Byte"/>[]. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDecimalAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDoubleAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsInt32Async(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsStringAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.String"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.String"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="T:Microsoft.Identity.Json.JsonReader.State"> <summary> Specifies the state of the reader. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Start"> <summary> A <see cref="T:Microsoft.Identity.Json.JsonReader"/> read method has not been called. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Complete"> <summary> The end of the file has been reached successfully. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Property"> <summary> Reader is at a property. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.ObjectStart"> <summary> Reader is at the start of an object. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Object"> <summary> Reader is in an object. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.ArrayStart"> <summary> Reader is at the start of an array. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Array"> <summary> Reader is in an array. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Closed"> <summary> The <see cref="M:Microsoft.Identity.Json.JsonReader.Close"/> method has been called. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.PostValue"> <summary> Reader has just read a value. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.ConstructorStart"> <summary> Reader is at the start of a constructor. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Constructor"> <summary> Reader is in a constructor. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Error"> <summary> An error occurred that prevents the read operation from continuing. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonReader.State.Finished"> <summary> The end of the file has been reached successfully. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.CurrentState"> <summary> Gets the current reader state. </summary> <value>The current reader state.</value> </member> <member name="P:Microsoft.Identity.Json.JsonReader.CloseInput"> <summary> Gets or sets a value indicating whether the source should be closed when this reader is closed. </summary> <value> <c>true</c> to close the source when this reader is closed; otherwise <c>false</c>. The default is <c>true</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonReader.SupportMultipleContent"> <summary> Gets or sets a value indicating whether multiple pieces of JSON content can be read from a continuous stream without erroring. </summary> <value> <c>true</c> to support reading multiple pieces of JSON content; otherwise <c>false</c>. The default is <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonReader.QuoteChar"> <summary> Gets the quotation mark character used to enclose the value of a string. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.DateTimeZoneHandling"> <summary> Gets or sets how <see cref="T:System.DateTime"/> time zones are handled when reading JSON. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.DateParseHandling"> <summary> Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.FloatParseHandling"> <summary> Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.DateFormatString"> <summary> Gets or sets how custom date formatted strings are parsed when reading JSON. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.MaxDepth"> <summary> Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Microsoft.Identity.Json.JsonReaderException"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.TokenType"> <summary> Gets the type of the current JSON token. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.Value"> <summary> Gets the text value of the current JSON token. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.ValueType"> <summary> Gets the .NET type for the current JSON token. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.Depth"> <summary> Gets the depth of the current token in the JSON document. </summary> <value>The depth of the current token in the JSON document.</value> </member> <member name="P:Microsoft.Identity.Json.JsonReader.Path"> <summary> Gets the path of the current JSON token. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReader.Culture"> <summary> Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReader.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReader"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReader.Read"> <summary> Reads the next JSON token from the source. </summary> <returns><c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsInt32"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsString"> <summary> Reads the next JSON token from the source as a <see cref="T:System.String"/>. </summary> <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsBytes"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Byte"/>[]. </summary> <returns>A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDouble"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsBoolean"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDecimal"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDateTime"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.ReadAsDateTimeOffset"> <summary> Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonReader.Skip"> <summary> Skips the children of the current token. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReader.SetToken(Microsoft.Identity.Json.JsonToken)"> <summary> Sets the current token. </summary> <param name="newToken">The new token.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReader.SetToken(Microsoft.Identity.Json.JsonToken,System.Object)"> <summary> Sets the current token and value. </summary> <param name="newToken">The new token.</param> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReader.SetToken(Microsoft.Identity.Json.JsonToken,System.Object,System.Boolean)"> <summary> Sets the current token and value. </summary> <param name="newToken">The new token.</param> <param name="value">The value.</param> <param name="updateIndex">A flag indicating whether the position index inside an array should be updated.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReader.SetStateBasedOnCurrent"> <summary> Sets the state based on current token type. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReader.Dispose(System.Boolean)"> <summary> Releases unmanaged and - optionally - managed resources. </summary> <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReader.Close"> <summary> Changes the reader's state to <see cref="F:Microsoft.Identity.Json.JsonReader.State.Closed"/>. If <see cref="P:Microsoft.Identity.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the source is also closed. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonReaderException"> <summary> The exception thrown when an error occurs while reading JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonReaderException.LineNumber"> <summary> Gets the line number indicating where the error occurred. </summary> <value>The line number indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.JsonReaderException.LinePosition"> <summary> Gets the line position indicating where the error occurred. </summary> <value>The line position indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.JsonReaderException.Path"> <summary> Gets the path to the JSON where the error occurred. </summary> <value>The path to the JSON where the error occurred.</value> </member> <member name="M:Microsoft.Identity.Json.JsonReaderException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReaderException"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonReaderException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReaderException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReaderException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReaderException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="M:Microsoft.Identity.Json.JsonReaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReaderException"/> class. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> </member> <member name="M:Microsoft.Identity.Json.JsonReaderException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonReaderException"/> class with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="path">The path to the JSON where the error occurred.</param> <param name="lineNumber">The line number indicating where the error occurred.</param> <param name="linePosition">The line position indicating where the error occurred.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="T:Microsoft.Identity.Json.JsonRequiredAttribute"> <summary> Instructs the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to always serialize the member, and to require that the member has a value. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonSerializationException"> <summary> The exception thrown when an error occurs during JSON serialization or deserialization. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializationException.LineNumber"> <summary> Gets the line number indicating where the error occurred. </summary> <value>The line number indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializationException.LinePosition"> <summary> Gets the line position indicating where the error occurred. </summary> <value>The line position indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializationException.Path"> <summary> Gets the path to the JSON where the error occurred. </summary> <value>The path to the JSON where the error occurred.</value> </member> <member name="M:Microsoft.Identity.Json.JsonSerializationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonSerializationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> class. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> </member> <member name="M:Microsoft.Identity.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> class with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="path">The path to the JSON where the error occurred.</param> <param name="lineNumber">The line number indicating where the error occurred.</param> <param name="linePosition">The line position indicating where the error occurred.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="T:Microsoft.Identity.Json.JsonSerializer"> <summary> Serializes and deserializes objects into and from the JSON format. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> enables you to control how objects are encoded into JSON. </summary> </member> <member name="E:Microsoft.Identity.Json.JsonSerializer.Error"> <summary> Occurs when the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> errors during serialization and deserialization. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.ReferenceResolver"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.SerializationBinder"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.ISerializationBinder"/> used by the serializer when resolving type names. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.TraceWriter"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages. </summary> <value>The trace writer.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.EqualityComparer"> <summary> Gets or sets the equality comparer used by the serializer when comparing references. </summary> <value>The equality comparer.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"> <summary> Gets or sets how type name writing and reading is handled by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.TypeNameHandling.None" />. </summary> <remarks> <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. Incoming types should be validated with a custom <see cref="P:Microsoft.Identity.Json.JsonSerializer.SerializationBinder"/> when deserializing with a value other than <see cref="F:Microsoft.Identity.Json.TypeNameHandling.None"/>. </remarks> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.TypeNameAssemblyFormat"> <summary> Gets or sets how a type name assembly is written and resolved by the serializer. The default value is <see cref="F:System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple" />. </summary> <value>The type name assembly format.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.TypeNameAssemblyFormatHandling"> <summary> Gets or sets how a type name assembly is written and resolved by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.TypeNameAssemblyFormatHandling.Simple" />. </summary> <value>The type name assembly format.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.PreserveReferencesHandling"> <summary> Gets or sets how object references are preserved by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.PreserveReferencesHandling.None" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.ReferenceLoopHandling"> <summary> Gets or sets how reference loops (e.g. a class referencing itself) is handled. The default value is <see cref="F:Microsoft.Identity.Json.ReferenceLoopHandling.Error" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.MissingMemberHandling"> <summary> Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.MissingMemberHandling.Ignore" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.NullValueHandling"> <summary> Gets or sets how null values are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.NullValueHandling.Include" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.DefaultValueHandling"> <summary> Gets or sets how default values are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.DefaultValueHandling.Include" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.ObjectCreationHandling"> <summary> Gets or sets how objects are created during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.ObjectCreationHandling.Auto" />. </summary> <value>The object creation handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.ConstructorHandling"> <summary> Gets or sets how constructors are used during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.ConstructorHandling.Default" />. </summary> <value>The constructor handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.MetadataPropertyHandling"> <summary> Gets or sets how metadata properties are used during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.MetadataPropertyHandling.Default" />. </summary> <value>The metadata properties handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.Converters"> <summary> Gets a collection <see cref="T:Microsoft.Identity.Json.JsonConverter"/> that will be used during serialization. </summary> <value>Collection <see cref="T:Microsoft.Identity.Json.JsonConverter"/> that will be used during serialization.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.ContractResolver"> <summary> Gets or sets the contract resolver used by the serializer when serializing .NET objects to JSON and vice versa. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.Context"> <summary> Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods. </summary> <value>The context.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.Formatting"> <summary> Indicates how JSON text output is formatted. The default value is <see cref="F:Microsoft.Identity.Json.Formatting.None" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.DateFormatHandling"> <summary> Gets or sets how dates are written to JSON text. The default value is <see cref="F:Microsoft.Identity.Json.DateFormatHandling.IsoDateFormat" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.DateTimeZoneHandling"> <summary> Gets or sets how <see cref="T:System.DateTime"/> time zones are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.DateTimeZoneHandling.RoundtripKind" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.DateParseHandling"> <summary> Gets or sets how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON. The default value is <see cref="F:Microsoft.Identity.Json.DateParseHandling.DateTime" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.FloatParseHandling"> <summary> Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. The default value is <see cref="F:Microsoft.Identity.Json.FloatParseHandling.Double" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.FloatFormatHandling"> <summary> Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, are written as JSON text. The default value is <see cref="F:Microsoft.Identity.Json.FloatFormatHandling.String" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.StringEscapeHandling"> <summary> Gets or sets how strings are escaped when writing JSON text. The default value is <see cref="F:Microsoft.Identity.Json.StringEscapeHandling.Default" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.DateFormatString"> <summary> Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text, and the expected date format when reading JSON text. The default value is <c>"yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.Culture"> <summary> Gets or sets the culture used when reading JSON. The default value is <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.MaxDepth"> <summary> Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Microsoft.Identity.Json.JsonReaderException"/>. A null value means there is no maximum. The default value is <c>null</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializer.CheckAdditionalContent"> <summary> Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. The default value is <c>false</c>. </summary> <value> <c>true</c> if there will be a check for additional JSON content after deserializing an object; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Create"> <summary> Creates a new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will not use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </summary> <returns> A new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will not use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Create(Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Creates a new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will not use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </summary> <param name="settings">The settings to be applied to the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>.</param> <returns> A new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will not use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.CreateDefault"> <summary> Creates a new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </summary> <returns> A new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/>. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.CreateDefault(Microsoft.Identity.Json.JsonSerializerSettings)"> <summary> Creates a new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/> as well as the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </summary> <param name="settings">The settings to be applied to the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>.</param> <returns> A new <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> instance using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> will use default settings from <see cref="P:Microsoft.Identity.Json.JsonConvert.DefaultSettings"/> as well as the specified <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/>. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Populate(System.IO.TextReader,System.Object)"> <summary> Populates the JSON values onto the target object. </summary> <param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param> <param name="target">The target object to populate values onto.</param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Populate(Microsoft.Identity.Json.JsonReader,System.Object)"> <summary> Populates the JSON values onto the target object. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> that contains the JSON structure to read values from.</param> <param name="target">The target object to populate values onto.</param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Deserialize(Microsoft.Identity.Json.JsonReader)"> <summary> Deserializes the JSON structure contained by the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> that contains the JSON structure to deserialize.</param> <returns>The <see cref="T:System.Object"/> being deserialized.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)"> <summary> Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/> into an instance of the specified type. </summary> <param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param> <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param> <returns>The instance of <paramref name="objectType"/> being deserialized.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Deserialize``1(Microsoft.Identity.Json.JsonReader)"> <summary> Deserializes the JSON structure contained by the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/> into an instance of the specified type. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> containing the object.</param> <typeparam name="T">The type of the object to deserialize.</typeparam> <returns>The instance of <typeparamref name="T"/> being deserialized.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Deserialize(Microsoft.Identity.Json.JsonReader,System.Type)"> <summary> Deserializes the JSON structure contained by the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/> into an instance of the specified type. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> containing the object.</param> <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param> <returns>The instance of <paramref name="objectType"/> being deserialized.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object)"> <summary> Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure using the specified <see cref="T:System.IO.TextWriter"/>. </summary> <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param> <param name="value">The <see cref="T:System.Object"/> to serialize.</param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Serialize(Microsoft.Identity.Json.JsonWriter,System.Object,System.Type)"> <summary> Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure using the specified <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="jsonWriter">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> used to write the JSON structure.</param> <param name="value">The <see cref="T:System.Object"/> to serialize.</param> <param name="objectType"> The type of the value being serialized. This parameter is used when <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Microsoft.Identity.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match. Specifying the type is optional. </param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object,System.Type)"> <summary> Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure using the specified <see cref="T:System.IO.TextWriter"/>. </summary> <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param> <param name="value">The <see cref="T:System.Object"/> to serialize.</param> <param name="objectType"> The type of the value being serialized. This parameter is used when <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. Specifying the type is optional. </param> </member> <member name="M:Microsoft.Identity.Json.JsonSerializer.Serialize(Microsoft.Identity.Json.JsonWriter,System.Object)"> <summary> Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure using the specified <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="jsonWriter">The <see cref="T:Microsoft.Identity.Json.JsonWriter"/> used to write the JSON structure.</param> <param name="value">The <see cref="T:System.Object"/> to serialize.</param> </member> <member name="T:Microsoft.Identity.Json.JsonSerializerSettings"> <summary> Specifies the settings on a <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> object. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ReferenceLoopHandling"> <summary> Gets or sets how reference loops (e.g. a class referencing itself) are handled. The default value is <see cref="F:Microsoft.Identity.Json.ReferenceLoopHandling.Error" />. </summary> <value>Reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.MissingMemberHandling"> <summary> Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.MissingMemberHandling.Ignore" />. </summary> <value>Missing member handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ObjectCreationHandling"> <summary> Gets or sets how objects are created during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.ObjectCreationHandling.Auto" />. </summary> <value>The object creation handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.NullValueHandling"> <summary> Gets or sets how null values are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.NullValueHandling.Include" />. </summary> <value>Null value handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.DefaultValueHandling"> <summary> Gets or sets how default values are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.DefaultValueHandling.Include" />. </summary> <value>The default value handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.Converters"> <summary> Gets or sets a <see cref="T:Microsoft.Identity.Json.JsonConverter"/> collection that will be used during serialization. </summary> <value>The converters.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.PreserveReferencesHandling"> <summary> Gets or sets how object references are preserved by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.PreserveReferencesHandling.None" />. </summary> <value>The preserve references handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.TypeNameHandling"> <summary> Gets or sets how type name writing and reading is handled by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.TypeNameHandling.None" />. </summary> <remarks> <see cref="P:Microsoft.Identity.Json.JsonSerializerSettings.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. Incoming types should be validated with a custom <see cref="P:Microsoft.Identity.Json.JsonSerializerSettings.SerializationBinder"/> when deserializing with a value other than <see cref="F:Microsoft.Identity.Json.TypeNameHandling.None"/>. </remarks> <value>The type name handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.MetadataPropertyHandling"> <summary> Gets or sets how metadata properties are used during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.MetadataPropertyHandling.Default" />. </summary> <value>The metadata properties handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.TypeNameAssemblyFormat"> <summary> Gets or sets how a type name assembly is written and resolved by the serializer. The default value is <see cref="F:System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple" />. </summary> <value>The type name assembly format.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.TypeNameAssemblyFormatHandling"> <summary> Gets or sets how a type name assembly is written and resolved by the serializer. The default value is <see cref="F:Microsoft.Identity.Json.TypeNameAssemblyFormatHandling.Simple" />. </summary> <value>The type name assembly format.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ConstructorHandling"> <summary> Gets or sets how constructors are used during deserialization. The default value is <see cref="F:Microsoft.Identity.Json.ConstructorHandling.Default" />. </summary> <value>The constructor handling.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ContractResolver"> <summary> Gets or sets the contract resolver used by the serializer when serializing .NET objects to JSON and vice versa. </summary> <value>The contract resolver.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.EqualityComparer"> <summary> Gets or sets the equality comparer used by the serializer when comparing references. </summary> <value>The equality comparer.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ReferenceResolver"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references. </summary> <value>The reference resolver.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.ReferenceResolverProvider"> <summary> Gets or sets a function that creates the <see cref="T:Microsoft.Identity.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references. </summary> <value>A function that creates the <see cref="T:Microsoft.Identity.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.TraceWriter"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages. </summary> <value>The trace writer.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.SerializationBinder"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.ISerializationBinder"/> used by the serializer when resolving type names. </summary> <value>The binder.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.Error"> <summary> Gets or sets the error handler called during serialization and deserialization. </summary> <value>The error handler called during serialization and deserialization.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.Context"> <summary> Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods. </summary> <value>The context.</value> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.DateFormatString"> <summary> Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text, and the expected date format when reading JSON text. The default value is <c>"yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.MaxDepth"> <summary> Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Microsoft.Identity.Json.JsonReaderException"/>. A null value means there is no maximum. The default value is <c>null</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.Formatting"> <summary> Indicates how JSON text output is formatted. The default value is <see cref="F:Microsoft.Identity.Json.Formatting.None" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.DateFormatHandling"> <summary> Gets or sets how dates are written to JSON text. The default value is <see cref="F:Microsoft.Identity.Json.DateFormatHandling.IsoDateFormat" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.DateTimeZoneHandling"> <summary> Gets or sets how <see cref="T:System.DateTime"/> time zones are handled during serialization and deserialization. The default value is <see cref="F:Microsoft.Identity.Json.DateTimeZoneHandling.RoundtripKind" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.DateParseHandling"> <summary> Gets or sets how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON. The default value is <see cref="F:Microsoft.Identity.Json.DateParseHandling.DateTime" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.FloatFormatHandling"> <summary> Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, are written as JSON. The default value is <see cref="F:Microsoft.Identity.Json.FloatFormatHandling.String" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.FloatParseHandling"> <summary> Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. The default value is <see cref="F:Microsoft.Identity.Json.FloatParseHandling.Double" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.StringEscapeHandling"> <summary> Gets or sets how strings are escaped when writing JSON text. The default value is <see cref="F:Microsoft.Identity.Json.StringEscapeHandling.Default" />. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.Culture"> <summary> Gets or sets the culture used when reading JSON. The default value is <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonSerializerSettings.CheckAdditionalContent"> <summary> Gets a value indicating whether there will be a check for additional content after deserializing an object. The default value is <c>false</c>. </summary> <value> <c>true</c> if there will be a check for additional content after deserializing an object; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.Identity.Json.JsonSerializerSettings.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonSerializerSettings"/> class. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonTextReader"> <summary> Represents a reader that provides fast, non-cached, forward-only access to JSON text data. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsBooleanAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsBytesAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Byte"/>[]. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Byte"/>[]. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDecimalAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDoubleAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsInt32Async(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsStringAsync(System.Threading.CancellationToken)"> <summary> Asynchronously reads the next JSON token from the source as a <see cref="T:System.String"/>. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns the <see cref="T:System.String"/>. This result will be <c>null</c> at the end of an array.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.#ctor(System.IO.TextReader)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonTextReader"/> class with the specified <see cref="T:System.IO.TextReader"/>. </summary> <param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param> </member> <member name="P:Microsoft.Identity.Json.JsonTextReader.PropertyNameTable"> <summary> Gets or sets the reader's property name table. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonTextReader.ArrayPool"> <summary> Gets or sets the reader's character buffer pool. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.Read"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/>. </summary> <returns> <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsInt32"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDateTime"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsString"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.String"/>. </summary> <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsBytes"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Byte"/>[]. </summary> <returns>A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsBoolean"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDateTimeOffset"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDecimal"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.ReadAsDouble"> <summary> Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.Close"> <summary> Changes the reader's state to <see cref="F:Microsoft.Identity.Json.JsonReader.State.Closed"/>. If <see cref="P:Microsoft.Identity.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.TextReader"/> is also closed. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextReader.HasLineInfo"> <summary> Gets a value indicating whether the class can return line information. </summary> <returns> <c>true</c> if <see cref="P:Microsoft.Identity.Json.JsonTextReader.LineNumber"/> and <see cref="P:Microsoft.Identity.Json.JsonTextReader.LinePosition"/> can be provided; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.JsonTextReader.LineNumber"> <summary> Gets the current line number. </summary> <value> The current line number or 0 if no line information is available (for example, <see cref="M:Microsoft.Identity.Json.JsonTextReader.HasLineInfo"/> returns <c>false</c>). </value> </member> <member name="P:Microsoft.Identity.Json.JsonTextReader.LinePosition"> <summary> Gets the current line position. </summary> <value> The current line position or 0 if no line information is available (for example, <see cref="M:Microsoft.Identity.Json.JsonTextReader.HasLineInfo"/> returns <c>false</c>). </value> </member> <member name="T:Microsoft.Identity.Json.JsonTextWriter"> <summary> Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.FlushAsync(System.Threading.CancellationToken)"> <summary> Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueDelimiterAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the JSON value delimiter. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEndAsync(Microsoft.Identity.Json.JsonToken,System.Threading.CancellationToken)"> <summary> Asynchronously writes the specified end token. </summary> <param name="token">The end token to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.CloseAsync(System.Threading.CancellationToken)"> <summary> Asynchronously closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEndAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of the current JSON object or array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteIndentAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes indent characters. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteIndentSpaceAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes an indent space. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteRawAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes raw JSON without changing the writer's state. </summary> <param name="json">The raw JSON to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteNullAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes a null value. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WritePropertyNameAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WritePropertyNameAsync(System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartArrayAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the beginning of a JSON array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartObjectAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the beginning of a JSON object. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartConstructorAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteUndefinedAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes an undefined value. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteWhitespaceAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the given white space. </summary> <param name="ws">The string of white space characters.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Byte,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Byte},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Byte[],System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Char,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Char},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.DateTime,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.DateTime},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.DateTimeOffset,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Decimal,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Decimal},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Double,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Double},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Single,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Single},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Guid,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Guid},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Int64,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Object"/> value. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.SByte,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.SByte},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Int16,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int16},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.TimeSpan,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.UInt32,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt32},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.UInt64,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt64},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Uri,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.UInt16,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt16},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteCommentAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of an array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEndConstructorAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of a constructor. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of a JSON object. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteRawValueAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes raw JSON where a value is expected and updates the writer's state. </summary> <param name="json">The raw JSON to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.</remarks> </member> <member name="P:Microsoft.Identity.Json.JsonTextWriter.ArrayPool"> <summary> Gets or sets the writer's character array pool. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonTextWriter.Indentation"> <summary> Gets or sets how many <see cref="P:Microsoft.Identity.Json.JsonTextWriter.IndentChar"/>s to write for each level in the hierarchy when <see cref="P:Microsoft.Identity.Json.JsonWriter.Formatting"/> is set to <see cref="F:Microsoft.Identity.Json.Formatting.Indented"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonTextWriter.QuoteChar"> <summary> Gets or sets which character to use to quote attribute values. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonTextWriter.IndentChar"> <summary> Gets or sets which character to use for indenting when <see cref="P:Microsoft.Identity.Json.JsonWriter.Formatting"/> is set to <see cref="F:Microsoft.Identity.Json.Formatting.Indented"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonTextWriter.QuoteName"> <summary> Gets or sets a value indicating whether object names will be surrounded with quotes. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.#ctor(System.IO.TextWriter)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonTextWriter"/> class using the specified <see cref="T:System.IO.TextWriter"/>. </summary> <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> to write to.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.Flush"> <summary> Flushes whatever is in the buffer to the underlying <see cref="T:System.IO.TextWriter"/> and also flushes the underlying <see cref="T:System.IO.TextWriter"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.Close"> <summary> Closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.TextWriter"/> is also closed. If <see cref="P:Microsoft.Identity.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartObject"> <summary> Writes the beginning of a JSON object. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartArray"> <summary> Writes the beginning of a JSON array. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteStartConstructor(System.String)"> <summary> Writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteEnd(Microsoft.Identity.Json.JsonToken)"> <summary> Writes the specified end token. </summary> <param name="token">The end token to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WritePropertyName(System.String)"> <summary> Writes the property name of a name/value pair on a JSON object. </summary> <param name="name">The name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WritePropertyName(System.String,System.Boolean)"> <summary> Writes the property name of a name/value pair on a JSON object. </summary> <param name="name">The name of the property.</param> <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteIndent"> <summary> Writes indent characters. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValueDelimiter"> <summary> Writes the JSON value delimiter. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteIndentSpace"> <summary> Writes an indent space. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Object)"> <summary> Writes a <see cref="T:System.Object"/> value. An error will raised if the value cannot be written as a single JSON token. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteNull"> <summary> Writes a null value. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteUndefined"> <summary> Writes an undefined value. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteRaw(System.String)"> <summary> Writes raw JSON. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.String)"> <summary> Writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Int32)"> <summary> Writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.UInt32)"> <summary> Writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Int64)"> <summary> Writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.UInt64)"> <summary> Writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Single)"> <summary> Writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Nullable{System.Single})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Double)"> <summary> Writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Nullable{System.Double})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Boolean)"> <summary> Writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Int16)"> <summary> Writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.UInt16)"> <summary> Writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Char)"> <summary> Writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Byte)"> <summary> Writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.SByte)"> <summary> Writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Decimal)"> <summary> Writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.DateTime)"> <summary> Writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Byte[])"> <summary> Writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.DateTimeOffset)"> <summary> Writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Guid)"> <summary> Writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.TimeSpan)"> <summary> Writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteValue(System.Uri)"> <summary> Writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteComment(System.String)"> <summary> Writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> </member> <member name="M:Microsoft.Identity.Json.JsonTextWriter.WriteWhitespace(System.String)"> <summary> Writes the given white space. </summary> <param name="ws">The string of white space characters.</param> </member> <member name="T:Microsoft.Identity.Json.JsonToken"> <summary> Specifies the type of JSON token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.None"> <summary> This is returned by the <see cref="T:Microsoft.Identity.Json.JsonReader"/> if a read method has not been called. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.StartObject"> <summary> An object start token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.StartArray"> <summary> An array start token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.StartConstructor"> <summary> A constructor start token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.PropertyName"> <summary> An object property name. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Comment"> <summary> A comment. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Raw"> <summary> Raw JSON. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Integer"> <summary> An integer. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Float"> <summary> A float. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.String"> <summary> A string. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Boolean"> <summary> A boolean. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Null"> <summary> A null token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Undefined"> <summary> An undefined token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.EndObject"> <summary> An object end token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.EndArray"> <summary> An array end token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.EndConstructor"> <summary> A constructor end token. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Date"> <summary> A Date. </summary> </member> <member name="F:Microsoft.Identity.Json.JsonToken.Bytes"> <summary> Byte data. </summary> </member> <member name="T:Microsoft.Identity.Json.JsonValidatingReader"> <summary> <para> Represents a reader that provides <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> validation. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="E:Microsoft.Identity.Json.JsonValidatingReader.ValidationEventHandler"> <summary> Sets an event handler for receiving schema validation errors. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.Value"> <summary> Gets the text value of the current JSON token. </summary> <value></value> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.Depth"> <summary> Gets the depth of the current token in the JSON document. </summary> <value>The depth of the current token in the JSON document.</value> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.Path"> <summary> Gets the path of the current JSON token. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.QuoteChar"> <summary> Gets the quotation mark character used to enclose the value of a string. </summary> <value></value> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.TokenType"> <summary> Gets the type of the current JSON token. </summary> <value></value> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.ValueType"> <summary> Gets the .NET type for the current JSON token. </summary> <value></value> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.#ctor(Microsoft.Identity.Json.JsonReader)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonValidatingReader"/> class that validates the content returned from the given <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read from while validating.</param> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.Schema"> <summary> Gets or sets the schema. </summary> <value>The schema.</value> </member> <member name="P:Microsoft.Identity.Json.JsonValidatingReader.Reader"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.JsonReader"/> used to construct this <see cref="T:Microsoft.Identity.Json.JsonValidatingReader"/>. </summary> <value>The <see cref="T:Microsoft.Identity.Json.JsonReader"/> specified in the constructor.</value> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.Close"> <summary> Changes the reader's state to <see cref="F:Microsoft.Identity.Json.JsonReader.State.Closed"/>. If <see cref="P:Microsoft.Identity.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> is also closed. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsInt32"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsBytes"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Byte"/>[]. </summary> <returns> A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null. </returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsDecimal"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsDouble"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsBoolean"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsString"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.String"/>. </summary> <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsDateTime"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.ReadAsDateTimeOffset"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.JsonValidatingReader.Read"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <returns> <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read. </returns> </member> <member name="T:Microsoft.Identity.Json.JsonWriter"> <summary> Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.CloseAsync(System.Threading.CancellationToken)"> <summary> Asynchronously closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.FlushAsync(System.Threading.CancellationToken)"> <summary> Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndAsync(Microsoft.Identity.Json.JsonToken,System.Threading.CancellationToken)"> <summary> Asynchronously writes the specified end token. </summary> <param name="token">The end token to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteIndentAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes indent characters. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueDelimiterAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the JSON value delimiter. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteIndentSpaceAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes an indent space. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteRawAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes raw JSON without changing the writer's state. </summary> <param name="json">The raw JSON to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of the current JSON object or array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of an array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndConstructorAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of a constructor. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the end of a JSON object. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteNullAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes a null value. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WritePropertyNameAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WritePropertyNameAsync(System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartArrayAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the beginning of a JSON array. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteCommentAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteRawValueAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes raw JSON where a value is expected and updates the writer's state. </summary> <param name="json">The raw JSON to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartConstructorAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartObjectAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes the beginning of a JSON object. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteTokenAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously writes the current <see cref="T:Microsoft.Identity.Json.JsonReader"/> token. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read the token from.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteTokenAsync(Microsoft.Identity.Json.JsonReader,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously writes the current <see cref="T:Microsoft.Identity.Json.JsonReader"/> token. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read the token from.</param> <param name="writeChildren">A flag indicating whether the current token's children should be written.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteTokenAsync(Microsoft.Identity.Json.JsonToken,System.Threading.CancellationToken)"> <summary> Asynchronously writes the <see cref="T:Microsoft.Identity.Json.JsonToken"/> token and its value. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteTokenAsync(Microsoft.Identity.Json.JsonToken,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously writes the <see cref="T:Microsoft.Identity.Json.JsonToken"/> token and its value. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> to write.</param> <param name="value"> The value to write. A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String"/> property name for <see cref="F:Microsoft.Identity.Json.JsonToken.PropertyName"/>. <c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Microsoft.Identity.Json.JsonToken.StartObject"/>. </param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Byte,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Byte},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Byte[],System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Char,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Char},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.DateTime,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.DateTime},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.DateTimeOffset,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Decimal,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Decimal},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Double,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Double},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Single,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Single},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Guid,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Guid},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Int64,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Object"/> value. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.SByte,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.SByte},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Int16,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int16},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.TimeSpan,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.UInt32,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt32},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.UInt64,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt64},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Uri,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.UInt16,System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt16},System.Threading.CancellationToken)"> <summary> Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteUndefinedAsync(System.Threading.CancellationToken)"> <summary> Asynchronously writes an undefined value. </summary> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteWhitespaceAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously writes the given white space. </summary> <param name="ws">The string of white space characters.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.SetWriteStateAsync(Microsoft.Identity.Json.JsonToken,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously ets the state of the <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> being written.</param> <param name="value">The value being written.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns> <remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asynchronicity.</remarks> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"> <summary> Gets or sets a value indicating whether the destination should be closed when this writer is closed. </summary> <value> <c>true</c> to close the destination when this writer is closed; otherwise <c>false</c>. The default is <c>true</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.AutoCompleteOnClose"> <summary> Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. </summary> <value> <c>true</c> to auto-complete the JSON when this writer is closed; otherwise <c>false</c>. The default is <c>true</c>. </value> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.Top"> <summary> Gets the top. </summary> <value>The top.</value> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.WriteState"> <summary> Gets the state of the writer. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.Path"> <summary> Gets the path of the writer. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.Formatting"> <summary> Gets or sets a value indicating how JSON text output should be formatted. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.DateFormatHandling"> <summary> Gets or sets how dates are written to JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.DateTimeZoneHandling"> <summary> Gets or sets how <see cref="T:System.DateTime"/> time zones are handled when writing JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.StringEscapeHandling"> <summary> Gets or sets how strings are escaped when writing JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.FloatFormatHandling"> <summary> Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, are written to JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.DateFormatString"> <summary> Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriter.Culture"> <summary> Gets or sets the culture used when writing JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriter"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.Flush"> <summary> Flushes whatever is in the buffer to the destination and also flushes the destination. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.Close"> <summary> Closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed. If <see cref="P:Microsoft.Identity.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartObject"> <summary> Writes the beginning of a JSON object. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndObject"> <summary> Writes the end of a JSON object. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartArray"> <summary> Writes the beginning of a JSON array. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndArray"> <summary> Writes the end of an array. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteStartConstructor(System.String)"> <summary> Writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEndConstructor"> <summary> Writes the end constructor. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WritePropertyName(System.String)"> <summary> Writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WritePropertyName(System.String,System.Boolean)"> <summary> Writes the property name of a name/value pair of a JSON object. </summary> <param name="name">The name of the property.</param> <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEnd"> <summary> Writes the end of the current JSON object or array. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteToken(Microsoft.Identity.Json.JsonReader)"> <summary> Writes the current <see cref="T:Microsoft.Identity.Json.JsonReader"/> token and its children. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read the token from.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteToken(Microsoft.Identity.Json.JsonReader,System.Boolean)"> <summary> Writes the current <see cref="T:Microsoft.Identity.Json.JsonReader"/> token. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> to read the token from.</param> <param name="writeChildren">A flag indicating whether the current token's children should be written.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteToken(Microsoft.Identity.Json.JsonToken,System.Object)"> <summary> Writes the <see cref="T:Microsoft.Identity.Json.JsonToken"/> token and its value. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> to write.</param> <param name="value"> The value to write. A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String"/> property name for <see cref="F:Microsoft.Identity.Json.JsonToken.PropertyName"/>. <c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Microsoft.Identity.Json.JsonToken.StartObject"/>. </param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteToken(Microsoft.Identity.Json.JsonToken)"> <summary> Writes the <see cref="T:Microsoft.Identity.Json.JsonToken"/> token. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteEnd(Microsoft.Identity.Json.JsonToken)"> <summary> Writes the specified end token. </summary> <param name="token">The end token to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteIndent"> <summary> Writes indent characters. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValueDelimiter"> <summary> Writes the JSON value delimiter. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteIndentSpace"> <summary> Writes an indent space. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteNull"> <summary> Writes a null value. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteUndefined"> <summary> Writes an undefined value. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteRaw(System.String)"> <summary> Writes raw JSON without changing the writer's state. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteRawValue(System.String)"> <summary> Writes raw JSON where a value is expected and updates the writer's state. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.String)"> <summary> Writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Int32)"> <summary> Writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.UInt32)"> <summary> Writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Int64)"> <summary> Writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.UInt64)"> <summary> Writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Single)"> <summary> Writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Double)"> <summary> Writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Boolean)"> <summary> Writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Int16)"> <summary> Writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.UInt16)"> <summary> Writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Char)"> <summary> Writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Byte)"> <summary> Writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.SByte)"> <summary> Writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Decimal)"> <summary> Writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.DateTime)"> <summary> Writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.DateTimeOffset)"> <summary> Writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Guid)"> <summary> Writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.TimeSpan)"> <summary> Writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Int32})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.UInt32})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Int64})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.UInt64})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Single})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Double})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Boolean})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Int16})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.UInt16})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Char})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Byte})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.SByte})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Decimal})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.DateTime})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.DateTimeOffset})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.Guid})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Nullable{System.TimeSpan})"> <summary> Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Byte[])"> <summary> Writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Uri)"> <summary> Writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteValue(System.Object)"> <summary> Writes a <see cref="T:System.Object"/> value. An error will raised if the value cannot be written as a single JSON token. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteComment(System.String)"> <summary> Writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.WriteWhitespace(System.String)"> <summary> Writes the given white space. </summary> <param name="ws">The string of white space characters.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.Dispose(System.Boolean)"> <summary> Releases unmanaged and - optionally - managed resources. </summary> <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriter.SetWriteState(Microsoft.Identity.Json.JsonToken,System.Object)"> <summary> Sets the state of the <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="token">The <see cref="T:Microsoft.Identity.Json.JsonToken"/> being written.</param> <param name="value">The value being written.</param> </member> <member name="T:Microsoft.Identity.Json.JsonWriterException"> <summary> The exception thrown when an error occurs while writing JSON text. </summary> </member> <member name="P:Microsoft.Identity.Json.JsonWriterException.Path"> <summary> Gets the path to the JSON where the error occurred. </summary> <value>The path to the JSON where the error occurred.</value> </member> <member name="M:Microsoft.Identity.Json.JsonWriterException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriterException"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.JsonWriterException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriterException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriterException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriterException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="M:Microsoft.Identity.Json.JsonWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriterException"/> class. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> </member> <member name="M:Microsoft.Identity.Json.JsonWriterException.#ctor(System.String,System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.JsonWriterException"/> class with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="path">The path to the JSON where the error occurred.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="T:Microsoft.Identity.Json.Linq.CommentHandling"> <summary> Specifies how JSON comments are handled when loading JSON. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.CommentHandling.Ignore"> <summary> Ignore comments. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.CommentHandling.Load"> <summary> Load comments as a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> with type <see cref="F:Microsoft.Identity.Json.Linq.JTokenType.Comment"/>. </summary> </member> <member name="T:Microsoft.Identity.Json.Linq.Extensions"> <summary> Contains the LINQ to JSON extension methods. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Ancestors``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of tokens that contains the ancestors of every token in the source collection. </summary> <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the ancestors of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.AncestorsAndSelf``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. </summary> <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains every token in the source collection, the ancestors of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Descendants``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of tokens that contains the descendants of every token in the source collection. </summary> <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Microsoft.Identity.Json.Linq.JContainer"/>.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the descendants of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.DescendantsAndSelf``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. </summary> <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Microsoft.Identity.Json.Linq.JContainer"/>.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains every token in the source collection, and the descendants of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Properties(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JObject})"> <summary> Returns a collection of child properties of every object in the source collection. </summary> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> that contains the properties of every object in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken},System.Object)"> <summary> Returns a collection of child values of every object in the source collection with the given key. </summary> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <param name="key">The token key.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the values of every token in the source collection with the given key.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken})"> <summary> Returns a collection of child values of every object in the source collection. </summary> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken},System.Object)"> <summary> Returns a collection of converted child values of every object in the source collection with the given key. </summary> <typeparam name="U">The type to convert the values to.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <param name="key">The token key.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection with the given key.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken})"> <summary> Returns a collection of converted child values of every object in the source collection. </summary> <typeparam name="U">The type to convert the values to.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Value``1(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken})"> <summary> Converts the value. </summary> <typeparam name="U">The type to convert the value to.</typeparam> <param name="value">A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <returns>A converted value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Value``2(System.Collections.Generic.IEnumerable{``0})"> <summary> Converts the value. </summary> <typeparam name="T">The source collection type.</typeparam> <typeparam name="U">The type to convert the value to.</typeparam> <param name="value">A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <returns>A converted value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Children``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of child tokens of every array in the source collection. </summary> <typeparam name="T">The source collection type.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.Children``2(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns a collection of converted child tokens of every array in the source collection. </summary> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <typeparam name="U">The type to convert the values to.</typeparam> <typeparam name="T">The source collection type.</typeparam> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.AsJEnumerable(System.Collections.Generic.IEnumerable{Microsoft.Identity.Json.Linq.JToken})"> <summary> Returns the input typed as <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/>. </summary> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>The input typed as <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.Extensions.AsJEnumerable``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Returns the input typed as <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/>. </summary> <typeparam name="T">The source collection type.</typeparam> <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the source collection.</param> <returns>The input typed as <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/>.</returns> </member> <member name="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"> <summary> Represents a collection of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> objects. </summary> <typeparam name="T">The type of token.</typeparam> </member> <member name="P:Microsoft.Identity.Json.Linq.IJEnumerable`1.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value></value> </member> <member name="T:Microsoft.Identity.Json.Linq.JArray"> <summary> Represents a JSON array. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.LoadAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.LoadAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JArray.ChildrenTokens"> <summary> Gets the container's children tokens. </summary> <value>The container's children tokens.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JArray.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.#ctor(Microsoft.Identity.Json.Linq.JArray)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> object to copy from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.#ctor(System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> class with the specified content. </summary> <param name="content">The contents of the array.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.#ctor(System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> class with the specified content. </summary> <param name="content">The contents of the array.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Load(Microsoft.Identity.Json.JsonReader)"> <summary> Loads an <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Load(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Loads an <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Parse(System.String)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> populated from the string that contains JSON.</returns> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Parse(System.String,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> populated from the string that contains JSON.</returns> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.FromObject(System.Object)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from an object. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> with the values of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.FromObject(System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> from an object. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <param name="jsonSerializer">The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> that will be used to read the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> with the values of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JArray.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JArray.Item(System.Int32)"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> at the specified index. </summary> <value></value> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.IndexOf(Microsoft.Identity.Json.Linq.JToken)"> <summary> Determines the index of a specific item in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </summary> <param name="item">The object to locate in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <returns> The index of <paramref name="item"/> if found in the list; otherwise, -1. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Insert(System.Int32,Microsoft.Identity.Json.Linq.JToken)"> <summary> Inserts an item to the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> at the specified index. </summary> <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> <param name="item">The object to insert into the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="index"/> is not a valid index in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </exception> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.RemoveAt(System.Int32)"> <summary> Removes the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> item at the specified index. </summary> <param name="index">The zero-based index of the item to remove.</param> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="index"/> is not a valid index in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </exception> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns> A <see cref="T:System.Collections.Generic.IEnumerator`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that can be used to iterate through the collection. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Add(Microsoft.Identity.Json.Linq.JToken)"> <summary> Adds an item to the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </summary> <param name="item">The object to add to the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Clear"> <summary> Removes all items from the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Contains(Microsoft.Identity.Json.Linq.JToken)"> <summary> Determines whether the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> contains a specific value. </summary> <param name="item">The object to locate in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <returns> <c>true</c> if <paramref name="item"/> is found in the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.CopyTo(Microsoft.Identity.Json.Linq.JToken[],System.Int32)"> <summary> Copies the elements of the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> to an array, starting at a particular array index. </summary> <param name="array">The array.</param> <param name="arrayIndex">Index of the array.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JArray.IsReadOnly"> <summary> Gets a value indicating whether the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> is read-only. </summary> <returns><c>true</c> if the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/> is read-only; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JArray.Remove(Microsoft.Identity.Json.Linq.JToken)"> <summary> Removes the first occurrence of a specific object from the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </summary> <param name="item">The object to remove from the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>.</param> <returns> <c>true</c> if <paramref name="item"/> was successfully removed from the <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>; otherwise, <c>false</c>. This method also returns <c>false</c> if <paramref name="item"/> is not found in the original <see cref="T:Microsoft.Identity.Json.Linq.JArray"/>. </returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JConstructor"> <summary> Represents a JSON constructor. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.LoadAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/>.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.LoadAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JConstructor.ChildrenTokens"> <summary> Gets the container's children tokens. </summary> <value>The container's children tokens.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JConstructor.Name"> <summary> Gets or sets the name of this constructor. </summary> <value>The constructor name.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JConstructor.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.#ctor(Microsoft.Identity.Json.Linq.JConstructor)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> object to copy from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.#ctor(System.String,System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> class with the specified name and content. </summary> <param name="name">The constructor name.</param> <param name="content">The contents of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.#ctor(System.String,System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> class with the specified name and content. </summary> <param name="name">The constructor name.</param> <param name="content">The contents of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> class with the specified name. </summary> <param name="name">The constructor name.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JConstructor.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.Load(Microsoft.Identity.Json.JsonReader)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JConstructor.Load(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JContainer"> <summary> Represents a token that can contain other tokens. </summary> </member> <member name="E:Microsoft.Identity.Json.Linq.JContainer.ListChanged"> <summary> Occurs when the list changes or an item in the list changes. </summary> </member> <member name="E:Microsoft.Identity.Json.Linq.JContainer.AddingNew"> <summary> Occurs before an item is added to the collection. </summary> </member> <member name="E:Microsoft.Identity.Json.Linq.JContainer.CollectionChanged"> <summary> Occurs when the items list of the collection has changed, or the collection is reset. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JContainer.ChildrenTokens"> <summary> Gets the container's children tokens. </summary> <value>The container's children tokens.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.OnAddingNew(System.ComponentModel.AddingNewEventArgs)"> <summary> Raises the <see cref="E:Microsoft.Identity.Json.Linq.JContainer.AddingNew"/> event. </summary> <param name="e">The <see cref="T:System.ComponentModel.AddingNewEventArgs"/> instance containing the event data.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.OnListChanged(System.ComponentModel.ListChangedEventArgs)"> <summary> Raises the <see cref="E:Microsoft.Identity.Json.Linq.JContainer.ListChanged"/> event. </summary> <param name="e">The <see cref="T:System.ComponentModel.ListChangedEventArgs"/> instance containing the event data.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> <summary> Raises the <see cref="E:Microsoft.Identity.Json.Linq.JContainer.CollectionChanged"/> event. </summary> <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> instance containing the event data.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JContainer.HasValues"> <summary> Gets a value indicating whether this token has child tokens. </summary> <value> <c>true</c> if this token has child values; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Linq.JContainer.First"> <summary> Get the first child token of this token. </summary> <value> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </value> </member> <member name="P:Microsoft.Identity.Json.Linq.JContainer.Last"> <summary> Get the last child token of this token. </summary> <value> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </value> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Children"> <summary> Returns a collection of the child tokens of this token, in document order. </summary> <returns> An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, in document order. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Values``1"> <summary> Returns a collection of the child values of this token, in document order. </summary> <typeparam name="T">The type to convert the values to.</typeparam> <returns> A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, in document order. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Descendants"> <summary> Returns a collection of the descendant tokens for this token in document order. </summary> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the descendant tokens of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.DescendantsAndSelf"> <summary> Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. </summary> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing this token, and all the descendant tokens of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Add(System.Object)"> <summary> Adds the specified content as children of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="content">The content to be added.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.AddFirst(System.Object)"> <summary> Adds the specified content as the first children of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="content">The content to be added.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.CreateWriter"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> that can be used to add tokens to the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <returns>A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> that is ready to have content written to it.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.ReplaceAll(System.Object)"> <summary> Replaces the child nodes of this token with the specified content. </summary> <param name="content">The content.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.RemoveAll"> <summary> Removes the child nodes from this token. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Merge(System.Object)"> <summary> Merge the specified content into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="content">The content to be merged.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JContainer.Merge(System.Object,Microsoft.Identity.Json.Linq.JsonMergeSettings)"> <summary> Merge the specified content into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> using <see cref="T:Microsoft.Identity.Json.Linq.JsonMergeSettings"/>. </summary> <param name="content">The content to be merged.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonMergeSettings"/> used to merge the content.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JContainer.Count"> <summary> Gets the count of child JSON tokens. </summary> <value>The count of child JSON tokens.</value> </member> <member name="T:Microsoft.Identity.Json.Linq.JEnumerable`1"> <summary> Represents a collection of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> objects. </summary> <typeparam name="T">The type of token.</typeparam> </member> <member name="F:Microsoft.Identity.Json.Linq.JEnumerable`1.Empty"> <summary> An empty collection of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> objects. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JEnumerable`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> struct. </summary> <param name="enumerable">The enumerable.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JEnumerable`1.GetEnumerator"> <summary> Returns an enumerator that can be used to iterate through the collection. </summary> <returns> A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JEnumerable`1.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.IJEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value></value> </member> <member name="M:Microsoft.Identity.Json.Linq.JEnumerable`1.Equals(Microsoft.Identity.Json.Linq.JEnumerable{`0})"> <summary> Determines whether the specified <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> is equal to this instance. </summary> <param name="other">The <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JEnumerable`1.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object"/> is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JEnumerable`1.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JObject"> <summary> Represents a JSON object. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.LoadAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.LoadAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JObject.ChildrenTokens"> <summary> Gets the container's children tokens. </summary> <value>The container's children tokens.</value> </member> <member name="E:Microsoft.Identity.Json.Linq.JObject.PropertyChanged"> <summary> Occurs when a property value changes. </summary> </member> <member name="E:Microsoft.Identity.Json.Linq.JObject.PropertyChanging"> <summary> Occurs when a property value is changing. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.#ctor(Microsoft.Identity.Json.Linq.JObject)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> object to copy from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.#ctor(System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> class with the specified content. </summary> <param name="content">The contents of the object.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.#ctor(System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> class with the specified content. </summary> <param name="content">The contents of the object.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JObject.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Properties"> <summary> Gets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> of this object's properties. </summary> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> of this object's properties.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Property(System.String)"> <summary> Gets a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> with the specified name. </summary> <param name="name">The property name.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Property(System.String,System.StringComparison)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> with the specified name. The exact name will be searched for first and if no matching property is found then the <see cref="T:System.StringComparison"/> will be used to match a property. </summary> <param name="name">The property name.</param> <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.PropertyValues"> <summary> Gets a <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> of this object's property values. </summary> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> of this object's property values.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JObject.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JObject.Item(System.String)"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name. </summary> <value></value> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Load(Microsoft.Identity.Json.JsonReader)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> <exception cref="T:Microsoft.Identity.Json.JsonReaderException"> <paramref name="reader"/> is not valid JSON. </exception> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Load(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> <exception cref="T:Microsoft.Identity.Json.JsonReaderException"> <paramref name="reader"/> is not valid JSON. </exception> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Parse(System.String)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> populated from the string that contains JSON.</returns> <exception cref="T:Microsoft.Identity.Json.JsonReaderException"> <paramref name="json"/> is not valid JSON. </exception> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Parse(System.String,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> populated from the string that contains JSON.</returns> <exception cref="T:Microsoft.Identity.Json.JsonReaderException"> <paramref name="json"/> is not valid JSON. </exception> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" /> </example> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.FromObject(System.Object)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from an object. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> with the values of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.FromObject(System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> from an object. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JObject"/>.</param> <param name="jsonSerializer">The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> that will be used to read the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JObject"/> with the values of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.GetValue(System.String)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name. </summary> <param name="propertyName">Name of the property.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.GetValue(System.String,System.StringComparison)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name. The exact property name will be searched for first and if no matching property is found then the <see cref="T:System.StringComparison"/> will be used to match a property. </summary> <param name="propertyName">Name of the property.</param> <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.TryGetValue(System.String,System.StringComparison,Microsoft.Identity.Json.Linq.JToken@)"> <summary> Tries to get the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name. The exact property name will be searched for first and if no matching property is found then the <see cref="T:System.StringComparison"/> will be used to match a property. </summary> <param name="propertyName">Name of the property.</param> <param name="value">The value.</param> <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param> <returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Add(System.String,Microsoft.Identity.Json.Linq.JToken)"> <summary> Adds the specified property name. </summary> <param name="propertyName">Name of the property.</param> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.ContainsKey(System.String)"> <summary> Determines whether the JSON object has the specified property name. </summary> <param name="propertyName">Name of the property.</param> <returns><c>true</c> if the JSON object has the specified property name; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.Remove(System.String)"> <summary> Removes the property with the specified name. </summary> <param name="propertyName">Name of the property.</param> <returns><c>true</c> if item was successfully removed; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.TryGetValue(System.String,Microsoft.Identity.Json.Linq.JToken@)"> <summary> Tries to get the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified property name. </summary> <param name="propertyName">Name of the property.</param> <param name="value">The value.</param> <returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.GetEnumerator"> <summary> Returns an enumerator that can be used to iterate through the collection. </summary> <returns> A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.OnPropertyChanged(System.String)"> <summary> Raises the <see cref="E:Microsoft.Identity.Json.Linq.JObject.PropertyChanged"/> event with the provided arguments. </summary> <param name="propertyName">Name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.OnPropertyChanging(System.String)"> <summary> Raises the <see cref="E:Microsoft.Identity.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments. </summary> <param name="propertyName">Name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)"> <summary> Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. </summary> <param name="parameter">The expression tree representation of the runtime value.</param> <returns> The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. </returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JProperty"> <summary> Represents a JSON property. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.LoadAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/>.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.LoadAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously loads a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JProperty.ChildrenTokens"> <summary> Gets the container's children tokens. </summary> <value>The container's children tokens.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JProperty.Name"> <summary> Gets the property name. </summary> <value>The property name.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JProperty.Value"> <summary> Gets or sets the property value. </summary> <value>The property value.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.#ctor(Microsoft.Identity.Json.Linq.JProperty)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> object to copy from.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JProperty.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.#ctor(System.String,System.Object[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> class. </summary> <param name="name">The property name.</param> <param name="content">The property content.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.#ctor(System.String,System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> class. </summary> <param name="name">The property name.</param> <param name="content">The property content.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.Load(Microsoft.Identity.Json.JsonReader)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JProperty.Load(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Loads a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that will be read for the content of the <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>.</returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JPropertyDescriptor"> <summary> Represents a view of a <see cref="T:Microsoft.Identity.Json.Linq.JProperty"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JPropertyDescriptor"/> class. </summary> <param name="name">The name.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.CanResetValue(System.Object)"> <summary> When overridden in a derived class, returns whether resetting an object changes its value. </summary> <returns> <c>true</c> if resetting the component changes its value; otherwise, <c>false</c>. </returns> <param name="component">The component to test for reset capability.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.GetValue(System.Object)"> <summary> When overridden in a derived class, gets the current value of the property on a component. </summary> <returns> The value of a property for a given component. </returns> <param name="component">The component with the property for which to retrieve the value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.ResetValue(System.Object)"> <summary> When overridden in a derived class, resets the value for this property of the component to the default value. </summary> <param name="component">The component with the property value that is to be reset to the default value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.SetValue(System.Object,System.Object)"> <summary> When overridden in a derived class, sets the value of the component to a different value. </summary> <param name="component">The component with the property value that is to be set.</param> <param name="value">The new value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JPropertyDescriptor.ShouldSerializeValue(System.Object)"> <summary> When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. </summary> <returns> <c>true</c> if the property should be persisted; otherwise, <c>false</c>. </returns> <param name="component">The component with the property to be examined for persistence.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JPropertyDescriptor.ComponentType"> <summary> When overridden in a derived class, gets the type of the component this property is bound to. </summary> <returns> A <see cref="T:System.Type"/> that represents the type of component this property is bound to. When the <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)"/> or <see cref="M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object)"/> methods are invoked, the object specified might be an instance of this type. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JPropertyDescriptor.IsReadOnly"> <summary> When overridden in a derived class, gets a value indicating whether this property is read-only. </summary> <returns> <c>true</c> if the property is read-only; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JPropertyDescriptor.PropertyType"> <summary> When overridden in a derived class, gets the type of the property. </summary> <returns> A <see cref="T:System.Type"/> that represents the type of the property. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JPropertyDescriptor.NameHashCode"> <summary> Gets the hash code for the name of the member. </summary> <value></value> <returns> The hash code for the name of the member. </returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JRaw"> <summary> Represents a raw JSON string. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JRaw.CreateAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously creates an instance of <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> with the content of the reader's current token. </summary> <param name="reader">The reader.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns an instance of <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> with the content of the reader's current token.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JRaw.#ctor(Microsoft.Identity.Json.Linq.JRaw)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> object to copy from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JRaw.#ctor(System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> class. </summary> <param name="rawJson">The raw json.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JRaw.Create(Microsoft.Identity.Json.JsonReader)"> <summary> Creates an instance of <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> with the content of the reader's current token. </summary> <param name="reader">The reader.</param> <returns>An instance of <see cref="T:Microsoft.Identity.Json.Linq.JRaw"/> with the content of the reader's current token.</returns> </member> <member name="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"> <summary> Specifies the settings used when loading JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JsonLoadSettings.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> class. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JsonLoadSettings.CommentHandling"> <summary> Gets or sets how JSON comments are handled when loading JSON. </summary> <value>The JSON comment handling.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JsonLoadSettings.LineInfoHandling"> <summary> Gets or sets how JSON line info is handled when loading JSON. </summary> <value>The JSON line info handling.</value> </member> <member name="T:Microsoft.Identity.Json.Linq.JsonMergeSettings"> <summary> Specifies the settings used when merging JSON. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JsonMergeSettings.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JsonMergeSettings"/> class. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JsonMergeSettings.MergeArrayHandling"> <summary> Gets or sets the method used when merging JSON arrays. </summary> <value>The method used when merging JSON arrays.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JsonMergeSettings.MergeNullValueHandling"> <summary> Gets or sets how null value properties are merged. </summary> <value>How null value properties are merged.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JsonMergeSettings.PropertyNameComparison"> <summary> Gets or sets the comparison used to match property names while merging. The exact property name will be searched for first and if no matching property is found then the <see cref="T:System.StringComparison"/> will be used to match a property. </summary> <value>The comparison used to match property names while merging.</value> </member> <member name="T:Microsoft.Identity.Json.Linq.JToken"> <summary> Represents an abstract JSON token. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.WriteToAsync(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ReadFromAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">An <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ReadFromAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">An <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.LoadAsync(Microsoft.Identity.Json.JsonReader,System.Threading.CancellationToken)"> <summary> Asynchronously creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.LoadAsync(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)"> <summary> Asynchronously creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param> <returns> A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.EqualityComparer"> <summary> Gets a comparer that can compare two tokens for value equality. </summary> <value>A <see cref="T:Microsoft.Identity.Json.Linq.JTokenEqualityComparer"/> that can compare two nodes for value equality.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Parent"> <summary> Gets or sets the parent. </summary> <value>The parent.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Root"> <summary> Gets the root <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The root <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.HasValues"> <summary> Gets a value indicating whether this token has child tokens. </summary> <value> <c>true</c> if this token has child values; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.DeepEquals(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Linq.JToken)"> <summary> Compares the values of two tokens, including the values of all descendant tokens. </summary> <param name="t1">The first <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to compare.</param> <param name="t2">The second <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to compare.</param> <returns><c>true</c> if the tokens are equal; otherwise <c>false</c>.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Next"> <summary> Gets the next sibling token of this node. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the next sibling token.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Previous"> <summary> Gets the previous sibling token of this node. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the previous sibling token.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Path"> <summary> Gets the path of the JSON token. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.AddAfterSelf(System.Object)"> <summary> Adds the specified content immediately after this token. </summary> <param name="content">A content object that contains simple content or a collection of content objects to be added after this token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.AddBeforeSelf(System.Object)"> <summary> Adds the specified content immediately before this token. </summary> <param name="content">A content object that contains simple content or a collection of content objects to be added before this token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Ancestors"> <summary> Returns a collection of the ancestor tokens of this token. </summary> <returns>A collection of the ancestor tokens of this token.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.AncestorsAndSelf"> <summary> Returns a collection of tokens that contain this token, and the ancestors of this token. </summary> <returns>A collection of tokens that contain this token, and the ancestors of this token.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.AfterSelf"> <summary> Returns a collection of the sibling tokens after this token, in document order. </summary> <returns>A collection of the sibling tokens after this tokens, in document order.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.BeforeSelf"> <summary> Returns a collection of the sibling tokens before this token, in document order. </summary> <returns>A collection of the sibling tokens before this token, in document order.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Item(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Value``1(System.Object)"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the specified key converted to the specified type. </summary> <typeparam name="T">The type to convert the token to.</typeparam> <param name="key">The token key.</param> <returns>The converted token value.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.First"> <summary> Get the first child token of this token. </summary> <value>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JToken.Last"> <summary> Get the last child token of this token. </summary> <value>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Children"> <summary> Returns a collection of the child tokens of this token, in document order. </summary> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, in document order.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Children``1"> <summary> Returns a collection of the child tokens of this token, in document order, filtered by the specified type. </summary> <typeparam name="T">The type to filter the child tokens on.</typeparam> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JEnumerable`1"/> containing the child tokens of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, in document order.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Values``1"> <summary> Returns a collection of the child values of this token, in document order. </summary> <typeparam name="T">The type to convert the values to.</typeparam> <returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, in document order.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Remove"> <summary> Removes this token from its parent. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Replace(Microsoft.Identity.Json.Linq.JToken)"> <summary> Replaces this token with the specified token. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToString"> <summary> Returns the indented JSON for this token. </summary> <returns> The indented JSON for this token. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToString(Microsoft.Identity.Json.Formatting,Microsoft.Identity.Json.JsonConverter[])"> <summary> Returns the JSON for this token using the given formatting and converters. </summary> <param name="formatting">Indicates how the output should be formatted.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>s which will be used when writing the token.</param> <returns>The JSON for this token using the given formatting and converters.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Boolean"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Boolean"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.DateTimeOffset"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.DateTimeOffset"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Boolean}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Int64"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.DateTime}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.DateTimeOffset}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Decimal}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Double}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Char}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Int32"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Int32"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Int16"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Int16"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.UInt16"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.UInt16"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Char"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Char"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Byte"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.SByte"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.SByte"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Int32}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> . </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Int16}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.UInt16}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Byte}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.SByte}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.DateTime"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Int64}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Single}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Decimal"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Decimal"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.UInt32}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.UInt64}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Double"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Double"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Single"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Single"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.String"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.String"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.UInt32"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.UInt32"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.UInt64"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.UInt64"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Byte[]"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>[]. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Guid"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.Guid}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> . </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.TimeSpan"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Nullable{System.TimeSpan}"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Explicit(Microsoft.Identity.Json.Linq.JToken)~System.Uri"> <summary> Performs an explicit conversion from <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to <see cref="T:System.Uri"/>. </summary> <param name="value">The value.</param> <returns>The result of the conversion.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Boolean)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Boolean"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.DateTimeOffset)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.DateTimeOffset"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Byte)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Byte"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Byte})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.SByte)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.SByte"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.SByte})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Boolean})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Int64)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTime})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTimeOffset})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Decimal})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Double})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Int16)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Int16"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.UInt16)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.UInt16"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Int32)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Int32"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int32})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.DateTime)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.DateTime"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int64})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Single})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Decimal)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Decimal"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int16})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt16})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt32})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt64})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Double)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Double"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Single)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Single"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.String)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.UInt32)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.UInt32"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.UInt64)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.UInt64"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Byte[])~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Byte"/>[] to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Uri)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Uri"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.TimeSpan)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.TimeSpan"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.TimeSpan})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Guid)~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Guid"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.op_Implicit(System.Nullable{System.Guid})~Microsoft.Identity.Json.Linq.JToken"> <summary> Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> to <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="value">The value to create a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> from.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> initialized with the specified value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.CreateReader"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.JsonReader"/> for this token. </summary> <returns>A <see cref="T:Microsoft.Identity.Json.JsonReader"/> that can be used to read this token and its descendants.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.FromObject(System.Object)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from an object. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the value of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.FromObject(System.Object,Microsoft.Identity.Json.JsonSerializer)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from an object using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <param name="o">The object that will be used to create <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="jsonSerializer">The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> that will be used when reading the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> with the value of the specified object.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToObject``1"> <summary> Creates an instance of the specified .NET type from the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <typeparam name="T">The object type that the token will be deserialized to.</typeparam> <returns>The new object created from the JSON value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToObject(System.Type)"> <summary> Creates an instance of the specified .NET type from the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="objectType">The object type that the token will be deserialized to.</param> <returns>The new object created from the JSON value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToObject``1(Microsoft.Identity.Json.JsonSerializer)"> <summary> Creates an instance of the specified .NET type from the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <typeparam name="T">The object type that the token will be deserialized to.</typeparam> <param name="jsonSerializer">The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> that will be used when creating the object.</param> <returns>The new object created from the JSON value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ToObject(System.Type,Microsoft.Identity.Json.JsonSerializer)"> <summary> Creates an instance of the specified .NET type from the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> using the specified <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <param name="objectType">The object type that the token will be deserialized to.</param> <param name="jsonSerializer">The <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> that will be used when creating the object.</param> <returns>The new object created from the JSON value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ReadFrom(Microsoft.Identity.Json.JsonReader)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <returns> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.ReadFrom(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">An <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Parse(System.String)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> populated from the string that contains JSON.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Parse(System.String,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a string that contains JSON. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> populated from the string that contains JSON.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Load(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Linq.JsonLoadSettings)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <param name="settings">The <see cref="T:Microsoft.Identity.Json.Linq.JsonLoadSettings"/> used to load the JSON. If this is <c>null</c>, default load settings will be used.</param> <returns> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Load(Microsoft.Identity.Json.JsonReader)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> from a <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">A <see cref="T:Microsoft.Identity.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</param> <returns> A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the token and its descendant tokens that were read from the reader. The runtime type of the token is determined by the token type of the first token encountered in the reader. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.SelectToken(System.String)"> <summary> Selects a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path. </summary> <param name="path"> A <see cref="T:System.String"/> that contains a JPath expression. </param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>, or <c>null</c>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.SelectToken(System.String,System.Boolean)"> <summary> Selects a <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path. </summary> <param name="path"> A <see cref="T:System.String"/> that contains a JPath expression. </param> <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.SelectTokens(System.String)"> <summary> Selects a collection of elements using a JPath expression. </summary> <param name="path"> A <see cref="T:System.String"/> that contains a JPath expression. </param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the selected elements.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)"> <summary> Selects a collection of elements using a JPath expression. </summary> <param name="path"> A <see cref="T:System.String"/> that contains a JPath expression. </param> <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> that contains the selected elements.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.GetMetaObject(System.Linq.Expressions.Expression)"> <summary> Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. </summary> <param name="parameter">The expression tree representation of the runtime value.</param> <returns> The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.System#Dynamic#IDynamicMetaObjectProvider#GetMetaObject(System.Linq.Expressions.Expression)"> <summary> Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. </summary> <param name="parameter">The expression tree representation of the runtime value.</param> <returns> The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.DeepClone"> <summary> Creates a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. All child tokens are recursively cloned. </summary> <returns>A new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.AddAnnotation(System.Object)"> <summary> Adds an object to the annotation list of this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="annotation">The annotation to add.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Annotation``1"> <summary> Get the first annotation object of the specified type from this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <typeparam name="T">The type of the annotation to retrieve.</typeparam> <returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Annotation(System.Type)"> <summary> Gets the first annotation object of the specified type from this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="type">The <see cref="P:Microsoft.Identity.Json.Linq.JToken.Type"/> of the annotation to retrieve.</param> <returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Annotations``1"> <summary> Gets a collection of annotations of the specified type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <typeparam name="T">The type of the annotations to retrieve.</typeparam> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the annotations for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.Annotations(System.Type)"> <summary> Gets a collection of annotations of the specified type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="type">The <see cref="P:Microsoft.Identity.Json.Linq.JToken.Type"/> of the annotations to retrieve.</param> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Object"/> that contains the annotations that match the specified type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.RemoveAnnotations``1"> <summary> Removes the annotations of the specified type from this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <typeparam name="T">The type of annotations to remove.</typeparam> </member> <member name="M:Microsoft.Identity.Json.Linq.JToken.RemoveAnnotations(System.Type)"> <summary> Removes the annotations of the specified type from this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <param name="type">The <see cref="P:Microsoft.Identity.Json.Linq.JToken.Type"/> of annotations to remove.</param> </member> <member name="T:Microsoft.Identity.Json.Linq.JTokenEqualityComparer"> <summary> Compares tokens to determine whether they are equal. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenEqualityComparer.Equals(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Linq.JToken)"> <summary> Determines whether the specified objects are equal. </summary> <param name="x">The first object of type <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to compare.</param> <param name="y">The second object of type <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to compare.</param> <returns> <c>true</c> if the specified objects are equal; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenEqualityComparer.GetHashCode(Microsoft.Identity.Json.Linq.JToken)"> <summary> Returns a hash code for the specified object. </summary> <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param> <returns>A hash code for the specified object.</returns> <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is <c>null</c>.</exception> </member> <member name="T:Microsoft.Identity.Json.Linq.JTokenReader"> <summary> Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JTokenReader.CurrentToken"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> at the reader's current position. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenReader.#ctor(Microsoft.Identity.Json.Linq.JToken)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JTokenReader"/> class. </summary> <param name="token">The token to read from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenReader.Read"> <summary> Reads the next JSON token from the underlying <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <returns> <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read. </returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JTokenReader.Path"> <summary> Gets the path of the current JSON token. </summary> </member> <member name="T:Microsoft.Identity.Json.Linq.JTokenType"> <summary> Specifies the type of token. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.None"> <summary> No token type has been set. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Object"> <summary> A JSON object. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Array"> <summary> A JSON array. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Constructor"> <summary> A JSON constructor. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Property"> <summary> A JSON object property. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Comment"> <summary> A comment. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Integer"> <summary> An integer value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Float"> <summary> A float value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.String"> <summary> A string value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Boolean"> <summary> A boolean value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Null"> <summary> A null value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Undefined"> <summary> An undefined value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Date"> <summary> A date value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Raw"> <summary> A raw JSON value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Bytes"> <summary> A collection of bytes value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Guid"> <summary> A Guid value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.Uri"> <summary> A Uri value. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.JTokenType.TimeSpan"> <summary> A TimeSpan value. </summary> </member> <member name="T:Microsoft.Identity.Json.Linq.JTokenWriter"> <summary> Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JTokenWriter.CurrentToken"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> at the writer's current position. </summary> </member> <member name="P:Microsoft.Identity.Json.Linq.JTokenWriter.Token"> <summary> Gets the token being written. </summary> <value>The token being written.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.#ctor(Microsoft.Identity.Json.Linq.JContainer)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JTokenWriter"/> class writing to the given <see cref="T:Microsoft.Identity.Json.Linq.JContainer"/>. </summary> <param name="container">The container being written to.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JTokenWriter"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.Flush"> <summary> Flushes whatever is in the buffer to the underlying <see cref="T:Microsoft.Identity.Json.Linq.JContainer"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.Close"> <summary> Closes this writer. If <see cref="P:Microsoft.Identity.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed. </summary> <remarks> Setting <see cref="P:Microsoft.Identity.Json.JsonWriter.CloseOutput"/> to <c>true</c> has no additional effect, since the underlying <see cref="T:Microsoft.Identity.Json.Linq.JContainer"/> is a type that cannot be closed. </remarks> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteStartObject"> <summary> Writes the beginning of a JSON object. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteStartArray"> <summary> Writes the beginning of a JSON array. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteStartConstructor(System.String)"> <summary> Writes the start of a constructor with the given name. </summary> <param name="name">The name of the constructor.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteEnd(Microsoft.Identity.Json.JsonToken)"> <summary> Writes the end. </summary> <param name="token">The token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WritePropertyName(System.String)"> <summary> Writes the property name of a name/value pair on a JSON object. </summary> <param name="name">The name of the property.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Object)"> <summary> Writes a <see cref="T:System.Object"/> value. An error will be raised if the value cannot be written as a single JSON token. </summary> <param name="value">The <see cref="T:System.Object"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteNull"> <summary> Writes a null value. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteUndefined"> <summary> Writes an undefined value. </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteRaw(System.String)"> <summary> Writes raw JSON. </summary> <param name="json">The raw JSON to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteComment(System.String)"> <summary> Writes a comment <c>/*...*/</c> containing the specified text. </summary> <param name="text">Text to place inside the comment.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.String)"> <summary> Writes a <see cref="T:System.String"/> value. </summary> <param name="value">The <see cref="T:System.String"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Int32)"> <summary> Writes a <see cref="T:System.Int32"/> value. </summary> <param name="value">The <see cref="T:System.Int32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.UInt32)"> <summary> Writes a <see cref="T:System.UInt32"/> value. </summary> <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Int64)"> <summary> Writes a <see cref="T:System.Int64"/> value. </summary> <param name="value">The <see cref="T:System.Int64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.UInt64)"> <summary> Writes a <see cref="T:System.UInt64"/> value. </summary> <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Single)"> <summary> Writes a <see cref="T:System.Single"/> value. </summary> <param name="value">The <see cref="T:System.Single"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Double)"> <summary> Writes a <see cref="T:System.Double"/> value. </summary> <param name="value">The <see cref="T:System.Double"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Boolean)"> <summary> Writes a <see cref="T:System.Boolean"/> value. </summary> <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Int16)"> <summary> Writes a <see cref="T:System.Int16"/> value. </summary> <param name="value">The <see cref="T:System.Int16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.UInt16)"> <summary> Writes a <see cref="T:System.UInt16"/> value. </summary> <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Char)"> <summary> Writes a <see cref="T:System.Char"/> value. </summary> <param name="value">The <see cref="T:System.Char"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Byte)"> <summary> Writes a <see cref="T:System.Byte"/> value. </summary> <param name="value">The <see cref="T:System.Byte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.SByte)"> <summary> Writes a <see cref="T:System.SByte"/> value. </summary> <param name="value">The <see cref="T:System.SByte"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Decimal)"> <summary> Writes a <see cref="T:System.Decimal"/> value. </summary> <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.DateTime)"> <summary> Writes a <see cref="T:System.DateTime"/> value. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.DateTimeOffset)"> <summary> Writes a <see cref="T:System.DateTimeOffset"/> value. </summary> <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Byte[])"> <summary> Writes a <see cref="T:System.Byte"/>[] value. </summary> <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.TimeSpan)"> <summary> Writes a <see cref="T:System.TimeSpan"/> value. </summary> <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Guid)"> <summary> Writes a <see cref="T:System.Guid"/> value. </summary> <param name="value">The <see cref="T:System.Guid"/> value to write.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JTokenWriter.WriteValue(System.Uri)"> <summary> Writes a <see cref="T:System.Uri"/> value. </summary> <param name="value">The <see cref="T:System.Uri"/> value to write.</param> </member> <member name="T:Microsoft.Identity.Json.Linq.JValue"> <summary> Represents a value in JSON (string, integer, date, etc). </summary> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.WriteToAsync(Microsoft.Identity.Json.JsonWriter,System.Threading.CancellationToken,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> asynchronously. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="cancellationToken">The token to monitor for cancellation requests.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/> which will be used when writing the token.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(Microsoft.Identity.Json.Linq.JValue)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class from another <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> object. </summary> <param name="other">A <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> object to copy from.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Int64)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Decimal)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Char)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.UInt64)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Double)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Single)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.DateTime)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.DateTimeOffset)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Guid)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Uri)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.#ctor(System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> class with the given value. </summary> <param name="value">The value.</param> </member> <member name="P:Microsoft.Identity.Json.Linq.JValue.HasValues"> <summary> Gets a value indicating whether this token has child tokens. </summary> <value> <c>true</c> if this token has child values; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.CreateComment(System.String)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> comment with the given value. </summary> <param name="value">The value.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> comment with the given value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.CreateString(System.String)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> string with the given value. </summary> <param name="value">The value.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> string with the given value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.CreateNull"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> null value. </summary> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> null value.</returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.CreateUndefined"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> undefined value. </summary> <returns>A <see cref="T:Microsoft.Identity.Json.Linq.JValue"/> undefined value.</returns> </member> <member name="P:Microsoft.Identity.Json.Linq.JValue.Type"> <summary> Gets the node type for this <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </summary> <value>The type.</value> </member> <member name="P:Microsoft.Identity.Json.Linq.JValue.Value"> <summary> Gets or sets the underlying token value. </summary> <value>The underlying token value.</value> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.JsonConverter[])"> <summary> Writes this token to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="converters">A collection of <see cref="T:Microsoft.Identity.Json.JsonConverter"/>s which will be used when writing the token.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.Equals(Microsoft.Identity.Json.Linq.JValue)"> <summary> Indicates whether the current object is equal to another object of the same type. </summary> <returns> <c>true</c> if the current object is equal to the <paramref name="other"/> parameter; otherwise, <c>false</c>. </returns> <param name="other">An object to compare with this object.</param> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>. </summary> <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.GetHashCode"> <summary> Serves as a hash function for a particular type. </summary> <returns> A hash code for the current <see cref="T:System.Object"/>. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.ToString"> <summary> Returns a <see cref="T:System.String"/> that represents this instance. </summary> <returns> A <see cref="T:System.String"/> that represents this instance. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.ToString(System.String)"> <summary> Returns a <see cref="T:System.String"/> that represents this instance. </summary> <param name="format">The format.</param> <returns> A <see cref="T:System.String"/> that represents this instance. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.ToString(System.IFormatProvider)"> <summary> Returns a <see cref="T:System.String"/> that represents this instance. </summary> <param name="formatProvider">The format provider.</param> <returns> A <see cref="T:System.String"/> that represents this instance. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.ToString(System.String,System.IFormatProvider)"> <summary> Returns a <see cref="T:System.String"/> that represents this instance. </summary> <param name="format">The format.</param> <param name="formatProvider">The format provider.</param> <returns> A <see cref="T:System.String"/> that represents this instance. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.GetMetaObject(System.Linq.Expressions.Expression)"> <summary> Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. </summary> <param name="parameter">The expression tree representation of the runtime value.</param> <returns> The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. </returns> </member> <member name="M:Microsoft.Identity.Json.Linq.JValue.CompareTo(Microsoft.Identity.Json.Linq.JValue)"> <summary> Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. </summary> <param name="obj">An object to compare with this instance.</param> <returns> A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance is less than <paramref name="obj"/>. Zero This instance is equal to <paramref name="obj"/>. Greater than zero This instance is greater than <paramref name="obj"/>. </returns> <exception cref="T:System.ArgumentException"> <paramref name="obj"/> is not of the same type as this instance. </exception> </member> <member name="T:Microsoft.Identity.Json.Linq.LineInfoHandling"> <summary> Specifies how line information is handled when loading JSON. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.LineInfoHandling.Ignore"> <summary> Ignore line information. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.LineInfoHandling.Load"> <summary> Load line information. </summary> </member> <member name="T:Microsoft.Identity.Json.Linq.MergeArrayHandling"> <summary> Specifies how JSON arrays are merged together. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeArrayHandling.Concat"> <summary>Concatenate arrays.</summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeArrayHandling.Union"> <summary>Union arrays, skipping items that already exist.</summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeArrayHandling.Replace"> <summary>Replace all array items.</summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeArrayHandling.Merge"> <summary>Merge array items together, matched by index.</summary> </member> <member name="T:Microsoft.Identity.Json.Linq.MergeNullValueHandling"> <summary> Specifies how null value properties are merged. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeNullValueHandling.Ignore"> <summary> The content's null value properties will be ignored during merging. </summary> </member> <member name="F:Microsoft.Identity.Json.Linq.MergeNullValueHandling.Merge"> <summary> The content's null value properties will be merged. </summary> </member> <member name="T:Microsoft.Identity.Json.MemberSerialization"> <summary> Specifies the member serialization options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.MemberSerialization.OptOut"> <summary> All public members are serialized by default. Members can be excluded using <see cref="T:Microsoft.Identity.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>. This is the default member serialization mode. </summary> </member> <member name="F:Microsoft.Identity.Json.MemberSerialization.OptIn"> <summary> Only members marked with <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/> or <see cref="T:System.Runtime.Serialization.DataMemberAttribute"/> are serialized. This member serialization mode can also be set by marking the class with <see cref="T:System.Runtime.Serialization.DataContractAttribute"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.MemberSerialization.Fields"> <summary> All public and private fields are serialized. Members can be excluded using <see cref="T:Microsoft.Identity.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>. This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/> and setting IgnoreSerializableAttribute on <see cref="T:Microsoft.Identity.Json.Serialization.DefaultContractResolver"/> to <c>false</c>. </summary> </member> <member name="T:Microsoft.Identity.Json.MetadataPropertyHandling"> <summary> Specifies metadata property handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.MetadataPropertyHandling.Default"> <summary> Read metadata properties located at the start of a JSON object. </summary> </member> <member name="F:Microsoft.Identity.Json.MetadataPropertyHandling.ReadAhead"> <summary> Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. </summary> </member> <member name="F:Microsoft.Identity.Json.MetadataPropertyHandling.Ignore"> <summary> Do not try to read metadata properties. </summary> </member> <member name="T:Microsoft.Identity.Json.MissingMemberHandling"> <summary> Specifies missing member handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.MissingMemberHandling.Ignore"> <summary> Ignore a missing member and do not attempt to deserialize it. </summary> </member> <member name="F:Microsoft.Identity.Json.MissingMemberHandling.Error"> <summary> Throw a <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> when a missing member is encountered during deserialization. </summary> </member> <member name="T:Microsoft.Identity.Json.NullValueHandling"> <summary> Specifies null value handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingObject" title="NullValueHandling Class" /> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingExample" title="NullValueHandling Ignore Example" /> </example> </member> <member name="F:Microsoft.Identity.Json.NullValueHandling.Include"> <summary> Include null values when serializing and deserializing objects. </summary> </member> <member name="F:Microsoft.Identity.Json.NullValueHandling.Ignore"> <summary> Ignore null values when serializing and deserializing objects. </summary> </member> <member name="T:Microsoft.Identity.Json.ObjectCreationHandling"> <summary> Specifies how object creation is handled by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.ObjectCreationHandling.Auto"> <summary> Reuse existing objects, create new objects when needed. </summary> </member> <member name="F:Microsoft.Identity.Json.ObjectCreationHandling.Reuse"> <summary> Only reuse existing objects. </summary> </member> <member name="F:Microsoft.Identity.Json.ObjectCreationHandling.Replace"> <summary> Always create new objects. </summary> </member> <member name="T:Microsoft.Identity.Json.PreserveReferencesHandling"> <summary> Specifies reference handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement <see cref="T:System.Runtime.Serialization.ISerializable"/>. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References" /> </example> </member> <member name="F:Microsoft.Identity.Json.PreserveReferencesHandling.None"> <summary> Do not preserve references when serializing types. </summary> </member> <member name="F:Microsoft.Identity.Json.PreserveReferencesHandling.Objects"> <summary> Preserve references when serializing into a JSON object structure. </summary> </member> <member name="F:Microsoft.Identity.Json.PreserveReferencesHandling.Arrays"> <summary> Preserve references when serializing into a JSON array structure. </summary> </member> <member name="F:Microsoft.Identity.Json.PreserveReferencesHandling.All"> <summary> Preserve references when serializing. </summary> </member> <member name="T:Microsoft.Identity.Json.ReferenceLoopHandling"> <summary> Specifies reference loop handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.ReferenceLoopHandling.Error"> <summary> Throw a <see cref="T:Microsoft.Identity.Json.JsonSerializationException"/> when a loop is encountered. </summary> </member> <member name="F:Microsoft.Identity.Json.ReferenceLoopHandling.Ignore"> <summary> Ignore loop references and do not serialize. </summary> </member> <member name="F:Microsoft.Identity.Json.ReferenceLoopHandling.Serialize"> <summary> Serialize loop references. </summary> </member> <member name="T:Microsoft.Identity.Json.Required"> <summary> Indicating whether a property is required. </summary> </member> <member name="F:Microsoft.Identity.Json.Required.Default"> <summary> The property is not required. The default state. </summary> </member> <member name="F:Microsoft.Identity.Json.Required.AllowNull"> <summary> The property must be defined in JSON but can be a null value. </summary> </member> <member name="F:Microsoft.Identity.Json.Required.Always"> <summary> The property must be defined in JSON and cannot be a null value. </summary> </member> <member name="F:Microsoft.Identity.Json.Required.DisallowNull"> <summary> The property is not required but it cannot be a null value. </summary> </member> <member name="T:Microsoft.Identity.Json.Schema.Extensions"> <summary> <para> Contains the JSON schema extension methods. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="M:Microsoft.Identity.Json.Schema.Extensions.IsValid(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Schema.JsonSchema)"> <summary> <para> Determines whether the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> is valid. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> <param name="source">The source <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to test.</param> <param name="schema">The schema to test with.</param> <returns> <c>true</c> if the specified <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Schema.Extensions.IsValid(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Schema.JsonSchema,System.Collections.Generic.IList{System.String}@)"> <summary> <para> Determines whether the <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> is valid. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> <param name="source">The source <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to test.</param> <param name="schema">The schema to test with.</param> <param name="errorMessages">When this method returns, contains any error messages generated while validating. </param> <returns> <c>true</c> if the specified <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Schema.Extensions.Validate(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Schema.JsonSchema)"> <summary> <para> Validates the specified <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> <param name="source">The source <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to test.</param> <param name="schema">The schema to test with.</param> </member> <member name="M:Microsoft.Identity.Json.Schema.Extensions.Validate(Microsoft.Identity.Json.Linq.JToken,Microsoft.Identity.Json.Schema.JsonSchema,Microsoft.Identity.Json.Schema.ValidationEventHandler)"> <summary> <para> Validates the specified <see cref="T:Microsoft.Identity.Json.Linq.JToken"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> <param name="source">The source <see cref="T:Microsoft.Identity.Json.Linq.JToken"/> to test.</param> <param name="schema">The schema to test with.</param> <param name="validationEventHandler">The validation event handler.</param> </member> <member name="T:Microsoft.Identity.Json.Schema.JsonSchema"> <summary> <para> An in-memory representation of a JSON Schema. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Id"> <summary> Gets or sets the id. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Title"> <summary> Gets or sets the title. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Required"> <summary> Gets or sets whether the object is required. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.ReadOnly"> <summary> Gets or sets whether the object is read-only. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Hidden"> <summary> Gets or sets whether the object is visible to users. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Transient"> <summary> Gets or sets whether the object is transient. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Description"> <summary> Gets or sets the description of the object. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Type"> <summary> Gets or sets the types of values allowed by the object. </summary> <value>The type.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Pattern"> <summary> Gets or sets the pattern. </summary> <value>The pattern.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.MinimumLength"> <summary> Gets or sets the minimum length. </summary> <value>The minimum length.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.MaximumLength"> <summary> Gets or sets the maximum length. </summary> <value>The maximum length.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.DivisibleBy"> <summary> Gets or sets a number that the value should be divisible by. </summary> <value>A number that the value should be divisible by.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Minimum"> <summary> Gets or sets the minimum. </summary> <value>The minimum.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Maximum"> <summary> Gets or sets the maximum. </summary> <value>The maximum.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.ExclusiveMinimum"> <summary> Gets or sets a flag indicating whether the value can not equal the number defined by the <c>minimum</c> attribute (<see cref="P:Microsoft.Identity.Json.Schema.JsonSchema.Minimum"/>). </summary> <value>A flag indicating whether the value can not equal the number defined by the <c>minimum</c> attribute (<see cref="P:Microsoft.Identity.Json.Schema.JsonSchema.Minimum"/>).</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.ExclusiveMaximum"> <summary> Gets or sets a flag indicating whether the value can not equal the number defined by the <c>maximum</c> attribute (<see cref="P:Microsoft.Identity.Json.Schema.JsonSchema.Maximum"/>). </summary> <value>A flag indicating whether the value can not equal the number defined by the <c>maximum</c> attribute (<see cref="P:Microsoft.Identity.Json.Schema.JsonSchema.Maximum"/>).</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.MinimumItems"> <summary> Gets or sets the minimum number of items. </summary> <value>The minimum number of items.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.MaximumItems"> <summary> Gets or sets the maximum number of items. </summary> <value>The maximum number of items.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Items"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of items. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of items.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.PositionalItemsValidation"> <summary> Gets or sets a value indicating whether items in an array are validated using the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> instance at their array position from <see cref="P:Microsoft.Identity.Json.Schema.JsonSchema.Items"/>. </summary> <value> <c>true</c> if items are validated using their array position; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.AdditionalItems"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of additional items. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of additional items.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.AllowAdditionalItems"> <summary> Gets or sets a value indicating whether additional items are allowed. </summary> <value> <c>true</c> if additional items are allowed; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.UniqueItems"> <summary> Gets or sets whether the array items must be unique. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Properties"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of properties. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of properties.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.AdditionalProperties"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of additional properties. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> of additional properties.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.PatternProperties"> <summary> Gets or sets the pattern properties. </summary> <value>The pattern properties.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.AllowAdditionalProperties"> <summary> Gets or sets a value indicating whether additional properties are allowed. </summary> <value> <c>true</c> if additional properties are allowed; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Requires"> <summary> Gets or sets the required property if this property is present. </summary> <value>The required property if this property is present.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Enum"> <summary> Gets or sets the a collection of valid enum values allowed. </summary> <value>A collection of valid enum values allowed.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Disallow"> <summary> Gets or sets disallowed types. </summary> <value>The disallowed types.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Default"> <summary> Gets or sets the default value. </summary> <value>The default value.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Extends"> <summary> Gets or sets the collection of <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> that this schema extends. </summary> <value>The collection of <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> that this schema extends.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchema.Format"> <summary> Gets or sets the format. </summary> <value>The format.</value> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.Read(Microsoft.Identity.Json.JsonReader)"> <summary> Reads a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> containing the JSON Schema to read.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.Read(Microsoft.Identity.Json.JsonReader,Microsoft.Identity.Json.Schema.JsonSchemaResolver)"> <summary> Reads a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified <see cref="T:Microsoft.Identity.Json.JsonReader"/>. </summary> <param name="reader">The <see cref="T:Microsoft.Identity.Json.JsonReader"/> containing the JSON Schema to read.</param> <param name="resolver">The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/> to use when resolving schema references.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.Parse(System.String)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from a string that contains JSON Schema. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON Schema.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> populated from the string that contains JSON Schema.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.Parse(System.String,Microsoft.Identity.Json.Schema.JsonSchemaResolver)"> <summary> Load a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from a string that contains JSON Schema using the specified <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/>. </summary> <param name="json">A <see cref="T:System.String"/> that contains JSON Schema.</param> <param name="resolver">The resolver.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> populated from the string that contains JSON Schema.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.WriteTo(Microsoft.Identity.Json.JsonWriter)"> <summary> Writes this schema to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.WriteTo(Microsoft.Identity.Json.JsonWriter,Microsoft.Identity.Json.Schema.JsonSchemaResolver)"> <summary> Writes this schema to a <see cref="T:Microsoft.Identity.Json.JsonWriter"/> using the specified <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/>. </summary> <param name="writer">A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> into which this method will write.</param> <param name="resolver">The resolver used.</param> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchema.ToString"> <summary> Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. </summary> <returns> A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. </returns> </member> <member name="T:Microsoft.Identity.Json.Schema.JsonSchemaException"> <summary> <para> Returns detailed information about the schema exception. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaException.LineNumber"> <summary> Gets the line number indicating where the error occurred. </summary> <value>The line number indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaException.LinePosition"> <summary> Gets the line position indicating where the error occurred. </summary> <value>The line position indicating where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaException.Path"> <summary> Gets the path to the JSON where the error occurred. </summary> <value>The path to the JSON where the error occurred.</value> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaException"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaException"/> class. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> </member> <member name="T:Microsoft.Identity.Json.Schema.JsonSchemaGenerator"> <summary> <para> Generates a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.UndefinedSchemaIdHandling"> <summary> Gets or sets how undefined schemas are handled by the serializer. </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.ContractResolver"> <summary> Gets or sets the contract resolver. </summary> <value>The contract resolver.</value> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.Generate(System.Type)"> <summary> Generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified type. </summary> <param name="type">The type to generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> generated from the specified type.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Microsoft.Identity.Json.Schema.JsonSchemaResolver)"> <summary> Generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified type. </summary> <param name="type">The type to generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from.</param> <param name="resolver">The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> generated from the specified type.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.Generate(System.Type,System.Boolean)"> <summary> Generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified type. </summary> <param name="type">The type to generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from.</param> <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> will be nullable.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> generated from the specified type.</returns> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Microsoft.Identity.Json.Schema.JsonSchemaResolver,System.Boolean)"> <summary> Generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from the specified type. </summary> <param name="type">The type to generate a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from.</param> <param name="resolver">The <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param> <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> will be nullable.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> generated from the specified type.</returns> </member> <member name="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"> <summary> <para> Resolves <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> from an id. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.JsonSchemaResolver.LoadedSchemas"> <summary> Gets or sets the loaded schemas. </summary> <value>The loaded schemas.</value> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaResolver.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaResolver"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Schema.JsonSchemaResolver.GetSchema(System.String)"> <summary> Gets a <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> for the specified reference. </summary> <param name="reference">The id.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/> for the specified reference.</returns> </member> <member name="T:Microsoft.Identity.Json.Schema.JsonSchemaType"> <summary> <para> The value types allowed by the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchema"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.None"> <summary> No type specified. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.String"> <summary> String type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Float"> <summary> Float type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Integer"> <summary> Integer type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Boolean"> <summary> Boolean type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Object"> <summary> Object type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Array"> <summary> Array type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Null"> <summary> Null type. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.JsonSchemaType.Any"> <summary> Any type. </summary> </member> <member name="T:Microsoft.Identity.Json.Schema.UndefinedSchemaIdHandling"> <summary> <para> Specifies undefined schema Id handling options for the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaGenerator"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.UndefinedSchemaIdHandling.None"> <summary> Do not infer a schema Id. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.UndefinedSchemaIdHandling.UseTypeName"> <summary> Use the .NET type name as the schema Id. </summary> </member> <member name="F:Microsoft.Identity.Json.Schema.UndefinedSchemaIdHandling.UseAssemblyQualifiedName"> <summary> Use the assembly qualified .NET type name as the schema Id. </summary> </member> <member name="T:Microsoft.Identity.Json.Schema.ValidationEventArgs"> <summary> <para> Returns detailed information related to the <see cref="T:Microsoft.Identity.Json.Schema.ValidationEventHandler"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="P:Microsoft.Identity.Json.Schema.ValidationEventArgs.Exception"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Schema.JsonSchemaException"/> associated with the validation error. </summary> <value>The JsonSchemaException associated with the validation error.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.ValidationEventArgs.Path"> <summary> Gets the path of the JSON location where the validation error occurred. </summary> <value>The path of the JSON location where the validation error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.Schema.ValidationEventArgs.Message"> <summary> Gets the text description corresponding to the validation error. </summary> <value>The text description.</value> </member> <member name="T:Microsoft.Identity.Json.Schema.ValidationEventHandler"> <summary> <para> Represents the callback method that will handle JSON schema validation events and the <see cref="T:Microsoft.Identity.Json.Schema.ValidationEventArgs"/>. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details. </note> </summary> </member> <member name="T:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy"> <summary> A camel case naming strategy. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy"/> class. </summary> <param name="processDictionaryKeys"> A flag indicating whether dictionary keys should be processed. </param> <param name="overrideSpecifiedNames"> A flag indicating whether explicitly specified property names should be processed, e.g. a property name customized with a <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/>. </param> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy"/> class. </summary> <param name="processDictionaryKeys"> A flag indicating whether dictionary keys should be processed. </param> <param name="overrideSpecifiedNames"> A flag indicating whether explicitly specified property names should be processed, e.g. a property name customized with a <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/>. </param> <param name="processExtensionDataNames"> A flag indicating whether extension data names should be processed. </param> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCaseNamingStrategy.ResolvePropertyName(System.String)"> <summary> Resolves the specified property name. </summary> <param name="name">The property name to resolve.</param> <returns>The resolved property name.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.CamelCasePropertyNamesContractResolver"> <summary> Resolves member mappings for a type, camel casing property names. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCasePropertyNamesContractResolver.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.CamelCasePropertyNamesContractResolver"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.CamelCasePropertyNamesContractResolver.ResolveContract(System.Type)"> <summary> Resolves the contract for a given type. </summary> <param name="type">The type to resolve a contract for.</param> <returns>The contract for a given type.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.DefaultContractResolver"> <summary> Used by <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to resolve a <see cref="T:Microsoft.Identity.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.DynamicCodeGeneration"> <summary> Gets a value indicating whether members are being get and set using dynamic code generation. This value is determined by the runtime permissions available. </summary> <value> <c>true</c> if using dynamic code generation; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.DefaultMembersSearchFlags"> <summary> Gets or sets the default members search flags. </summary> <value>The default members search flags.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.SerializeCompilerGeneratedMembers"> <summary> Gets or sets a value indicating whether compiler generated members should be serialized. </summary> <value> <c>true</c> if serialized compiler generated members; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface"> <summary> Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types. </summary> <value> <c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute"> <summary> Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types. </summary> <value> <c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.IgnoreIsSpecifiedMembers"> <summary> Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. </summary> <value> <c>true</c> if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.IgnoreShouldSerializeMembers"> <summary> Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. </summary> <value> <c>true</c> if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.DefaultContractResolver.NamingStrategy"> <summary> Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. </summary> <value>The naming strategy used to resolve how property names and dictionary keys are serialized.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.DefaultContractResolver"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolveContract(System.Type)"> <summary> Resolves the contract for a given type. </summary> <param name="type">The type to resolve a contract for.</param> <returns>The contract for a given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.GetSerializableMembers(System.Type)"> <summary> Gets the serializable members for the type. </summary> <param name="objectType">The type to get serializable members for.</param> <returns>The serializable members for the type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateObjectContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonObjectContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonObjectContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateConstructorParameters(System.Reflection.ConstructorInfo,Microsoft.Identity.Json.Serialization.JsonPropertyCollection)"> <summary> Creates the constructor parameters. </summary> <param name="constructor">The constructor to create properties for.</param> <param name="memberProperties">The type's member properties.</param> <returns>Properties for the given <see cref="T:System.Reflection.ConstructorInfo"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreatePropertyFromConstructorParameter(Microsoft.Identity.Json.Serialization.JsonProperty,System.Reflection.ParameterInfo)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>. </summary> <param name="matchingMemberProperty">The matching member property.</param> <param name="parameterInfo">The constructor parameter.</param> <returns>A created <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolveContractConverter(System.Type)"> <summary> Resolves the default <see cref="T:Microsoft.Identity.Json.JsonConverter" /> for the contract. </summary> <param name="objectType">Type of the object.</param> <returns>The contract's default <see cref="T:Microsoft.Identity.Json.JsonConverter" />.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateDictionaryContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonDictionaryContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonDictionaryContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateArrayContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonArrayContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonArrayContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreatePrimitiveContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonPrimitiveContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonPrimitiveContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateLinqContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonLinqContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonLinqContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonISerializableContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonISerializableContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonDynamicContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonDynamicContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateStringContract(System.Type)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonStringContract"/> for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonStringContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateContract(System.Type)"> <summary> Determines which contract type is created for the given type. </summary> <param name="objectType">Type of the object.</param> <returns>A <see cref="T:Microsoft.Identity.Json.Serialization.JsonContract"/> for the given type.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateProperties(System.Type,Microsoft.Identity.Json.MemberSerialization)"> <summary> Creates properties for the given <see cref="T:Microsoft.Identity.Json.Serialization.JsonContract"/>. </summary> <param name="type">The type to create properties for.</param> /// <param name="memberSerialization">The member serialization mode for the type.</param> <returns>Properties for the given <see cref="T:Microsoft.Identity.Json.Serialization.JsonContract"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateMemberValueProvider(System.Reflection.MemberInfo)"> <summary> Creates the <see cref="T:Microsoft.Identity.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member. </summary> <param name="member">The member.</param> <returns>The <see cref="T:Microsoft.Identity.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.CreateProperty(System.Reflection.MemberInfo,Microsoft.Identity.Json.MemberSerialization)"> <summary> Creates a <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>. </summary> <param name="memberSerialization">The member's parent <see cref="T:Microsoft.Identity.Json.MemberSerialization"/>.</param> <param name="member">The member to create a <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> for.</param> <returns>A created <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)"> <summary> Resolves the name of the property. </summary> <param name="propertyName">Name of the property.</param> <returns>Resolved name of the property.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolveExtensionDataName(System.String)"> <summary> Resolves the name of the extension data. By default no changes are made to extension data names. </summary> <param name="extensionDataName">Name of the extension data.</param> <returns>Resolved name of the extension data.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolveDictionaryKey(System.String)"> <summary> Resolves the key of the dictionary. By default <see cref="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)"/> is used to resolve dictionary keys. </summary> <param name="dictionaryKey">Key of the dictionary.</param> <returns>Resolved key of the dictionary.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultContractResolver.GetResolvedPropertyName(System.String)"> <summary> Gets the resolved name of the property. </summary> <param name="propertyName">Name of the property.</param> <returns>Name of the property.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.DefaultNamingStrategy"> <summary> The default naming strategy. Property names and dictionary keys are unchanged. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultNamingStrategy.ResolvePropertyName(System.String)"> <summary> Resolves the specified property name. </summary> <param name="name">The property name to resolve.</param> <returns>The resolved property name.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.DefaultSerializationBinder"> <summary> The default serialization binder used when resolving and loading classes from type names. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultSerializationBinder.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.DefaultSerializationBinder"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultSerializationBinder.BindToType(System.String,System.String)"> <summary> When overridden in a derived class, controls the binding of a serialized object to a type. </summary> <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param> <returns> The type of the object the formatter creates a new instance of. </returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.DefaultSerializationBinder.BindToName(System.Type,System.String@,System.String@)"> <summary> When overridden in a derived class, controls the binding of a serialized object to a type. </summary> <param name="serializedType">The type of the object the formatter creates a new instance of.</param> <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.DiagnosticsTraceWriter"> <summary> Represents a trace writer that writes to the application's <see cref="T:System.Diagnostics.TraceListener"/> instances. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.DiagnosticsTraceWriter.LevelFilter"> <summary> Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>, <see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages. </summary> <value> The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. </value> </member> <member name="M:Microsoft.Identity.Json.Serialization.DiagnosticsTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> <summary> Writes the specified trace level, message and optional exception. </summary> <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> <param name="message">The trace message.</param> <param name="ex">The trace exception. This parameter is optional.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.DynamicValueProvider"> <summary> Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.DynamicValueProvider.#ctor(System.Reflection.MemberInfo)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.DynamicValueProvider"/> class. </summary> <param name="memberInfo">The member info.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.DynamicValueProvider.SetValue(System.Object,System.Object)"> <summary> Sets the value. </summary> <param name="target">The target to set the value on.</param> <param name="value">The value to set on the target.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.DynamicValueProvider.GetValue(System.Object)"> <summary> Gets the value. </summary> <param name="target">The target to get the value from.</param> <returns>The value.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.ErrorContext"> <summary> Provides information surrounding an error. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorContext.Error"> <summary> Gets the error. </summary> <value>The error.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorContext.OriginalObject"> <summary> Gets the original object that caused the error. </summary> <value>The original object that caused the error.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorContext.Member"> <summary> Gets the member that caused the error. </summary> <value>The member that caused the error.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorContext.Path"> <summary> Gets the path of the JSON location where the error occurred. </summary> <value>The path of the JSON location where the error occurred.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorContext.Handled"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.ErrorContext"/> is handled. </summary> <value><c>true</c> if handled; otherwise, <c>false</c>.</value> </member> <member name="T:Microsoft.Identity.Json.Serialization.ErrorEventArgs"> <summary> Provides data for the Error event. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorEventArgs.CurrentObject"> <summary> Gets the current object the error event is being raised against. </summary> <value>The current object the error event is being raised against.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.ErrorEventArgs.ErrorContext"> <summary> Gets the error context. </summary> <value>The error context.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.ErrorEventArgs.#ctor(System.Object,Microsoft.Identity.Json.Serialization.ErrorContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.ErrorEventArgs"/> class. </summary> <param name="currentObject">The current object.</param> <param name="errorContext">The error context.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.ExpressionValueProvider"> <summary> Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.ExpressionValueProvider.#ctor(System.Reflection.MemberInfo)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.ExpressionValueProvider"/> class. </summary> <param name="memberInfo">The member info.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.ExpressionValueProvider.SetValue(System.Object,System.Object)"> <summary> Sets the value. </summary> <param name="target">The target to set the value on.</param> <param name="value">The value to set on the target.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.ExpressionValueProvider.GetValue(System.Object)"> <summary> Gets the value. </summary> <param name="target">The target to get the value from.</param> <returns>The value.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.IAttributeProvider"> <summary> Provides methods to get attributes. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.IAttributeProvider.GetAttributes(System.Boolean)"> <summary> Returns a collection of all of the attributes, or an empty collection if there are no attributes. </summary> <param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param> <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.IAttributeProvider.GetAttributes(System.Type,System.Boolean)"> <summary> Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. </summary> <param name="attributeType">The type of the attributes.</param> <param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param> <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.IContractResolver"> <summary> Used by <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> to resolve a <see cref="T:Microsoft.Identity.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>. </summary> <example> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class" /> <code lang="cs" source="..\Src\Microsoft.Identity.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverExample" title="IContractResolver Example" /> </example> </member> <member name="M:Microsoft.Identity.Json.Serialization.IContractResolver.ResolveContract(System.Type)"> <summary> Resolves the contract for a given type. </summary> <param name="type">The type to resolve a contract for.</param> <returns>The contract for a given type.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.IReferenceResolver"> <summary> Used to resolve references when serializing and deserializing JSON by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.IReferenceResolver.ResolveReference(System.Object,System.String)"> <summary> Resolves a reference to its object. </summary> <param name="context">The serialization context.</param> <param name="reference">The reference to resolve.</param> <returns>The object that was resolved from the reference.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.IReferenceResolver.GetReference(System.Object,System.Object)"> <summary> Gets the reference for the specified object. </summary> <param name="context">The serialization context.</param> <param name="value">The object to get a reference for.</param> <returns>The reference to the object.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.IReferenceResolver.IsReferenced(System.Object,System.Object)"> <summary> Determines whether the specified object is referenced. </summary> <param name="context">The serialization context.</param> <param name="value">The object to test for a reference.</param> <returns> <c>true</c> if the specified object is referenced; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.IReferenceResolver.AddReference(System.Object,System.String,System.Object)"> <summary> Adds a reference to the specified object. </summary> <param name="context">The serialization context.</param> <param name="reference">The reference.</param> <param name="value">The object to reference.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.ISerializationBinder"> <summary> Allows users to control class loading and mandate what class to load. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.ISerializationBinder.BindToType(System.String,System.String)"> <summary> When implemented, controls the binding of a serialized object to a type. </summary> <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object</param> <returns>The type of the object the formatter creates a new instance of.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.ISerializationBinder.BindToName(System.Type,System.String@,System.String@)"> <summary> When implemented, controls the binding of a serialized object to a type. </summary> <param name="serializedType">The type of the object the formatter creates a new instance of.</param> <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.ITraceWriter"> <summary> Represents a trace writer. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.ITraceWriter.LevelFilter"> <summary> Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>, <see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages. </summary> <value>The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.ITraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> <summary> Writes the specified trace level, message and optional exception. </summary> <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> <param name="message">The trace message.</param> <param name="ex">The trace exception. This parameter is optional.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.IValueProvider"> <summary> Provides methods to get and set values. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.IValueProvider.SetValue(System.Object,System.Object)"> <summary> Sets the value. </summary> <param name="target">The target to set the value on.</param> <param name="value">The value to set on the target.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.IValueProvider.GetValue(System.Object)"> <summary> Gets the value. </summary> <param name="target">The target to get the value from.</param> <returns>The value.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonArrayContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonArrayContract.CollectionItemType"> <summary> Gets the <see cref="T:System.Type"/> of the collection items. </summary> <value>The <see cref="T:System.Type"/> of the collection items.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonArrayContract.IsMultidimensionalArray"> <summary> Gets a value indicating whether the collection type is a multidimensional array. </summary> <value><c>true</c> if the collection type is a multidimensional array; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonArrayContract.OverrideCreator"> <summary> Gets or sets the function used to create the object. When set this function will override <see cref="P:Microsoft.Identity.Json.Serialization.JsonContract.DefaultCreator"/>. </summary> <value>The function used to create the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonArrayContract.HasParameterizedCreator"> <summary> Gets a value indicating whether the creator has a parameter with the collection values. </summary> <value><c>true</c> if the creator has a parameter with the collection values; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonArrayContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonArrayContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonContainerContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContainerContract.ItemConverter"> <summary> Gets or sets the default collection items <see cref="T:Microsoft.Identity.Json.JsonConverter" />. </summary> <value>The converter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContainerContract.ItemIsReference"> <summary> Gets or sets a value indicating whether the collection items preserve object references. </summary> <value><c>true</c> if collection items preserve object references; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContainerContract.ItemReferenceLoopHandling"> <summary> Gets or sets the collection item reference loop handling. </summary> <value>The reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContainerContract.ItemTypeNameHandling"> <summary> Gets or sets the collection item type name handling. </summary> <value>The type name handling.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonContainerContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonContainerContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.SerializationCallback"> <summary> Handles <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> serialization callback events. </summary> <param name="o">The object that raised the callback event.</param> <param name="context">The streaming context.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.SerializationErrorCallback"> <summary> Handles <see cref="T:Microsoft.Identity.Json.JsonSerializer"/> serialization error callback events. </summary> <param name="o">The object that raised the callback event.</param> <param name="context">The streaming context.</param> <param name="errorContext">The error context.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.ExtensionDataSetter"> <summary> Sets extension data for an object during deserialization. </summary> <param name="o">The object to set extension data on.</param> <param name="key">The extension data key.</param> <param name="value">The extension data value.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.ExtensionDataGetter"> <summary> Gets extension data for an object during serialization. </summary> <param name="o">The object to set extension data on.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.UnderlyingType"> <summary> Gets the underlying type for the contract. </summary> <value>The underlying type for the contract.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.CreatedType"> <summary> Gets or sets the type created during deserialization. </summary> <value>The type created during deserialization.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.IsReference"> <summary> Gets or sets whether this type contract is serialized as a reference. </summary> <value>Whether this type contract is serialized as a reference.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.Converter"> <summary> Gets or sets the default <see cref="T:Microsoft.Identity.Json.JsonConverter" /> for this contract. </summary> <value>The converter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.OnDeserializedCallbacks"> <summary> Gets or sets all methods called immediately after deserialization of the object. </summary> <value>The methods called immediately after deserialization of the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.OnDeserializingCallbacks"> <summary> Gets or sets all methods called during deserialization of the object. </summary> <value>The methods called during deserialization of the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.OnSerializedCallbacks"> <summary> Gets or sets all methods called after serialization of the object graph. </summary> <value>The methods called after serialization of the object graph.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.OnSerializingCallbacks"> <summary> Gets or sets all methods called before serialization of the object. </summary> <value>The methods called before serialization of the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.OnErrorCallbacks"> <summary> Gets or sets all method called when an error is thrown during the serialization of the object. </summary> <value>The methods called when an error is thrown during the serialization of the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.DefaultCreator"> <summary> Gets or sets the default creator method used to create the object. </summary> <value>The default creator method used to create the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonContract.DefaultCreatorNonPublic"> <summary> Gets or sets a value indicating whether the default creator is non-public. </summary> <value><c>true</c> if the default object creator is non-public; otherwise, <c>false</c>.</value> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonDictionaryContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.DictionaryKeyResolver"> <summary> Gets or sets the dictionary key resolver. </summary> <value>The dictionary key resolver.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.DictionaryKeyType"> <summary> Gets the <see cref="T:System.Type"/> of the dictionary keys. </summary> <value>The <see cref="T:System.Type"/> of the dictionary keys.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.DictionaryValueType"> <summary> Gets the <see cref="T:System.Type"/> of the dictionary values. </summary> <value>The <see cref="T:System.Type"/> of the dictionary values.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.OverrideCreator"> <summary> Gets or sets the function used to create the object. When set this function will override <see cref="P:Microsoft.Identity.Json.Serialization.JsonContract.DefaultCreator"/>. </summary> <value>The function used to create the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.HasParameterizedCreator"> <summary> Gets a value indicating whether the creator has a parameter with the dictionary values. </summary> <value><c>true</c> if the creator has a parameter with the dictionary values; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonDictionaryContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonDictionaryContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonDynamicContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDynamicContract.Properties"> <summary> Gets the object's properties. </summary> <value>The object's properties.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonDynamicContract.PropertyNameResolver"> <summary> Gets or sets the property name resolver. </summary> <value>The property name resolver.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonDynamicContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonDynamicContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonISerializableContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonISerializableContract.ISerializableCreator"> <summary> Gets or sets the <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor. </summary> <value>The <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonISerializableContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonISerializableContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonLinqContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonLinqContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonLinqContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonObjectContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.MemberSerialization"> <summary> Gets or sets the object member serialization. </summary> <value>The member object serialization.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ItemRequired"> <summary> Gets or sets a value that indicates whether the object's properties are required. </summary> <value> A value indicating whether the object's properties are required. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ItemNullValueHandling"> <summary> Gets or sets how the object's properties with null values are handled during serialization and deserialization. </summary> <value>How the object's properties with null values are handled during serialization and deserialization.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.Properties"> <summary> Gets the object's properties. </summary> <value>The object's properties.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.CreatorParameters"> <summary> Gets a collection of <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> instances that define the parameters used with <see cref="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.OverrideCreator"/>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.OverrideCreator"> <summary> Gets or sets the function used to create the object. When set this function will override <see cref="P:Microsoft.Identity.Json.Serialization.JsonContract.DefaultCreator"/>. This function is called with a collection of arguments which are defined by the <see cref="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.CreatorParameters"/> collection. </summary> <value>The function used to create the object.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ExtensionDataSetter"> <summary> Gets or sets the extension data setter. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ExtensionDataGetter"> <summary> Gets or sets the extension data getter. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ExtensionDataValueType"> <summary> Gets or sets the extension data value type. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonObjectContract.ExtensionDataNameResolver"> <summary> Gets or sets the extension data name resolver. </summary> <value>The extension data name resolver.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonObjectContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonObjectContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonPrimitiveContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPrimitiveContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonPrimitiveContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonProperty"> <summary> Maps a JSON property to a .NET member or constructor parameter. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.PropertyName"> <summary> Gets or sets the name of the property. </summary> <value>The name of the property.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.DeclaringType"> <summary> Gets or sets the type that declared this property. </summary> <value>The type that declared this property.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Order"> <summary> Gets or sets the order of serialization of a member. </summary> <value>The numeric order of serialization.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.UnderlyingName"> <summary> Gets or sets the name of the underlying member or parameter. </summary> <value>The name of the underlying member or parameter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ValueProvider"> <summary> Gets the <see cref="T:Microsoft.Identity.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> during serialization. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> during serialization.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.AttributeProvider"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.Serialization.IAttributeProvider"/> for this property. </summary> <value>The <see cref="T:Microsoft.Identity.Json.Serialization.IAttributeProvider"/> for this property.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.PropertyType"> <summary> Gets or sets the type of the property. </summary> <value>The type of the property.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Converter"> <summary> Gets or sets the <see cref="T:Microsoft.Identity.Json.JsonConverter" /> for the property. If set this converter takes precedence over the contract converter for the property type. </summary> <value>The converter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.MemberConverter"> <summary> Gets or sets the member converter. </summary> <value>The member converter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Ignored"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> is ignored. </summary> <value><c>true</c> if ignored; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Readable"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> is readable. </summary> <value><c>true</c> if readable; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Writable"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> is writable. </summary> <value><c>true</c> if writable; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.HasMemberAttribute"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> has a member attribute. </summary> <value><c>true</c> if has a member attribute; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.DefaultValue"> <summary> Gets the default value. </summary> <value>The default value.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.Required"> <summary> Gets or sets a value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> is required. </summary> <value>A value indicating whether this <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> is required.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.IsReference"> <summary> Gets or sets a value indicating whether this property preserves object references. </summary> <value> <c>true</c> if this instance is reference; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.NullValueHandling"> <summary> Gets or sets the property null value handling. </summary> <value>The null value handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.DefaultValueHandling"> <summary> Gets or sets the property default value handling. </summary> <value>The default value handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ReferenceLoopHandling"> <summary> Gets or sets the property reference loop handling. </summary> <value>The reference loop handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ObjectCreationHandling"> <summary> Gets or sets the property object creation handling. </summary> <value>The object creation handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.TypeNameHandling"> <summary> Gets or sets or sets the type name handling. </summary> <value>The type name handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ShouldSerialize"> <summary> Gets or sets a predicate used to determine whether the property should be serialized. </summary> <value>A predicate used to determine whether the property should be serialized.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ShouldDeserialize"> <summary> Gets or sets a predicate used to determine whether the property should be deserialized. </summary> <value>A predicate used to determine whether the property should be deserialized.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.GetIsSpecified"> <summary> Gets or sets a predicate used to determine whether the property should be serialized. </summary> <value>A predicate used to determine whether the property should be serialized.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.SetIsSpecified"> <summary> Gets or sets an action used to set whether the property has been deserialized. </summary> <value>An action used to set whether the property has been deserialized.</value> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonProperty.ToString"> <summary> Returns a <see cref="T:System.String"/> that represents this instance. </summary> <returns> A <see cref="T:System.String"/> that represents this instance. </returns> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ItemConverter"> <summary> Gets or sets the converter used when serializing the property's collection items. </summary> <value>The collection's items converter.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ItemIsReference"> <summary> Gets or sets whether this property's collection items are serialized as a reference. </summary> <value>Whether this property's collection items are serialized as a reference.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ItemTypeNameHandling"> <summary> Gets or sets the type name handling used when serializing the property's collection items. </summary> <value>The collection's items type name handling.</value> </member> <member name="P:Microsoft.Identity.Json.Serialization.JsonProperty.ItemReferenceLoopHandling"> <summary> Gets or sets the reference loop handling used when serializing the property's collection items. </summary> <value>The collection's items reference loop handling.</value> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonPropertyCollection"> <summary> A collection of <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> objects. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPropertyCollection.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonPropertyCollection"/> class. </summary> <param name="type">The type.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPropertyCollection.GetKeyForItem(Microsoft.Identity.Json.Serialization.JsonProperty)"> <summary> When implemented in a derived class, extracts the key from the specified element. </summary> <param name="item">The element from which to extract the key.</param> <returns>The key for the specified element.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPropertyCollection.AddProperty(Microsoft.Identity.Json.Serialization.JsonProperty)"> <summary> Adds a <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> object. </summary> <param name="property">The property to add to the collection.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPropertyCollection.GetClosestMatchProperty(System.String)"> <summary> Gets the closest matching <see cref="T:Microsoft.Identity.Json.Serialization.JsonProperty"/> object. First attempts to get an exact case match of <paramref name="propertyName"/> and then a case insensitive match. </summary> <param name="propertyName">Name of the property.</param> <returns>A matching property if found.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonPropertyCollection.GetProperty(System.String,System.StringComparison)"> <summary> Gets a property by property name. </summary> <param name="propertyName">The name of the property to get.</param> <param name="comparisonType">Type property name string comparison.</param> <returns>A matching property if found.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.JsonStringContract"> <summary> Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonStringContract.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.JsonStringContract"/> class. </summary> <param name="underlyingType">The underlying type for the contract.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.JsonTypeReflector.CreateJsonConverterInstance(System.Type,System.Object[])"> <summary> Lookup and create an instance of the <see cref="T:Microsoft.Identity.Json.JsonConverter"/> type described by the argument. </summary> <param name="converterType">The <see cref="T:Microsoft.Identity.Json.JsonConverter"/> type to create.</param> <param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter. If <c>null</c>, the default constructor is used.</param> </member> <member name="T:Microsoft.Identity.Json.Serialization.MemoryTraceWriter"> <summary> Represents a trace writer that writes to memory. When the trace message limit is reached then old trace messages will be removed as new messages are added. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.MemoryTraceWriter.LevelFilter"> <summary> Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>, <see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages. </summary> <value> The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. </value> </member> <member name="M:Microsoft.Identity.Json.Serialization.MemoryTraceWriter.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.MemoryTraceWriter"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.MemoryTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> <summary> Writes the specified trace level, message and optional exception. </summary> <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> <param name="message">The trace message.</param> <param name="ex">The trace exception. This parameter is optional.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.MemoryTraceWriter.GetTraceMessages"> <summary> Returns an enumeration of the most recent trace messages. </summary> <returns>An enumeration of the most recent trace messages.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.MemoryTraceWriter.ToString"> <summary> Returns a <see cref="T:System.String"/> of the most recent trace messages. </summary> <returns> A <see cref="T:System.String"/> of the most recent trace messages. </returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.NamingStrategy"> <summary> A base class for resolving how property names and dictionary keys are serialized. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.NamingStrategy.ProcessDictionaryKeys"> <summary> A flag indicating whether dictionary keys should be processed. Defaults to <c>false</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.NamingStrategy.ProcessExtensionDataNames"> <summary> A flag indicating whether extension data names should be processed. Defaults to <c>false</c>. </summary> </member> <member name="P:Microsoft.Identity.Json.Serialization.NamingStrategy.OverrideSpecifiedNames"> <summary> A flag indicating whether explicitly specified property names, e.g. a property name customized with a <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/>, should be processed. Defaults to <c>false</c>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.NamingStrategy.GetPropertyName(System.String,System.Boolean)"> <summary> Gets the serialized name for a given property name. </summary> <param name="name">The initial property name.</param> <param name="hasSpecifiedName">A flag indicating whether the property has had a name explicitly specified.</param> <returns>The serialized property name.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.NamingStrategy.GetExtensionDataName(System.String)"> <summary> Gets the serialized name for a given extension data name. </summary> <param name="name">The initial extension data name.</param> <returns>The serialized extension data name.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.NamingStrategy.GetDictionaryKey(System.String)"> <summary> Gets the serialized key for a given dictionary key. </summary> <param name="key">The initial dictionary key.</param> <returns>The serialized dictionary key.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.NamingStrategy.ResolvePropertyName(System.String)"> <summary> Resolves the specified property name. </summary> <param name="name">The property name to resolve.</param> <returns>The resolved property name.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.ObjectConstructor`1"> <summary> Represents a method that constructs an object. </summary> <typeparam name="T">The object type to create.</typeparam> </member> <member name="T:Microsoft.Identity.Json.Serialization.OnErrorAttribute"> <summary> When applied to a method, specifies that the method is called when an error occurs serializing an object. </summary> </member> <member name="T:Microsoft.Identity.Json.Serialization.ReflectionAttributeProvider"> <summary> Provides methods to get attributes from a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionAttributeProvider.#ctor(System.Object)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.ReflectionAttributeProvider"/> class. </summary> <param name="attributeProvider">The instance to get attributes for. This parameter should be a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Boolean)"> <summary> Returns a collection of all of the attributes, or an empty collection if there are no attributes. </summary> <param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param> <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Type,System.Boolean)"> <summary> Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. </summary> <param name="attributeType">The type of the attributes.</param> <param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param> <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.ReflectionValueProvider"> <summary> Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using reflection. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionValueProvider.#ctor(System.Reflection.MemberInfo)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.ReflectionValueProvider"/> class. </summary> <param name="memberInfo">The member info.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionValueProvider.SetValue(System.Object,System.Object)"> <summary> Sets the value. </summary> <param name="target">The target to set the value on.</param> <param name="value">The value to set on the target.</param> </member> <member name="M:Microsoft.Identity.Json.Serialization.ReflectionValueProvider.GetValue(System.Object)"> <summary> Gets the value. </summary> <param name="target">The target to get the value from.</param> <returns>The value.</returns> </member> <member name="T:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy"> <summary> A snake case naming strategy. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy"/> class. </summary> <param name="processDictionaryKeys"> A flag indicating whether dictionary keys should be processed. </param> <param name="overrideSpecifiedNames"> A flag indicating whether explicitly specified property names should be processed, e.g. a property name customized with a <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/>. </param> </member> <member name="M:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy"/> class. </summary> <param name="processDictionaryKeys"> A flag indicating whether dictionary keys should be processed. </param> <param name="overrideSpecifiedNames"> A flag indicating whether explicitly specified property names should be processed, e.g. a property name customized with a <see cref="T:Microsoft.Identity.Json.JsonPropertyAttribute"/>. </param> <param name="processExtensionDataNames"> A flag indicating whether extension data names should be processed. </param> </member> <member name="M:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy"/> class. </summary> </member> <member name="M:Microsoft.Identity.Json.Serialization.SnakeCaseNamingStrategy.ResolvePropertyName(System.String)"> <summary> Resolves the specified property name. </summary> <param name="name">The property name to resolve.</param> <returns>The resolved property name.</returns> </member> <member name="T:Microsoft.Identity.Json.StringEscapeHandling"> <summary> Specifies how strings are escaped when writing JSON text. </summary> </member> <member name="F:Microsoft.Identity.Json.StringEscapeHandling.Default"> <summary> Only control characters (e.g. newline) are escaped. </summary> </member> <member name="F:Microsoft.Identity.Json.StringEscapeHandling.EscapeNonAscii"> <summary> All non-ASCII and control characters (e.g. newline) are escaped. </summary> </member> <member name="F:Microsoft.Identity.Json.StringEscapeHandling.EscapeHtml"> <summary> HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. </summary> </member> <member name="T:Microsoft.Identity.Json.TypeNameAssemblyFormatHandling"> <summary> Indicates the method that will be used during deserialization for locating and loading assemblies. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameAssemblyFormatHandling.Simple"> <summary> In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the <c>LoadWithPartialName</c> method of the <see cref="T:System.Reflection.Assembly"/> class is used to load the assembly. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameAssemblyFormatHandling.Full"> <summary> In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <c>Load</c> method of the <see cref="T:System.Reflection.Assembly"/> class is used to load the assembly. </summary> </member> <member name="T:Microsoft.Identity.Json.TypeNameHandling"> <summary> Specifies type name handling options for the <see cref="T:Microsoft.Identity.Json.JsonSerializer"/>. </summary> <remarks> <see cref="P:Microsoft.Identity.Json.JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. Incoming types should be validated with a custom <see cref="P:Microsoft.Identity.Json.JsonSerializer.SerializationBinder"/> when deserializing with a value other than <see cref="F:Microsoft.Identity.Json.TypeNameHandling.None"/>. </remarks> </member> <member name="F:Microsoft.Identity.Json.TypeNameHandling.None"> <summary> Do not include the .NET type name when serializing types. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameHandling.Objects"> <summary> Include the .NET type name when serializing into a JSON object structure. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameHandling.Arrays"> <summary> Include the .NET type name when serializing into a JSON array structure. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameHandling.All"> <summary> Always include the .NET type name when serializing. </summary> </member> <member name="F:Microsoft.Identity.Json.TypeNameHandling.Auto"> <summary> Include the .NET type name when the type of the object being serialized is not the same as its declared type. Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON you must specify a root type object with <see cref="M:Microsoft.Identity.Json.JsonConvert.SerializeObject(System.Object,System.Type,Microsoft.Identity.Json.JsonSerializerSettings)"/> or <see cref="M:Microsoft.Identity.Json.JsonSerializer.Serialize(Microsoft.Identity.Json.JsonWriter,System.Object,System.Type)"/>. </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.CollectionUtils.IsNullOrEmpty``1(System.Collections.Generic.ICollection{``0})"> <summary> Determines whether the collection is <c>null</c> or empty. </summary> <param name="collection">The collection.</param> <returns> <c>true</c> if the collection is <c>null</c> or empty; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.CollectionUtils.AddRange``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IEnumerable{``0})"> <summary> Adds the elements of the specified collection to the specified generic <see cref="T:System.Collections.Generic.IList`1"/>. </summary> <param name="initial">The list to add to.</param> <param name="collection">The collection of elements to add.</param> </member> <member name="M:Microsoft.Identity.Json.Utilities.ConvertUtils.ConvertOrCast(System.Object,System.Globalization.CultureInfo,System.Type)"> <summary> Converts the value to the specified type. If the value is unable to be converted, the value is checked whether it assignable to the specified type. </summary> <param name="initialValue">The value to convert.</param> <param name="culture">The culture to use when converting.</param> <param name="targetType">The type to convert or cast the value to.</param> <returns> The converted type. If conversion was unsuccessful, the initial value is returned if assignable to the target type. </returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject`1.CallMethodWithResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Collections.Generic.IEnumerable{System.Linq.Expressions.Expression},Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback,Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> <summary> Helper method for generating a MetaObject which calls a specific method on Dynamic that returns a result </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject`1.CallMethodReturnLast(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Collections.Generic.IEnumerable{System.Linq.Expressions.Expression},Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> <summary> Helper method for generating a MetaObject which calls a specific method on Dynamic, but uses one of the arguments for the result. </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject`1.CallMethodNoResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> <summary> Helper method for generating a MetaObject which calls a specific method on Dynamic, but uses one of the arguments for the result. </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.DynamicProxyMetaObject`1.GetRestrictions"> <summary> Returns a Restrictions object which includes our current restrictions merged with a restriction limiting our type </summary> </member> <member name="T:Microsoft.Identity.Json.Utilities.ImmutableCollectionsUtils"> <summary> Helper class for serializing immutable collections. Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed https://github.com/JamesNK/Microsoft.Identity.Json/issues/652 </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.GetCollectionItemType(System.Type)"> <summary> Gets the type of the typed collection's items. </summary> <param name="type">The type.</param> <returns>The type of the typed collection's items.</returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.GetMemberUnderlyingType(System.Reflection.MemberInfo)"> <summary> Gets the member's underlying type. </summary> <param name="member">The member.</param> <returns>The underlying type of the member.</returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)"> <summary> Determines whether the member is an indexed property. </summary> <param name="member">The member.</param> <returns> <c>true</c> if the member is an indexed property; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)"> <summary> Determines whether the property is an indexed property. </summary> <param name="property">The property.</param> <returns> <c>true</c> if the property is an indexed property; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.GetMemberValue(System.Reflection.MemberInfo,System.Object)"> <summary> Gets the member's value on the object. </summary> <param name="member">The member.</param> <param name="target">The target object.</param> <returns>The member's value on the object.</returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.SetMemberValue(System.Reflection.MemberInfo,System.Object,System.Object)"> <summary> Sets the member's value on the target object. </summary> <param name="member">The member.</param> <param name="target">The target.</param> <param name="value">The value.</param> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.CanReadMemberValue(System.Reflection.MemberInfo,System.Boolean)"> <summary> Determines whether the specified MemberInfo can be read. </summary> <param name="member">The MemberInfo to determine whether can be read.</param> /// <param name="nonPublic">if set to <c>true</c> then allow the member to be gotten non-publicly.</param> <returns> <c>true</c> if the specified MemberInfo can be read; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.Identity.Json.Utilities.ReflectionUtils.CanSetMemberValue(System.Reflection.MemberInfo,System.Boolean,System.Boolean)"> <summary> Determines whether the specified MemberInfo can be set. </summary> <param name="member">The MemberInfo to determine whether can be set.</param> <param name="nonPublic">if set to <c>true</c> then allow the member to be set non-publicly.</param> <param name="canSetReadOnly">if set to <c>true</c> then allow the member to be set if read-only.</param> <returns> <c>true</c> if the specified MemberInfo can be set; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.Utilities.StringBuffer"> <summary> Builds a string. Unlike <see cref="T:System.Text.StringBuilder"/> this class lets you reuse its internal buffer. </summary> </member> <member name="M:Microsoft.Identity.Json.Utilities.StringUtils.IsWhiteSpace(System.String)"> <summary> Determines whether the string is all white space. Empty string will return <c>false</c>. </summary> <param name="s">The string to test whether it is all white space.</param> <returns> <c>true</c> if the string is all white space; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.Identity.Json.WriteState"> <summary> Specifies the state of the <see cref="T:Microsoft.Identity.Json.JsonWriter"/>. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Error"> <summary> An exception has been thrown, which has left the <see cref="T:Microsoft.Identity.Json.JsonWriter"/> in an invalid state. You may call the <see cref="M:Microsoft.Identity.Json.JsonWriter.Close"/> method to put the <see cref="T:Microsoft.Identity.Json.JsonWriter"/> in the <c>Closed</c> state. Any other <see cref="T:Microsoft.Identity.Json.JsonWriter"/> method calls result in an <see cref="T:System.InvalidOperationException"/> being thrown. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Closed"> <summary> The <see cref="M:Microsoft.Identity.Json.JsonWriter.Close"/> method has been called. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Object"> <summary> An object is being written. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Array"> <summary> An array is being written. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Constructor"> <summary> A constructor is being written. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Property"> <summary> A property is being written. </summary> </member> <member name="F:Microsoft.Identity.Json.WriteState.Start"> <summary> A <see cref="T:Microsoft.Identity.Json.JsonWriter"/> write method has not been called. </summary> </member> </members> </doc> |