1670 lines
85 KiB
XML
1670 lines
85 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>xIdentityService</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:xIdentityService.Configuration.XProxyConfiguration">
|
|
<summary>
|
|
XProxy Middleware Configuration ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.Host">
|
|
<summary>
|
|
Proxy Host Address for Clients Which Use XProxy Server ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.XPoweredValue">
|
|
<summary>
|
|
if EnableXPoweredByAthorization property setted to true, this property determines
|
|
the header must be this value ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.DisableSSLCheck">
|
|
<summary>
|
|
Determines Proxy Http Handler Check SSL or not ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.AllowAutoRedirect">
|
|
<summary>
|
|
Determines Http Client Handler Allow Auto Redirect or not ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.EnableLogging">
|
|
<summary>
|
|
Determines Proxy Server Log Received Requests or not ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyConfiguration.Routes">
|
|
<summary>
|
|
DefineRoutes for Handling ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityService.Configuration.XProxyRouteDescriptor">
|
|
<summary>
|
|
Describe a Proxy Route ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyRouteDescriptor.Route">
|
|
<summary>
|
|
Determines which route can handled for Proxyfing ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyRouteDescriptor.EnableAuthorization">
|
|
<summary>
|
|
Determines Proxy Server Handle Athorization or not ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyRouteDescriptor.AllowedScopes">
|
|
<summary>
|
|
Determines Which Scopes allowed to this route if authorizations enabled ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyRouteDescriptor.AllowedRoles">
|
|
<summary>
|
|
Determines Which Roles allowed to this route if authorizations enabled ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Configuration.XProxyRouteDescriptor.EnableXPoweredByAthorization">
|
|
<summary>
|
|
Determines XProxy Can Check XPowered By Authorization or not ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityService.Constants.XHeader">
|
|
<summary>
|
|
All Available Headers ...
|
|
</summary>
|
|
</member>
|
|
<member name="F:xIdentityService.Constants.XHeader.ConnectionId">
|
|
<summary>
|
|
Hub Connection ID Header Keys ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityService.Controllers.XBaseIdentityApiController">
|
|
<summary>
|
|
Base Identity Api Controller
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityService.Controllers.XBaseIdentityApiV1Controller">
|
|
<summary>
|
|
Base Identity Api V1 Controller
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetConnectionId">
|
|
<summary>
|
|
Retrieve Connection ID for Hubs ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetUserSelectByParam(xIdentityModels.Models.XActionRequest,System.Boolean,System.Collections.Generic.ICollection{xIdentityModels.Constants.XUserSelectBy})">
|
|
<summary>
|
|
Retrieve User Identifier Base on XActionRequest
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="forceNotNull"></param>
|
|
<param name="excludes"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetAccessToken">
|
|
<summary>
|
|
Retrieve Access Token
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetRefreshToken">
|
|
<summary>
|
|
Retrieve Refresh Token
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetTokenExpiresAt">
|
|
<summary>
|
|
Retrieve Access Token Expiration Date
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.RetrieveTokensAsXLoginResponse">
|
|
<summary>
|
|
Retrieve All Required Tokens
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.RetrieveTokensAsXTokenResponse">
|
|
<summary>
|
|
Retrieve All Required Tokens
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.GetUserInfo">
|
|
<summary>
|
|
Retrive UserInfo
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Controllers.XBaseIdentityController.ValidateAndGetUserInfo">
|
|
<summary>
|
|
Validate User Authenticated and Retrieve User Info
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.DI.XDIHelperExtension.GetXIdentityServiceConfiguration(Microsoft.Extensions.Configuration.IConfiguration)">
|
|
<summary>
|
|
Extract Module Configuration Structure from IConfiguration interface
|
|
</summary>
|
|
<param name="config"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.DI.XDIHelperExtension.AddXIdentityService(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.DependencyInjection.ServiceLifetime)">
|
|
<summary>
|
|
Register Service and All it's Requirements
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.DI.XDIHelperExtension.AddXIdentityService(Microsoft.Extensions.DependencyInjection.IServiceCollection,xIdentityService.Configuration.XIdentityServiceConfiguration,Microsoft.Extensions.DependencyInjection.ServiceLifetime)">
|
|
<summary>
|
|
Register Service and All it's Requirements
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.DI.XDIHelperExtension.AddXTokenProvider``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.DependencyInjection.ServiceLifetime)">
|
|
<summary>
|
|
Register Custome Token Provider
|
|
</summary>
|
|
<param name="services"></param>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="M:xIdentityService.DI.XDIHelperExtension.UseXIdentityService(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
|
<summary>
|
|
Use Authentication
|
|
</summary>
|
|
<param name="app"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.AuthorizationPolicyBuilderExtensions.RequireScope(Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder,System.String[])">
|
|
<summary>
|
|
Adds a policy to check for required scopes.
|
|
</summary>
|
|
<param name="builder"></param>
|
|
<param name="scope">List of any required scopes. The token must contain at least one of the listed scopes.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Extensions.ScopePolicy">
|
|
<summary>
|
|
Helper for creating scope-related policies
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.ScopePolicy.Create(System.String[])">
|
|
<summary>
|
|
Creates a policy to check for required scopes.
|
|
</summary>
|
|
<param name="scopes">List of any required scopes. The token must contain at least one of the listed scopes.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.GetAuthenticationService(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Authentication Service ...
|
|
</summary>
|
|
<param name="context"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.GetXTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,xIdentityService.Constants.XAuthenticationScheme)">
|
|
<summary>
|
|
Retrieve Specific Token from HttpContext ...
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="tokenName"></param>
|
|
<param name="scheme"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.GetAccessToken(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Access Token
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.GetRefreshToken(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Refresh Token
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.GetTokenExpiresAt(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Access Token Expiration Date
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.HttpContextExtensions.RetrieveTokensAsXTokenResponse(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve All Required Tokens
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.StreamExtensions.ToAsyncEnumerable(System.IO.Stream,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Converts an Stream to Async Enumerable ...
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="bufferSize"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Extensions.StreamExtensions.ToAsyncEnumerable``1(System.IO.Stream,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Converts an Stream to Async Enumerable ...
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="bufferSize"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Interfaces.IXBaseIdentityHttpProvider">
|
|
<summary>
|
|
an interface for Identity Provided Http Based Services ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.BaseUrl">
|
|
<summary>
|
|
Client Base Url ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.Logger">
|
|
<summary>
|
|
Logger ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.XPoweredValue">
|
|
<summary>
|
|
Powered Value ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.DefaultClientTimeout">
|
|
<summary>
|
|
Default Client Timeout ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.DefaultBufferingChunckSize">
|
|
<summary>
|
|
Default Buffering Chunk Size ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.ValidationProvider">
|
|
<summary>
|
|
Validation Provider ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.GetHttpClient(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get an Instance of Http Client
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.GetRestClient(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get an Instance of RestClient
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.GetRestRequet(System.Enum,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Get an Instance of RestRequest
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="addXPoweredValue"></param>
|
|
<param name=""></param>
|
|
<param name="headers"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.RunRestRequest``1(RestSharp.RestClient,RestSharp.RestRequest,xHttpService.Constants.XHttpMethod,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Handle Call Specific Request and retrieve Response
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="request"></param>
|
|
<param name="method"></param>
|
|
<param name="supportRefreshingTokens"></param>
|
|
<param name="cancellationToken"></param>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.StreamData(System.Enum,System.Int32,System.Boolean,xIdentityModels.Models.XTokenResponse,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Access a Get Request Stream as AsyncEnumerable ...
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="bufferLength"></param>
|
|
<param name="addXPoweredValue"></param>
|
|
<param name="tokens"></param>
|
|
<param name="@params"></param>
|
|
<param name="headers"></param>
|
|
<param name="queryStrings"></param>
|
|
<param name="cancellationToken"></param>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.RunRestRequestByResponse``1(RestSharp.RestClient,RestSharp.RestRequest,xHttpService.Constants.XHttpMethod,System.Boolean,System.Threading.CancellationToken)" -->
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.GetUserSelectByParam(xIdentityModels.Models.XActionRequest,System.Boolean,System.Collections.Generic.ICollection{xIdentityModels.Constants.XUserSelectBy})">
|
|
<summary>
|
|
Get User SelectBy Param
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="forceNotNull"></param>
|
|
<param name="excludes"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.ToTokenResponse(xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Converts UserInfo to TokenResponse model ...
|
|
</summary>
|
|
<param name="userInfo"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.PrepareUrl(System.Enum,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Prepare Url Address of Specified Enum by Filling Params
|
|
and Query Strings Attach ...
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="attachBaseUrl"></param>
|
|
<param name="@params"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseIdentityHttpProvider.PrepareUrl(System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Prepare Url Address by Filling Params
|
|
and Query Strings Attach ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="attachBaseUrl"></param>
|
|
<param name="@params"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Interfaces.IXBaseReferenced`2">
|
|
<summary>
|
|
a Referenced Service is a Service which can Referenced to other Items ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferenced`2.GetIdentifier``1(System.String,``0)">
|
|
<summary>
|
|
Get Reference Identifier for Specified Provider and Specified Item ...
|
|
</summary>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferenced`2.IsProvidedFor``1(System.String,``0,`1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Check Specified Item has Refernce to Provider ...
|
|
</summary>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="id"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferenced`2.AddReference``1(System.String,``0,`1,System.Int32,xIdentityModels.Models.XUserClaimsInfoDto,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Add Specified Reference to Specified Item ...
|
|
</summary>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="id"></param>
|
|
<param name="forIndex"></param>
|
|
<param name="userInfo"></param>
|
|
<param name="connectionId"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferenced`2.RemoveReference``1(System.String,``0,`1,System.Int32,xIdentityModels.Models.XUserClaimsInfoDto,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove Specified Reference from Specified Item ...
|
|
</summary>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="id"></param>
|
|
<param name="forIndex"></param>
|
|
<param name="userInfo"></param>
|
|
<param name="connectionId"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferenced`2.GetReferences(System.String,`1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get Specified References ...
|
|
</summary>
|
|
<param name="providedFor"></param>
|
|
<param name="id"></param>
|
|
<param name="cancellationToken"></param>
|
|
<typeparam name="TReferenceKey"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferencedController`2.IsProvidedFor(`1,System.String,System.Object,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Check an Item Has Reference to Specified ProvideFor and Specified forProvidedId ...
|
|
</summary>
|
|
<param name="id"></param>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferencedController`2.AddReference(`1,System.String,System.Object,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Add a Reference to Item for Specified ProvideFor and Specified forProvidedId ...
|
|
</summary>
|
|
<param name="id"></param>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="forIndex"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferencedController`2.RemoveReference(`1,System.String,System.Object,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove a Reference from Item for Specified ProvideFor and Specified forProvidedId ...
|
|
</summary>
|
|
<param name="id"></param>
|
|
<param name="providedFor"></param>
|
|
<param name="forProvidedId"></param>
|
|
<param name="forIndex"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXBaseReferencedController`2.GetReferences(`1,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Retrieve References of Specified Itemfor providedFor ...
|
|
</summary>
|
|
<param name="id"></param>
|
|
<param name="providedFor"></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2">
|
|
<summary>
|
|
in Some Cases we have Entities Which Can Referenced for Specified
|
|
Provider and Types ...
|
|
this interface Globaly introduce all available Actions for those ...
|
|
|
|
TKey: type of Provider Models Keys ...
|
|
TModel: type of Dto which Referenced ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.Provider">
|
|
<summary>
|
|
Provider Identifier ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.GetReference(`1,System.Int32)">
|
|
<summary>
|
|
Get Specified Indexed Reference for Specific Provided ID ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<param name="forIndex"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.GetAllReferences(`1)">
|
|
<summary>
|
|
Retrieve all Exists References of Specific Provided ID ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.GetAllReferencings(`1)">
|
|
<summary>
|
|
Extract all Referencing Models for Specified Key ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.CountReferences(`1)">
|
|
<summary>
|
|
Count References ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.QueryReferences(xModels.Dtos.XQuery,`1)">
|
|
<summary>
|
|
Retrieve References of Specific Provided ID as Query ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.AddReference(`0,`1,System.String,xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Add Reference a Model to Specific Provided ID ...
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="providedForId"></param>
|
|
<param name="connectionId"></param>
|
|
<param name="userInfo"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.AddReference(`0,xDataService.Models.XReference{`1},System.String,xIdentityModels.Models.XUserClaimsInfoDto)" -->
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.RemoveReference(`0,`1,System.String,xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Remove Reference a Model for Specific Provided ID ...
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="providedForId"></param>
|
|
<param name="connectionId"></param>
|
|
<param name="userInfo"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.RemoveReference(`0,xDataService.Models.XReference{`1},System.String,xIdentityModels.Models.XUserClaimsInfoDto)" -->
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityBaseReferencedProvider`2.RemoveReferences(`1,System.String,xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Remove All References to Specified Key ...
|
|
</summary>
|
|
<param name="providedForId"></param>
|
|
<param name="connectionId"></param>
|
|
<param name="userInfo"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXIdentityProvider.QueryOpenToSearchUsers(xIdentityModels.Models.XTokenResponse,xModels.Dtos.XQuery)">
|
|
<summary>
|
|
Query Open To Search User Profiles ...
|
|
</summary>
|
|
<param name="tokens">requested user's identifiers</param>
|
|
<param name="query">how to filter results based on <see>XQuery</see> structure</param>
|
|
<returns>an instance of <see>XQueryResult</see> of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="P:xIdentityService.Interfaces.IXProxyHelper.Configuration">
|
|
<summary>
|
|
Proxy Configuration ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.NormalizeHost">
|
|
<summary>
|
|
retrie Normalize Host ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.ValidateConfiguration">
|
|
<summary>
|
|
Validate XProxy Configuration for Client ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.GetRouteUrls">
|
|
<summary>
|
|
Retrieve all Prepared url of Routes ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.GetRoutes">
|
|
<summary>
|
|
retrieve all registred Routes ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.PrepareActionUrlForXProxyRoute(System.String,xIdentityService.Configuration.XProxyRouteDescriptor)">
|
|
<summary>
|
|
Prepare a request url for a Proxy Route ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="descriptor"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.PrepareActionUrlForXProxyRoute(System.String,System.Linq.Expressions.Expression{System.Func{xIdentityService.Configuration.XProxyRouteDescriptor,System.Boolean}})">
|
|
<summary>
|
|
Prepare a request url for a Selected Proxy Route ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="whereClause"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Interfaces.IXProxyHelper.FindRoute(System.Linq.Expressions.Expression{System.Func{xIdentityService.Configuration.XProxyRouteDescriptor,System.Boolean}})">
|
|
<summary>
|
|
Find an Specific Route ...
|
|
</summary>
|
|
<param name="whereClause"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Middlewares.XIdentityTokenRefresherDIHelper">
|
|
<summary>
|
|
Provide all DI Requirements for XIdentityTokenRefresher Middleware
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XIdentityTokenRefresherDIHelper.UseXIdentityTokenRefresher(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
|
<summary>
|
|
Use XTokenValidator Middleware
|
|
</summary>
|
|
<param name="app"></param>
|
|
</member>
|
|
<member name="T:xIdentityService.Middlewares.XProxyMiddleware">
|
|
<summary>
|
|
Proxy Server Middleware ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.ThrowNotAuthorizedException">
|
|
<summary>
|
|
Throw Required Exception ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.SendLog(System.String,Microsoft.Extensions.Logging.LogLevel)">
|
|
<summary>
|
|
Show propper logs if Enabled ...
|
|
</summary>
|
|
<param name="message"></param>
|
|
<param name="logLevel"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.LogXProxyServerConfig">
|
|
<summary>
|
|
Log Proxy Server Configuration ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.GetUri(Microsoft.AspNetCore.Http.HttpRequest)">
|
|
<summary>
|
|
Retrieve Destination Request Path based on Current Request ...
|
|
</summary>
|
|
<param name="request"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.GetRequestMessage(Microsoft.AspNetCore.Http.HttpContext,System.Uri)">
|
|
<summary>
|
|
Retrieve Propper Request Message based on HttpContext and uri ...F
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="uri"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.FillRequest(Microsoft.AspNetCore.Http.HttpContext,System.Net.Http.HttpRequestMessage)">
|
|
<summary>
|
|
Fill Request Message by provide HttpContext ...
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.GetMethod(System.String)">
|
|
<summary>
|
|
Retreive and Extract Method Type of HttpRequest ...
|
|
</summary>
|
|
<param name="method"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.HandleResponseHeaders(Microsoft.AspNetCore.Http.HttpContext,System.Net.Http.HttpResponseMessage)">
|
|
<summary>
|
|
add all headers exists in HttpResponse MEssage to Current Context Response Headers ...
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.ProcessResponseContent(Microsoft.AspNetCore.Http.HttpContext,System.Net.Http.HttpResponseMessage)">
|
|
<summary>
|
|
Processing Response Content and Handle it on HttpContextResponse ...
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="response"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.IsContentOfType(System.Net.Http.HttpResponseMessage,System.String)">
|
|
<summary>
|
|
Check Content Type of Specific Response ...
|
|
</summary>
|
|
<param name="response"></param>
|
|
<param name="type"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XProxyMiddleware.GetRouteDescriptor(Microsoft.AspNetCore.Http.HttpRequest)">
|
|
<summary>
|
|
Retrieve and Extract Route Descriptor ...
|
|
</summary>
|
|
<param name="request"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Middlewares.XDIHelperExtension">
|
|
<summary>
|
|
Provide all requirements for Dependency Injection Handler ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.GetXProxyConfiguration(Microsoft.Extensions.Configuration.IConfiguration)">
|
|
<summary>
|
|
Retrieve XProxy Middelware Configuration from Configuration ...
|
|
</summary>
|
|
<param name="config"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyHttpHandler(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Net.Http.HttpClientHandler)">
|
|
<summary>
|
|
Register HTTP Handler for XProxy Server ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
<param name="httpHandler"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyHttpHandler(Microsoft.Extensions.DependencyInjection.IServiceCollection,xIdentityService.Configuration.XProxyConfiguration,System.Net.Http.HttpClientHandler)">
|
|
<summary>
|
|
Register HTTP Handler for XProxy Server ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
<param name="httpHandler"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Net.Http.HttpClientHandler)">
|
|
<summary>
|
|
Register XProxy On Server ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
<param name="httpHandler"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyServer(Microsoft.Extensions.DependencyInjection.IServiceCollection,xIdentityService.Configuration.XProxyConfiguration,System.Net.Http.HttpClientHandler)">
|
|
<summary>
|
|
Register XProxy On Server ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
<param name="httpHandler"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
|
|
<summary>
|
|
Register XProxy On Server ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.AddXProxyClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,xIdentityService.Configuration.XProxyConfiguration)">
|
|
<summary>
|
|
Register XProxy On Client ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
<param name="configuration"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Middlewares.XDIHelperExtension.UseXProxy(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
|
<summary>
|
|
Adding XProxy Middleware to Applications ...
|
|
</summary>
|
|
<param name="app"></param>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Ban(xIdentityModels.Models.XTokenResponse,xIdentityModels.Dtos.XUserNameIdRequest)">
|
|
<summary>
|
|
Ban Specific Users
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="model">an instance of <see>XUserNameIdRequest</see> which represents user identifier list to Ban</param>
|
|
<returns>a list of banned users identifiers</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.UnBan(xIdentityModels.Models.XTokenResponse,xIdentityModels.Dtos.XUserNameIdRequest)">
|
|
<summary>
|
|
UnBann Specific Users
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="model">an instance of <see>XUserNameIdRequest</see> which represents user identifier list to Ban</param>
|
|
<returns>a list of unbanned users identifiers</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.IsBanned(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Check Specific User is Banned or not
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">specified user's identifier</param>
|
|
<returns>a boolean value which represent user banned or not</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestDiscoveryDocument">
|
|
<summary>
|
|
Request for Discovery Document
|
|
</summary>
|
|
<returns>an instance of DiscoveryDocumentResponse</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestScopeAccessToken(System.String)">
|
|
<summary>
|
|
Request AccessToken for Specific XApiScope
|
|
</summary>
|
|
<param name="scope">a member of <see>XApiScope</see></param>
|
|
<returns>an instance of <see>XTokenResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Introspection(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Validate a token
|
|
</summary>
|
|
<param name="model">Authentication Tokens</param>
|
|
<returns>an instance of TokenIntrospectionResponse</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Authenticate(xIdentityModels.Models.XLoginRequest)">
|
|
<summary>
|
|
Authenticate a User
|
|
</summary>
|
|
<param name="model">User Login Required Info, an instance of <see>XLoginRequest</see></param>
|
|
<returns>an instance of <see>XTokenResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Login(xIdentityModels.Models.XLoginRequest)">
|
|
<summary>
|
|
Do Login based on XLoginRequest
|
|
</summary>
|
|
<param name="model">User Login Required Info, an instance of <see>XLoginRequest</see></param>
|
|
<returns>an instance of <see>XTokenResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Logout(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Logout from System
|
|
</summary>
|
|
<param name="model"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RefreshTokens(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Refresh Tokens
|
|
</summary>
|
|
<param name="model">Authentication Tokens</param>
|
|
<returns>an instance of <see>XTokenResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ChangePassword(xIdentityModels.Models.XTokenResponse,xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Change Password
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Follow(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Follow a User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Cancel(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Cancel Following Request
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.UnFollowFollower(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Unfollow a Follower
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.UnFollowFollowing(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Unfollow Following
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.Block(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Block a Follower
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.UnBlock(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Unblock a Blocked User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.AcceptRequest(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Accept a Following Request
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollower</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RejectRequest(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Reject a Following Request
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollower</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFriendshipInfo(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Friendship Info Model between Specific User and Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipInfoDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.IsFollower(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Check a User IsFollower of Requested User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollower(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Specific Follower
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollower</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowerState(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Follower State of a User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipState</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowers(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get Followers List Of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of <see>XFriendshipFollower</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetAllFollowers(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get All Followers List Includes Blocked, Requested and etc
|
|
of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of <see>XFriendshipFollower</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowersList(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Return Followers UserName's List of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of UserNames</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryFollowers(xModels.Dtos.XQuery,System.String,xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Retrieve All User's Followers based on Query Model ...
|
|
</summary>
|
|
<param name="query">Query Model Descriptor</param>
|
|
<param name="destUser">Dest User for Reading Followers</param>
|
|
<param name="tokens">Requester User's Descriptor</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.IsFollowing(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Check a User is in Followings of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowing(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Specific Following Model
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowingState(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Following State Relation between Specific User
|
|
and Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="destUser">a user identifier which represent destination user</param>
|
|
<returns>an instance of <see>XFriendshipState</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowings(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get Followings of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetAllFollowings(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get All Following List Includes Blocked, Requested and etc
|
|
of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of <see>XFriendshipFollowing</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetFollowingList(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Return Following UserName's List of Current User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<returns>a collection of UserNames</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryFollowings(xModels.Dtos.XQuery,System.String,xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Retrieve All User's Followings based on Query Model ...
|
|
</summary>
|
|
<param name="query">Query Model Descriptor</param>
|
|
<param name="destUser">Dest User for Reading Followers</param>
|
|
<param name="tokens">Requester User's Descriptor</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetDevice">
|
|
<summary>
|
|
Prepare API Based Device to Open Actions ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetUserNames(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Retrieve User Names based on UserIds
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="ids">a comma seperated list of UserIds</param>
|
|
<returns>a collection of UserNames</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetUserNameIds(xIdentityModels.Models.XTokenResponse,xIdentityModels.Dtos.XUserNameIdRequest)">
|
|
<summary>
|
|
get user ids and retrieve corresponding user names
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="model">an instance of <see>XUserNameIdRequest</see> which represent required UserIds collection</param>
|
|
<returns>a collection of <see>XUserNameIdResponse</see> instance</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetUserProfile(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Get Profile Object of Specific User
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">determine's which user profile must be retrieved</param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryUsers(xIdentityModels.Models.XTokenResponse,xModels.Dtos.XQuery)">
|
|
<summary>
|
|
Retrieve Users Based On Query
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="query">how to filter results based on <see>XQuery</see> structure</param>
|
|
<returns>an instance of <see>XQueryResult</see> of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryInRoleUsers(xIdentityModels.Models.XTokenResponse,System.String,xModels.Dtos.XQuery,System.Boolean)">
|
|
<summary>
|
|
Retrieve Users Based On Query and Specified role
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="role">an string which represent user role</param>
|
|
<param name="query">how to filter results based on <see>XQuery</see> structure</param>
|
|
<param name="forceRole">if it's true the user must has exact role, otherwise top level users also listed</param>
|
|
<returns>an instance of <see>XQueryResult</see> of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryAvatars(xIdentityModels.Models.XTokenResponse,System.String,xModels.Dtos.XQuery)">
|
|
<summary>
|
|
Query Specified User's Profile Images
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">determine's which user profile must be retrieved</param>
|
|
<param name="query">how to filter results based on <see>XQuery</see> structure</param>
|
|
<returns>an instance of <see>XQueryResult</see> of <see>XProfileImage</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ProfileUpdateAsync(xIdentityModels.Models.XTokenResponse,System.String,xIdentityModels.Models.XProfileUpdateRequest)">
|
|
<summary>
|
|
Update User Profile based on <see>XProfileUpdateRequest</see> (FirstName/LastName/DateOfBirth)
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">determine's which user profile must be retrieved</param>
|
|
<param name="model">user update info, an instance of <see>XProfileUpdateRequest</see></param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.FullProfileUpdateAsync(xIdentityModels.Models.XTokenResponse,System.String,xIdentityModels.Models.XProfileUpdateRequest)">
|
|
<summary>
|
|
Update a User Profile based on <see>XProfileUpdateRequest</see> Full
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">determine's which user profile must be retrieved</param>
|
|
<param name="model">user update info, an instance of <see>XProfileUpdateRequest</see></param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.AddAvatar(xIdentityModels.Models.XTokenResponse,Microsoft.AspNetCore.Http.IFormFile)">
|
|
<summary>
|
|
Add a New Profile Image
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="file">an specific File to upload, <see>IFormFile</see></param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.AddAvatars(xIdentityModels.Models.XTokenResponse,Microsoft.AspNetCore.Http.IFormFileCollection)">
|
|
<summary>
|
|
Add a New Collection of Profile Images
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="files">a collection of Files to upload, <see>IFormFileCollection</see></param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.SetAvatar(xIdentityModels.Models.XTokenResponse,System.Int32)">
|
|
<summary>
|
|
set Specified Profile Image as Avatar
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="id">an integer which reperesent AvatarId to set as current Avatar</param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RemoveAvatars(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Remove Profile Images
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="avatarIds">a comma seperated list of avatarIds to remove</param>
|
|
<returns>an instance of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.CanRegister(System.String)">
|
|
<summary>
|
|
Check a User Selector is Available for Registration or Not
|
|
</summary>
|
|
<param name="userSelectByParam">an string value which reperesent a user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.InviteUser(xIdentityModels.Models.XTokenResponse,xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Invite a User to Register on Dashboard
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestRegistration(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Recieve some Basic Informations and Start Registration Proccess
|
|
if they Valid
|
|
|
|
Registration Proccess Starts with Invoking this Action
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.AddAccountInfo(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Add User Account Informations
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.AttachProfileImage(System.String,Microsoft.AspNetCore.Http.IFormFile)">
|
|
<summary>
|
|
Upload and Attach a Profile Image for User. this is an Optional Step
|
|
</summary>
|
|
<param name="actionToken">user's requested action token</param>
|
|
<param name="file">an instance of <see>IFormFile</see> for user's Avatar</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.FinishRegistration(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Finish Registrationn Proccess
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.IsConfirmedEmail(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Check User is Confirmed Email or not
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">an string value which reperesent a user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.IsConfirmedMobile(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Check User is Confirmed Mobile or not
|
|
</summary>
|
|
<param name="tokens">Authentication Tokens</param>
|
|
<param name="userSelectByParam">an string value which reperesent a user</param>
|
|
<returns>a boolean value</returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestConfirmRegistration(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Request Registration Confirm
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ConfirmRegistration(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Confirm Registration
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestConfirmMobile(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Request For Mobile Number Change/Confirm
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ConfirmMobileNumber(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Confirm Requested Mobile Number
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestConfirmEmail(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Request For Email Address Change/Confirm
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ConfirmEmailAddress(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Confirm Requested Email Address
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RequestResetPassword(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Request Reset Password Action
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns>an instance of <see>XActionResponse</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.ResetPassword(xIdentityModels.Models.XActionRequest)">
|
|
<summary>
|
|
Reset a User's Password
|
|
</summary>
|
|
<param name="model">an instance of <see>XActionRequest</see> class which provider requirement for action</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.QueryOpenToSearchUsers(xIdentityModels.Models.XTokenResponse,xModels.Dtos.XQuery)">
|
|
<summary>
|
|
Query Open To Search User Profiles ...
|
|
</summary>
|
|
<param name="tokens">requested user's identifiers</param>
|
|
<param name="query">how to filter results based on <see>XQuery</see> structure</param>
|
|
<returns>an instance of <see>XQueryResult</see> of <see>XUserProfileDto</see></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetHttpClient">
|
|
<summary>
|
|
Get an Instance of Http Client
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetRestClient(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get an Instance of RestClient
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetRestRequet(xIdentityService.Constants.XApiAccountEndpoint,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Get an Instance of RestRequest
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.RunRestRequest``1(RestSharp.RestClient,RestSharp.RestRequest,xHttpService.Constants.XHttpMethod,System.Boolean)">
|
|
<summary>
|
|
Handle Call Specific Request and retrieve Response
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="request"></param>
|
|
<param name="method"></param>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XIdentityProvider.GetUserSelectByParam(xIdentityModels.Models.XActionRequest,System.Boolean,System.Collections.Generic.ICollection{xIdentityModels.Constants.XUserSelectBy})">
|
|
<summary>
|
|
Get User SelectBy Param
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="forceNotNull"></param>
|
|
<param name="excludes"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityService.Providers.XBaseIdentityHttpProvider">
|
|
<summary>
|
|
an abstraction Implementation for Identity Provided Http Based Services ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.BaseUrl">
|
|
<summary>
|
|
Client Base Url ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.Logger">
|
|
<summary>
|
|
Logger ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.XPoweredValue">
|
|
<summary>
|
|
Powered Value ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.DefaultClientTimeout">
|
|
<summary>
|
|
Default Client Timeout ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.DefaultBufferingChunckSize">
|
|
<summary>
|
|
Default Buffering Chunk Size ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityService.Providers.XBaseIdentityHttpProvider.ValidationProvider">
|
|
<summary>
|
|
Validation Provider ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="F:xIdentityService.Providers.XBaseIdentityHttpProvider.tokenProvider">
|
|
<summary>
|
|
Token Provider ...
|
|
</summary>
|
|
</member>
|
|
<member name="F:xIdentityService.Providers.XBaseIdentityHttpProvider.identityProvider">
|
|
<summary>
|
|
Identity Provider ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.GetHttpClient(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get an Instance of Http Client
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.GetRestClient(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Get an Instance of RestClient
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.GetRestRequet(System.Enum,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Get an Instance of RestRequest
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="addXPoweredValue"></param>
|
|
<param name=""></param>
|
|
<param name="headers"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.RunRestRequest``1(RestSharp.RestClient,RestSharp.RestRequest,xHttpService.Constants.XHttpMethod,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Handle Call Specific Request and retrieve Response
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="request"></param>
|
|
<param name="method"></param>
|
|
<param name="supportRefreshingTokens"></param>
|
|
<param name="cancellationToken"></param>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.StreamData(System.Enum,System.Int32,System.Boolean,xIdentityModels.Models.XTokenResponse,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Access a Get Request Stream as AsyncEnumerable ...
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="bufferLength"></param>
|
|
<param name="addXPoweredValue"></param>
|
|
<param name="tokens"></param>
|
|
<param name="@params"></param>
|
|
<param name="headers"></param>
|
|
<param name="queryStrings"></param>
|
|
<param name="cancellationToken"></param>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:xIdentityService.Providers.XBaseIdentityHttpProvider.RunRestRequestByResponse``1(RestSharp.RestClient,RestSharp.RestRequest,xHttpService.Constants.XHttpMethod,System.Boolean,System.Threading.CancellationToken)" -->
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.GetUserSelectByParam(xIdentityModels.Models.XActionRequest,System.Boolean,System.Collections.Generic.ICollection{xIdentityModels.Constants.XUserSelectBy})">
|
|
<summary>
|
|
Get User SelectBy Param
|
|
</summary>
|
|
<param name="model"></param>
|
|
<param name="forceNotNull"></param>
|
|
<param name="excludes"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.PrepareUrl(System.Enum,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Prepare Url Address of Specified Enum by Filling Params
|
|
and Query Strings Attach ...
|
|
</summary>
|
|
<param name="endpoint"></param>
|
|
<param name="attachBaseUrl"></param>
|
|
<param name="@params"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.PrepareUrl(System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Prepare Url Address by Filling Params
|
|
and Query Strings Attach ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="attachBaseUrl"></param>
|
|
<param name="@params"></param>
|
|
<param name="queryStrings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XBaseIdentityHttpProvider.ToTokenResponse(xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Converts UserInfo to TokenResponse model ...
|
|
</summary>
|
|
<param name="userInfo"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.ValidateConfiguration">
|
|
<summary>
|
|
Validate XProxy Configuration for Client ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.NormalizeHost">
|
|
<summary>
|
|
retrie Normalize Host ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.GetRoutes">
|
|
<summary>
|
|
retrieve all registred Routes ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.GetRouteUrls">
|
|
<summary>
|
|
Retrieve all Prepared url of Routes ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.FindRoute(System.Linq.Expressions.Expression{System.Func{xIdentityService.Configuration.XProxyRouteDescriptor,System.Boolean}})">
|
|
<summary>
|
|
Find an Specific Route ...
|
|
</summary>
|
|
<param name="whereClause"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.PrepareActionUrlForXProxyRoute(System.String,xIdentityService.Configuration.XProxyRouteDescriptor)">
|
|
<summary>
|
|
Prepare a request url for a Proxy Route ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="descriptor"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityService.Providers.XProxyHelper.PrepareActionUrlForXProxyRoute(System.String,System.Linq.Expressions.Expression{System.Func{xIdentityService.Configuration.XProxyRouteDescriptor,System.Boolean}})">
|
|
<summary>
|
|
Prepare a request url for a Selected Proxy Route ...
|
|
</summary>
|
|
<param name="url"></param>
|
|
<param name="whereClause"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.HttpRequest)">
|
|
<summary>
|
|
Retrieve Tokens From Headers
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Tokens From HttpContext
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)">
|
|
<summary>
|
|
Retrieve Tokens From ActionExecutingContext
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.RetrieveTokens(xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Retrieve Tokens From XUserInfo instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.IHeaderDictionary)">
|
|
<summary>
|
|
Retrieve Tokens From IHeader Dictionary
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.GetXApiIdentityProvider(Microsoft.AspNetCore.Mvc.Filters.FilterContext)">
|
|
<summary>
|
|
Retrieve IXIdentityProvider from HttpContext
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.CreateXLoginResponse(IdentityModel.Client.TokenResponse)">
|
|
<summary>
|
|
Generate XLoginResponse instance based on TokenResponse
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.IHeaderDictionary,xIdentityModels.Models.XLoginResponse,System.String)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific IHeaderDictionary instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:XTokenExtensions.SetXAuthenticationTokens(System.Net.Http.Headers.HttpRequestHeaders,xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific IHeaderDictionary instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.HttpRequest,xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific HttpRequest instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:XTokenExtensions.SetXAuthenticationTokens(System.Net.Http.HttpRequestMessage,xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific HttpRequest instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.HttpResponse,xIdentityModels.Models.XLoginResponse,System.String)">
|
|
<summary>
|
|
Add ReNewed Authorization Tokens in Headers of
|
|
Specific Response.
|
|
Later in HttpInterceptors we can Look for AccessToken-ReNewed
|
|
header Value and Renew User Tokens based on it
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:XTokenExtensions.IsRefreshable(xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Determines a Token Can Refrsh or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.GetRevisionChecksum(xIdentityModels.Models.XLoginResponse,System.String)">
|
|
<summary>
|
|
Generate a Revision Checksum for new Tokens
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="secret"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.GetRevisionChecksum(xIdentityModels.Models.XTokenResponse,System.String)">
|
|
<summary>
|
|
Generate a Revision Checksum for new Tokens
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="secret"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.ValidateRevisionChecksum(xIdentityModels.Models.XLoginResponse,System.String,System.String)">
|
|
<summary>
|
|
Check an XLoginResponse instance is Valid with it's revision
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="checksum"></param>
|
|
<param name="secret"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.ValidateRevisionChecksum(xIdentityModels.Models.XTokenResponse,System.String,System.String)">
|
|
<summary>
|
|
Check an XTokenResponse instance is Valid with it's revision
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="checksum"></param>
|
|
<param name="secret"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.GetException(IdentityModel.Client.TokenResponse)">
|
|
<summary>
|
|
Retrieve Exception Details if Fails
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:XTokenExtensions.ToHeaderDictionary(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Convert XTokenResponse to Header Dictionary
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|