1074 lines
44 KiB
XML
1074 lines
44 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>xIdentityModels</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.IdentitySecretKey">
|
|
<summary>
|
|
the Security Key which used to Signing JWT Tokens
|
|
in Authentication Provider
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.IdentityIssuer">
|
|
<summary>
|
|
the Issuer and Creator of Token
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.IdentityAudience">
|
|
<summary>
|
|
the Audience and Consumer of Token
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.IdentityRoles">
|
|
<summary>
|
|
the List of Users Roles which must Provides in Identity
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.NewUsersRole">
|
|
<summary>
|
|
determines All new users must Assign to which role in Registration
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.AutoConfirmNewUsersEmail">
|
|
<summary>
|
|
determines New Registered Users Confirm Email or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.AutoConfirmNewUsersPhoneNumber">
|
|
<summary>
|
|
determines New Registered Users Confirm PhoneNumber or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.RegistrationJustWithInvite">
|
|
<summary>
|
|
determines the Registration only Can be done with Invitation or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.RequireRegistrationConfirm">
|
|
<summary>
|
|
determines the Registration required confirmation with email or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityConfiguration.ActionTokenExpirationDateProvider">
|
|
<summary>
|
|
an string Which Provide how long a action token can be valid
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityPolicy">
|
|
<summary>
|
|
Provide the Available Policies with their Default Values
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicy.Lockout">
|
|
<summary>
|
|
User Account Lock Policies
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicy.Password">
|
|
<summary>
|
|
User Password Policies
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicy.SignIn">
|
|
<summary>
|
|
the Policies for User for Allowing to SignIn
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicy.User">
|
|
<summary>
|
|
the Policies for User
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicy.Profile">
|
|
<summary>
|
|
the policies which determines how to
|
|
populate user profile
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityPolicyLockout">
|
|
<summary>
|
|
User Account Lock Policies
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyLockout.LockoutTimeSpanProvider">
|
|
<summary>
|
|
The String which Provide Time Span Delais
|
|
between Lockout and UnLock a User Account
|
|
this Provided String the Parsed before Use
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyLockout.MaxFailedAccessAttempts">
|
|
<summary>
|
|
the Number of InvalidLoginAttemps which can
|
|
Happens to Lockout User Account
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyLockout.AllowedForNewUsers">
|
|
<summary>
|
|
determines Lockout mechanism allowed for new Users or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityPolicyPassword">
|
|
<summary>
|
|
User Password Policies
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequireDigit">
|
|
<summary>
|
|
determines Password must contains digits or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequiredLength">
|
|
<summary>
|
|
determines the minimum allowed length for a password
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequiredUniqueChars">
|
|
<summary>
|
|
determines the number of Unique Chars must be included in a Password
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequireLowercase">
|
|
<summary>
|
|
determines Password must contains LowerCase chars or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequireNonAlphanumeric">
|
|
<summary>
|
|
determines Password must contains Non-Alphabetical chars or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyPassword.RequireUppercase">
|
|
<summary>
|
|
determines Password must contains UpperCase chars or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityPolicySignIn">
|
|
<summary>
|
|
the Policies for User for Allowing to SignIn
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicySignIn.RequiredEnabled">
|
|
<summary>
|
|
determines only enabled users can SignIn
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicySignIn.RequireConfirmedEmail">
|
|
<summary>
|
|
determines User must Confirm the given Email Address
|
|
before Login or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicySignIn.RequireConfirmedPhoneNumber">
|
|
<summary>
|
|
determines User must Confirm the given Phone Number
|
|
before Login or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityPolicyUser">
|
|
<summary>
|
|
the Policies for User
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.AllowedUserNameCharacters">
|
|
<summary>
|
|
determines Allowed characters which can used in UserName
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.RequireUniqueEmail">
|
|
<summary>
|
|
determines the Email Address of each User must be Unique or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.MinLength">
|
|
<summary>
|
|
minimum length of User Name
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.MaxLength">
|
|
<summary>
|
|
maximum length of user name
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.MinAgeForRegistration">
|
|
<summary>
|
|
Minimum Age for Registration
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.MaxAgeForRegistration">
|
|
<summary>
|
|
Maximum age for Registration
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityPolicyUser.InvalidUserNames">
|
|
<summary>
|
|
a collection of invalid usernames
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Configurations.XIdentityProfile">
|
|
<summary>
|
|
contains user profile configuration
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityProfile.ContainsEmail">
|
|
<summary>
|
|
determines user profile contain email or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityProfile.ContainsPhoneNumber">
|
|
<summary>
|
|
determines user profile contains phone number or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Configurations.XIdentityProfile.ContainsRoles">
|
|
<summary>
|
|
determines user profile contains Roles collection or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Constants.XFriendshipState">
|
|
<summary>
|
|
Represent State of Friendship between to Users
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Constants.XGender">
|
|
<summary>
|
|
Determines Available Genders
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Descriptors.XIdentityUserDescriptor">
|
|
<summary>
|
|
contains default users information
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XFriendshipType">
|
|
<summary>
|
|
All Available Friendship Types ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XFriendDto">
|
|
<summary>
|
|
a DTO Class Which Represent a User Friends ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XOpenActions">
|
|
<summary>
|
|
a List of Available Open Actions ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XOpenActionRequestDto">
|
|
<summary>
|
|
Open Actions Request Model ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityModels.Dtos.XOpenActionRequestDto.Validate">
|
|
<summary>
|
|
Validate Model ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Dtos.XOpenActionRequestDto.ToOpenActionToken">
|
|
<summary>
|
|
Checksum Digest Model ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Dtos.XOpenActionRequestDto.ValidateToken(System.String)">
|
|
<summary>
|
|
Validate a Token is Correspond to Model or not ...
|
|
</summary>
|
|
<param name="token"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XOpenActionInnerDto">
|
|
<summary>
|
|
aa Dto which used between Api's ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xIdentityModels.Dtos.XOpenActionUserInfoDto">
|
|
<summary>
|
|
User Info Providing in Open Actions ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.DIExtensions.AddXUserRoleHandler(Microsoft.Extensions.DependencyInjection.IServiceCollection,xIdentityModels.Interfaces.IXUserRoleHelper)">
|
|
<summary>
|
|
since registering IXUserRoleHelper need to add default instance if
|
|
user not provided we create this helper ...
|
|
</summary>
|
|
<param name="services"></param>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.xIdentityModelsExtensions.ToXProfileDto(xIdentityModels.XUser,System.Boolean,System.Boolean,System.Collections.Generic.IEnumerable{System.String},xIdentityModels.Dtos.XFriendshipInfoDto,xIdentityModels.Configurations.XIdentityProfile)">
|
|
<summary>
|
|
Converts a User Entity to Profile Dto ...
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="isAdmin"></param>
|
|
<param name="isSameUser"></param>
|
|
<param name="roles"></param>
|
|
<param name="friendship"></param>
|
|
<param name="profileConfig"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.xIdentityModelsExtensions.HasAccess(xIdentityModels.Models.XUserClaimsInfoDto,System.String[])">
|
|
<summary>
|
|
Check Specified User Has Access to Provided Roles ...
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="roles"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.xIdentityModelsExtensions.ContainsUserSelectByParam(xIdentityModels.XUser,System.String)">
|
|
<summary>
|
|
Check Specified User Contains Specified UserSelectByParam or not ...
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="userSelectByParam"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XModelExtensions.ToXUser(xIdentityModels.Descriptors.XIdentityUserDescriptor)">
|
|
<summary>
|
|
/// Convert XIdentityUserDescriptor instance to XUser
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XModelExtensions.IsSameAs(xIdentityModels.XUser,xIdentityModels.Descriptors.XIdentityUserDescriptor)">
|
|
<summary>
|
|
Check a User is Same as Descriptor User
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="dest"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XModelExtensions.IsSameAs(xIdentityModels.Navigations.XDevice,xIdentityModels.Navigations.XDevice)">
|
|
<summary>
|
|
Check to XDevice instance to be same or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="dest"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XModelExtensions.ToXTokenResponse(xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
convert UserClaimsInfo to TokenResponse ...
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ToTokenString(Microsoft.IdentityModel.Tokens.SecurityToken,System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler)">
|
|
<summary>
|
|
Convert a SecurityToken to it's Token String
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="tokenHandler"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ValidateToken(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
|
<summary>
|
|
Validate a Token
|
|
</summary>
|
|
<param name="token"></param>
|
|
<param name="tokenHandler"></param>
|
|
<param name="tokenValidationParams"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ToSecurityToken(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
|
<summary>
|
|
Convert a token string to Security Token
|
|
</summary>
|
|
<param name="token"></param>
|
|
<param name="tokenHandler"></param>
|
|
<param name="tokenValidationParams"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ParseActionRequestToken(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
|
<summary>
|
|
Parse Action Token and return Corresponding RegistrationRequestDto
|
|
</summary>
|
|
<param name="token"></param>
|
|
<param name="tokenHandler"></param>
|
|
<param name="tokenValidationParams"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.IsSameAs(xIdentityModels.Models.XActionRequestContext,xIdentityModels.Models.XActionRequestContext)">
|
|
<summary>
|
|
Check to ActionRequestContext object is same or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="dest"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ToJwtClaims(xIdentityModels.Models.XActionRequestToken)">
|
|
<summary>
|
|
Convert a RegistrationRequestDto object to it's jwt token Claims
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ToJwtToken(xIdentityModels.Models.XActionRequestToken,System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler,Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)">
|
|
<summary>
|
|
Generate a SecurityToken based on RegistrationRequestDto object
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="tokenHandler"></param>
|
|
<param name="tokenDescriptor"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.HttpRequest)">
|
|
<summary>
|
|
Retrieve Tokens From Headers
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.HttpContext)">
|
|
<summary>
|
|
Retrieve Tokens From HttpContext
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)">
|
|
<summary>
|
|
Retrieve Tokens From ActionExecutingContext
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.RetrieveTokens(xIdentityModels.Models.XUserClaimsInfoDto)">
|
|
<summary>
|
|
Retrieve Tokens From XUserInfo instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.RetrieveTokens(Microsoft.AspNetCore.Http.IHeaderDictionary)">
|
|
<summary>
|
|
Retrieve Tokens From IHeader Dictionary
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.CreateXLoginResponse(IdentityModel.Client.TokenResponse)">
|
|
<summary>
|
|
Generate XTokenResponse instance based on TokenResponse
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.CreateXTokenResponse(IdentityModel.Client.TokenResponse)">
|
|
<summary>
|
|
Generate XTokenResponse instance based on TokenResponse
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.ToXTokenResponse(xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Convert XLoginResponse to XTokenResponse
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.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:xIdentityModels.Extensions.XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.IHeaderDictionary,xIdentityModels.Models.XTokenResponse,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:xIdentityModels.Extensions.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:xIdentityModels.Extensions.XTokenExtensions.SetXAuthenticationTokens(System.Net.Http.Headers.HttpRequestHeaders,xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific IHeaderDictionary instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.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:xIdentityModels.Extensions.XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.HttpRequest,xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific HttpRequest instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.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:xIdentityModels.Extensions.XTokenExtensions.SetXAuthenticationTokens(System.Net.Http.HttpRequestMessage,xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Add Authorization Tokens in Headers of
|
|
Specific HttpRequest instance
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="model"></param>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.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:xIdentityModels.Extensions.XTokenExtensions.SetXAuthenticationTokens(Microsoft.AspNetCore.Http.HttpResponse,xIdentityModels.Models.XTokenResponse,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:xIdentityModels.Extensions.XTokenExtensions.IsRefreshable(xIdentityModels.Models.XLoginResponse)">
|
|
<summary>
|
|
Determines a Token Can Refrsh or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.XTokenExtensions.IsRefreshable(xIdentityModels.Models.XTokenResponse)">
|
|
<summary>
|
|
Determines a Token Can Refrsh or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xIdentityModels.Extensions.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:xIdentityModels.Extensions.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:xIdentityModels.Extensions.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:xIdentityModels.Extensions.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="T:xIdentityModels.Models.XActionRequest">
|
|
<summary>
|
|
represent a system wide actions
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.Lang">
|
|
<summary>
|
|
Client Device Locale
|
|
</summary>
|
|
<value>user's client device local such as en-US</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.ActionToken">
|
|
<summary>
|
|
Requested Action Token
|
|
</summary>
|
|
<value>a hashed content</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.Device">
|
|
<summary>
|
|
user's device
|
|
</summary>
|
|
<value>an instance of <see>XDevice</see> which represent user's device</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.FirstName">
|
|
<summary>
|
|
FirstName
|
|
</summary>
|
|
<value>users FirstName</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.LastName">
|
|
<summary>
|
|
LastName
|
|
</summary>
|
|
<value>user's LastName</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.DateOfBirth">
|
|
<summary>
|
|
an Optional Value which represetns User's DateOfBirth
|
|
</summary>
|
|
<value>user's DateOfBirth</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.UserId">
|
|
<summary>
|
|
User's Id
|
|
</summary>
|
|
<value>a GUID string which represent user's Id</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.UserName">
|
|
<summary>
|
|
UserName
|
|
</summary>
|
|
<value>user's UserName</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.Email">
|
|
<summary>
|
|
Email
|
|
</summary>
|
|
<value>user's Email address</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.MobileNumber">
|
|
<summary>
|
|
MobileNumber / PhoneNumber
|
|
</summary>
|
|
<value>user's PhoneNumber</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.Password">
|
|
<summary>
|
|
Password
|
|
</summary>
|
|
<value>user's Password</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.NewPassword">
|
|
<summary>
|
|
NewPassword
|
|
</summary>
|
|
<value>a passwor string which used to Change/Reset password</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.EmailVerificationCode">
|
|
<summary>
|
|
EmailVerificationCode
|
|
</summary>
|
|
<value>a Verification Code which assign to user's for confirm it's Email Address</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.MobileVerificationCode">
|
|
<summary>
|
|
MobileVerificationCode
|
|
</summary>
|
|
<value>a Verification Code which assign to user's for confirm it's Phone Number</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.Thumbnail">
|
|
<summary>
|
|
Thumbnail
|
|
</summary>
|
|
<value>an instance of <see>IFormFile</see> which is used as user's avatar</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionRequest.ReturnUrl">
|
|
<summary>
|
|
ReturnUrl
|
|
</summary>
|
|
<value>
|
|
a url string which used in many used cases for providing a way to lead users to right places.
|
|
</value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Models.XActionResponse">
|
|
<summary>
|
|
represent a system wide action result
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionResponse.Token">
|
|
<summary>
|
|
ActionToken
|
|
</summary>
|
|
<value>a hashed string which carry required info for doing system actions.</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XActionResponse.Expiration">
|
|
<summary>
|
|
ActionToken Lifetime
|
|
</summary>
|
|
<value>an instance of <see>DateTime</see> which represent token expiration time</value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Models.XLoginRequest">
|
|
<summary>
|
|
Represent Requirements for Authenticationg a User
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XLoginRequest.UserSelectBy">
|
|
<summary>
|
|
how select an specific User
|
|
</summary>
|
|
<value>an string value which represent how system select user such as: UserName, Email Address or MobileNumber</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XLoginRequest.Password">
|
|
<summary>
|
|
user's password
|
|
</summary>
|
|
<value>an string which represent user's pasword</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XLoginRequest.Device">
|
|
<summary>
|
|
user's device
|
|
</summary>
|
|
<value>an instance of <see>XDevice</see> which represent user's device</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Models.XLoginRequest.Language">
|
|
<summary>
|
|
user's language
|
|
</summary>
|
|
<value>an string which represent user's language and locale, such as: en-US</value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Navigations.XDevice">
|
|
<summary>
|
|
Represent a Client Device which used by User
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.Os">
|
|
<summary>
|
|
Operating System
|
|
</summary>
|
|
<value>device operating system identifier</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.OsVersion">
|
|
<summary>
|
|
Operating System Version
|
|
</summary>
|
|
<value>which version of operatin system is in use</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.Browser">
|
|
<summary>
|
|
Device Browser
|
|
</summary>
|
|
<value>the Browser identifier</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.UserAgent">
|
|
<summary>
|
|
Browser Engine Agent
|
|
</summary>
|
|
<value>browser engine Agent</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.DeviceType">
|
|
<summary>
|
|
Type of client Device
|
|
</summary>
|
|
<value>represent device type <see>XDeviceType</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.UserId">
|
|
<summary>
|
|
UserId
|
|
</summary>
|
|
<value>Represent this Devie belong to which User Identifier</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XDevice.User">
|
|
<summary>
|
|
User
|
|
</summary>
|
|
<value>Represent Device User <see>XUser</see></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Navigations.XFriendshipFollower">
|
|
<summary>
|
|
represent a Follower of specific User
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollower.State">
|
|
<summary>
|
|
XFriendshipState
|
|
</summary>
|
|
<value>state of Friendship at current moment <see>XFriendshipState</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollower.UserId">
|
|
<summary>
|
|
UserId
|
|
</summary>
|
|
<value>source User's Id</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollower.User">
|
|
<summary>
|
|
User
|
|
</summary>
|
|
<value>source User <see>XUser</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollower.DestId">
|
|
<summary>
|
|
DestId
|
|
</summary>
|
|
<value>destination User's Id</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollower.Dest">
|
|
<summary>
|
|
Dest
|
|
</summary>
|
|
<value>dest User <see>XUser</see></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Navigations.XFriendshipFollowing">
|
|
<summary>
|
|
represent a Following of specific User
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollowing.State">
|
|
<summary>
|
|
XFriendshipState
|
|
</summary>
|
|
<value>state of Friendship at current moment <see>XFriendshipState</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollowing.UserId">
|
|
<summary>
|
|
UserId
|
|
</summary>
|
|
<value>source User's Id</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollowing.User">
|
|
<summary>
|
|
User
|
|
</summary>
|
|
<value>source User <see>XUser</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollowing.DestId">
|
|
<summary>
|
|
DestId
|
|
</summary>
|
|
<value>destination User's Id</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XFriendshipFollowing.Dest">
|
|
<summary>
|
|
Dest
|
|
</summary>
|
|
<value>dest User <see>XUser</see></value>
|
|
</member>
|
|
<member name="T:xIdentityModels.Navigations.XProfileImage">
|
|
<summary>
|
|
Represent a User's Avatar Entity
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.UserId">
|
|
<summary>
|
|
UserId
|
|
</summary>
|
|
<value>represent current Avatar belongs to which User</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.User">
|
|
<summary>
|
|
User
|
|
</summary>
|
|
<value>User instance <see>XUser</see></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.Name">
|
|
<summary>
|
|
Name
|
|
</summary>
|
|
<value>Avatar's file name</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.Thumb">
|
|
<summary>
|
|
Thumb
|
|
</summary>
|
|
<value>Avatar's thumbnail file's name</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.Path">
|
|
<summary>
|
|
Path
|
|
</summary>
|
|
<value>Avatar's Image path on Profile Server</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.ThumbPath">
|
|
<summary>
|
|
ThumbPath
|
|
</summary>
|
|
<value>Avatar's Thumbnail Image path on Profile Service</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.Navigations.XProfileImage.CreationDate">
|
|
<summary>
|
|
CreationDate
|
|
</summary>
|
|
<value>Upload Time</value>
|
|
</member>
|
|
<member name="T:xIdentityModels.XUser">
|
|
<summary>
|
|
represnt a User of System
|
|
</summary>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.FirstName">
|
|
<summary>
|
|
FirstName
|
|
</summary>
|
|
<value>user's FirstName</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.LastName">
|
|
<summary>
|
|
LastName
|
|
</summary>
|
|
<value>user's LastName</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.IsEnable">
|
|
<summary>
|
|
User is Enabled or not
|
|
</summary>
|
|
<remarks>
|
|
system was restrict Disabled Users access to Many Resources
|
|
</remarks>
|
|
<value>boolean value represent User is Enable or not</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.IsBanned">
|
|
<summary>
|
|
User is Banned or not
|
|
</summary>
|
|
<remarks>
|
|
system was reject Banned Users access to Almost all Resources
|
|
</remarks>
|
|
<value>boolean value represent User is Banned or not</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.DateOfBirth">
|
|
<summary>
|
|
DateOfBirth
|
|
</summary>
|
|
<value>user's DateOfBirth</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.CreationDate">
|
|
<summary>
|
|
CreationDate
|
|
</summary>
|
|
<value>user's Creation/Registration Date</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.LastLogin">
|
|
<summary>
|
|
LastLogin
|
|
</summary>
|
|
<value>user's Last Successfull Login Date</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Avatar">
|
|
<summary>
|
|
ProfileImage/Avatar
|
|
</summary>
|
|
<value>user's current Avatar</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Gender">
|
|
<summary>
|
|
Gender
|
|
</summary>
|
|
<value>user's Gender</value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Bio">
|
|
<summary>
|
|
User Biography ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.CoverImage">
|
|
<summary>
|
|
User Bio Cover Image ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.OpenToSearch">
|
|
<summary>
|
|
Can Discover User ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Devices">
|
|
<summary>
|
|
User's Devices
|
|
</summary>
|
|
<typeparam name="XDevice"><see>XDevice</see></typeparam>
|
|
<returns>a Collection of all assigned Devices to User</returns>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Avatars">
|
|
<summary>
|
|
User's Avatars
|
|
</summary>
|
|
<typeparam name="XProfileImage"><see>XProfileImage</see></typeparam>
|
|
<returns>a Collection of all assigned Avatars to User</returns>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Followers">
|
|
<summary>
|
|
User's Followers
|
|
</summary>
|
|
<typeparam name="XFriendshipFollower"><see>XFriendshipFollower</see></typeparam>
|
|
<returns>a Collection of all User's Followers</returns>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Followings">
|
|
<summary>
|
|
User's Followings
|
|
</summary>
|
|
<typeparam name="XFriendshipFollowing"><see>XFriendshipFollowing</see></typeparam>
|
|
<returns>a Collection of all User's Followings</returns>
|
|
</member>
|
|
<member name="P:xIdentityModels.XUser.Roles">
|
|
<summary>
|
|
User's Roles
|
|
</summary>
|
|
<returns>a Collection of all User's Roles in System</returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|