CloudGamingAdmin/admin-server/CloudGaming.Core.Identity/CloudGaming.Core.Identity.xml
2024-11-15 02:58:48 +08:00

196 lines
7.5 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0"?>
<doc>
<assembly>
<name>CloudGaming.Core.Identity</name>
</assembly>
<members>
<member name="T:CloudGaming.Core.Identity.Configs.CoreIdentityConfig">
<summary>
共享身份认证配置
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.Configs.CoreIdentityConfig.AddIdentity(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
<summary>
添加身份认证
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.Configs.CoreIdentityConfig.UseIdentity(Microsoft.AspNetCore.Builder.WebApplication)">
<summary>
使用身份认证
</summary>
<param name="webApplication"></param>
</member>
<member name="T:CloudGaming.Core.Identity.CoreIdentityAddStartup">
<summary>
程序启动器 - 身份认证 注册
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.CoreIdentityAddStartup.ConfigureServices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
<summary>
</summary>
<param name="webApplicationBuilder"></param>
</member>
<member name="T:CloudGaming.Core.Identity.CoreIdentityStartup">
<summary>
程序启动器 - 身份认证 注册、认证
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.CoreIdentityStartup.ConfigureServices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
<summary>
</summary>
<param name="webApplicationBuilder"></param>
</member>
<member name="M:CloudGaming.Core.Identity.CoreIdentityStartup.Configure(Microsoft.AspNetCore.Builder.WebApplication)">
<summary>
</summary>
<param name="webApplication"></param>
</member>
<member name="T:CloudGaming.Core.Identity.Models.JwtTokenOptions">
<summary>
jwt token 配置
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtTokenKeyName">
<summary>
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtIssuerSigningKey">
<summary>
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtValidIssuer">
<summary>
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtValidAudience">
<summary>
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtExpirationTime">
<summary>
Jwt 过期时间
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.JwtTokenOptions.JwtRefreshTime">
<summary>
Jwt 刷新Token过期时间
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.TokenInfo.TokenType">
<summary>
Token Type
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.TokenInfo.AccessToken">
<summary>
Token
</summary>
</member>
<member name="P:CloudGaming.Core.Identity.Models.TokenInfo.RefreshToken">
<summary>
Refresh Token
</summary>
</member>
<member name="T:CloudGaming.Core.Identity.Services.JwtTokenService">
<summary>
jwt token 服务
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.#ctor(Microsoft.AspNetCore.Http.IHttpContextAccessor,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
jwt token 服务
</summary>
<param name="httpContextAccessor"></param>
<param name="configuration"></param>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.CreateTokenByAccountId(System.Guid)">
<summary>
根据 id 创建token
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.HasTokenString">
<summary>
检查是否有Token字符串
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.GetTokenString">
<summary>
获取 token 字符串
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.ValidateAndReadJWTToken">
<summary>
验证和读取jwt token
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.IsValidate">
<summary>
是否验证通过
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.GetAccountIdByToken">
<summary>
获取 token 并得到 id
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.IsRefreshToken">
<summary>
是否刷新token
</summary>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Services.JwtTokenService.IsExpire">
<summary>
是否过期
</summary>
<returns></returns>
</member>
<member name="T:CloudGaming.Core.Identity.Utils.JwtTokenUtil">
<summary>
JWT是由 . 分割的三部分组成:
头部(Header)
载荷(Payload) : 这一部分是JWT主要的信息存储部分其中包含了许多种的声明claims
签名(Signature)使用保存在服务端的秘钥对其签名用来验证发送者的JWT的同时也能确保在期间不被篡改。
</summary>
</member>
<member name="M:CloudGaming.Core.Identity.Utils.JwtTokenUtil.CreateToken(System.String,CloudGaming.Core.Identity.Models.JwtTokenOptions,System.TimeSpan)">
<summary>
创建 token
</summary>
<param name="id"></param>
<param name="jwtTokenOptions"></param>
<param name="expirationTime"></param>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Utils.JwtTokenUtil.ValidateAndReadJWTToken(System.String,CloudGaming.Core.Identity.Models.JwtTokenOptions)">
<summary>
验证 和 读取 token
</summary>
<param name="token"></param>
<param name="jwtTokenOptions"></param>
<returns></returns>
</member>
<member name="M:CloudGaming.Core.Identity.Utils.JwtTokenUtil.ReadJwtToken(System.String)">
<summary>
通过 token 字符串读取内容
</summary>
<param name="token"></param>
<returns></returns>
</member>
</members>
</doc>