388 lines
17 KiB
XML
388 lines
17 KiB
XML
|
<?xml version="1.0"?>
|
|||
|
|
<doc>
|
|||
|
|
<assembly>
|
|||
|
|
<name>ZhiYi.Core.Api</name>
|
|||
|
|
</assembly>
|
|||
|
|
<members>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.Controllers.CaptchaController">
|
|||
|
|
<summary>
|
|||
|
|
验证码管理
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.CaptchaController.#ctor(ZhiYi.Core.Application.Services.ICaptchaAppService)">
|
|||
|
|
<summary>
|
|||
|
|
|
|||
|
|
</summary>
|
|||
|
|
<param name="captchaAppService"></param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.CaptchaController.GetCaptchaAsync">
|
|||
|
|
<summary>
|
|||
|
|
获取验证码
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.Controllers.GroupController">
|
|||
|
|
<summary>
|
|||
|
|
组管理
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.GroupController.CreateAsync(ZhiYi.Core.Application.Dtos.Group.GroupCreationDto)">
|
|||
|
|
<summary>
|
|||
|
|
创建组
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.GroupController.UpdateAsync(ZhiYi.Core.Application.Dtos.Group.GroupUpdationDto)">
|
|||
|
|
<summary>
|
|||
|
|
更改组名
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.GroupController.DeleteAsync(ZhiYi.Core.Application.Dtos.Group.GroupDeleteDto)">
|
|||
|
|
<summary>
|
|||
|
|
删除组
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.GroupController.GetListAsync(System.Int64)">
|
|||
|
|
<summary>
|
|||
|
|
获取组列表
|
|||
|
|
</summary>
|
|||
|
|
<param name="userid">账号ID</param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.Controllers.ServerController">
|
|||
|
|
<summary>
|
|||
|
|
服务器管理
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.ServerController.CreateAsync(ZhiYi.Core.Application.Dtos.Server.ServerCreationDto)">
|
|||
|
|
<summary>
|
|||
|
|
创建服务器
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.ServerController.UpdateAsync(ZhiYi.Core.Application.Dtos.Server.ServerUpdationDto)">
|
|||
|
|
<summary>
|
|||
|
|
更新服务器
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.ServerController.DeleteAsync(ZhiYi.Core.Application.Dtos.Server.ServerDeleteDto)">
|
|||
|
|
<summary>
|
|||
|
|
删除服务器
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.ServerController.GetListAsync(System.Int64)">
|
|||
|
|
<summary>
|
|||
|
|
获取服务器列表
|
|||
|
|
</summary>
|
|||
|
|
<param name="groupid">组ID</param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.Controllers.SharedController">
|
|||
|
|
<summary>
|
|||
|
|
分享管理
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.SharedController.CreateAsync(ZhiYi.Core.Application.Dtos.Shared.SharedCreationDto)">
|
|||
|
|
<summary>
|
|||
|
|
创建分享
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.SharedController.GetListAsync(System.Int64)">
|
|||
|
|
<summary>
|
|||
|
|
获取个人分享列表
|
|||
|
|
</summary>
|
|||
|
|
<param name="id">分享账号ID</param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.SharedController.UseShared(ZhiYi.Core.Application.Dtos.Shared.UseSharedCodeDto)">
|
|||
|
|
<summary>
|
|||
|
|
使用分享码
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.SharedController.DeleteBatchAsync(ZhiYi.Core.Application.Dtos.Shared.SharedDeleteDto)">
|
|||
|
|
<summary>
|
|||
|
|
批量删除分享码
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.Controllers.UserController">
|
|||
|
|
<summary>
|
|||
|
|
用户管理
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.UserController.#ctor(ZhiYi.Core.Application.Services.IUserAppService)">
|
|||
|
|
<summary>
|
|||
|
|
|
|||
|
|
</summary>
|
|||
|
|
<param name="userAppService"></param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.UserController.LoginAsync(ZhiYi.Core.Application.Dtos.UserLoginDto)">
|
|||
|
|
<summary>
|
|||
|
|
验证码登录
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.UserController.RegisterAsync(ZhiYi.Core.Application.Dtos.UserCreationDto)">
|
|||
|
|
<summary>
|
|||
|
|
注册
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.UserController.UserList">
|
|||
|
|
<summary>
|
|||
|
|
用户列表
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.Controllers.UserController.GetSignature(ZhiYi.Core.Application.Dtos.SignatureCreationDto)">
|
|||
|
|
<summary>
|
|||
|
|
获取签名
|
|||
|
|
</summary>
|
|||
|
|
<param name="input"></param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.CaptchaReflection">
|
|||
|
|
<summary>Holder for reflection information generated from GrpcService/Protos/captcha.proto</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.CaptchaReflection.Descriptor">
|
|||
|
|
<summary>File descriptor for GrpcService/Protos/captcha.proto</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.AppSecretFieldNumber">
|
|||
|
|
<summary>Field number for the "app_secret" field.</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.AppSecret">
|
|||
|
|
<summary>
|
|||
|
|
密钥
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.PathFieldNumber">
|
|||
|
|
<summary>Field number for the "path" field.</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.Path">
|
|||
|
|
<summary>
|
|||
|
|
请求路由
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.AccessTokenFieldNumber">
|
|||
|
|
<summary>Field number for the "access_token" field.</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureRequest.AccessToken">
|
|||
|
|
<summary>
|
|||
|
|
令牌
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureResponse">
|
|||
|
|
<summary>
|
|||
|
|
获取签名响应定义
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.GetSignatureResponse.SignStrFieldNumber">
|
|||
|
|
<summary>Field number for the "sign_str" field.</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService">
|
|||
|
|
<summary>
|
|||
|
|
获取签
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.Descriptor">
|
|||
|
|
<summary>Service descriptor</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.SignatureServiceBase">
|
|||
|
|
<summary>Base class for server-side implementations of SignatureService</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.BindService(ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.SignatureServiceBase)">
|
|||
|
|
<summary>Creates service definition that can be registered with a server</summary>
|
|||
|
|
<param name="serviceImpl">An object implementing the server-side handling logic.</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.BindService(Grpc.Core.ServiceBinderBase,ZhiYi.Core.Api.GrpcService.Protos.CaptchaServerProtobufs.SignatureService.SignatureServiceBase)">
|
|||
|
|
<summary>Register service method with a service binder with or without implementation. Useful when customizing the service binding logic.
|
|||
|
|
Note: this method is part of an experimental API that can change or be removed without any prior notice.</summary>
|
|||
|
|
<param name="serviceBinder">Service methods will be bound by calling <c>AddMethod</c> on this object.</param>
|
|||
|
|
<param name="serviceImpl">An object implementing the server-side handling logic.</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoints">
|
|||
|
|
<summary>
|
|||
|
|
Gets or sets the endpoints for the Kestrel server.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Limits">
|
|||
|
|
<summary>
|
|||
|
|
文件大小限制配置
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoint">
|
|||
|
|
<summary>
|
|||
|
|
Represents an endpoint for the Kestrel server.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoint.Url">
|
|||
|
|
<summary>
|
|||
|
|
The URL associated with the endpoint.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoint.Protocols">
|
|||
|
|
<summary>
|
|||
|
|
The protocols associated with the endpoint. Defaults to "Http1AndHttp2" if not specified.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoint.#ctor">
|
|||
|
|
<summary>
|
|||
|
|
Initializes a new instance of the <see cref="T:ZhiYi.Core.Api.ServerConfig.KestrelOptions.Endpoint"/> class.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.GeneratorContainerAttribute">
|
|||
|
|
<summary>
|
|||
|
|
源生成容器特性
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:TouchSocket.Core.BaseInjectAttribute.FromType">
|
|||
|
|
<summary>
|
|||
|
|
注册类型
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:TouchSocket.Core.BaseInjectAttribute.ToType">
|
|||
|
|
<summary>
|
|||
|
|
实例类型
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:TouchSocket.Core.BaseInjectAttribute.Key">
|
|||
|
|
<summary>
|
|||
|
|
注册额外键
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.AutoInjectForSingletonAttribute">
|
|||
|
|
<summary>
|
|||
|
|
自动注入为单例。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.AutoInjectForTransientAttribute">
|
|||
|
|
<summary>
|
|||
|
|
自动注入为瞬时。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.AddSingletonInjectAttribute">
|
|||
|
|
<summary>
|
|||
|
|
添加单例注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddSingletonInjectAttribute.#ctor(System.Type,System.Type,System.String)">
|
|||
|
|
<summary>
|
|||
|
|
添加单例注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="fromType">注册类型</param>
|
|||
|
|
<param name="toType">实例类型</param>
|
|||
|
|
<param name="key">注册额外键</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddSingletonInjectAttribute.#ctor(System.Type)">
|
|||
|
|
<summary>
|
|||
|
|
添加单例注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="type">注册类型与实例类型一致</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddSingletonInjectAttribute.#ctor(System.Type,System.Type)">
|
|||
|
|
<summary>
|
|||
|
|
添加单例注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="fromType">注册类型</param>
|
|||
|
|
<param name="toType">实例类型</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.AddTransientInjectAttribute">
|
|||
|
|
<summary>
|
|||
|
|
添加瞬态注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddTransientInjectAttribute.#ctor(System.Type,System.Type,System.String)">
|
|||
|
|
<summary>
|
|||
|
|
添加瞬态注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="fromType">注册类型</param>
|
|||
|
|
<param name="toType">实例类型</param>
|
|||
|
|
<param name="key">注册额外键</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddTransientInjectAttribute.#ctor(System.Type)">
|
|||
|
|
<summary>
|
|||
|
|
添加瞬态注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="type">注册类型与实例类型一致</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.AddTransientInjectAttribute.#ctor(System.Type,System.Type)">
|
|||
|
|
<summary>
|
|||
|
|
添加瞬态注入。
|
|||
|
|
<para>
|
|||
|
|
该标签仅添加在继承<see cref="T:TouchSocket.Core.ManualContainer"/>的容器上时有用。
|
|||
|
|
</para>
|
|||
|
|
</summary>
|
|||
|
|
<param name="fromType">注册类型</param>
|
|||
|
|
<param name="toType">实例类型</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.FastSerializableAttribute">
|
|||
|
|
<summary>
|
|||
|
|
标识源生成Fast序列化相关的实现。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.GeneratorPackageAttribute">
|
|||
|
|
<summary>
|
|||
|
|
标识源生成<see cref="T:TouchSocket.Core.IPackage"/>的实现。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.PackageMemberAttribute">
|
|||
|
|
<summary>
|
|||
|
|
标识源生成<see cref="T:TouchSocket.Core.IPackage"/>成员的特性。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:TouchSocket.Core.PackageMemberAttribute.Behavior">
|
|||
|
|
<summary>
|
|||
|
|
生成行为。一般来说，对于非只读、非重写、且同时拥有get，set（可以私有）访问器的属性，会自动生成。
|
|||
|
|
对于字段，均不会自动生成。所以可以使用该设置，来指示生成器的生成行为。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:TouchSocket.Core.GeneratorPluginAttribute">
|
|||
|
|
<summary>
|
|||
|
|
使用源生成插件的调用。
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:TouchSocket.Core.GeneratorPluginAttribute.#ctor(System.Type)">
|
|||
|
|
<summary>
|
|||
|
|
使用源生成插件的调用。
|
|||
|
|
</summary>
|
|||
|
|
<param name="pluginType">插件名称，一般建议使用<see langword="typeof"/>解决。</param>
|
|||
|
|
</member>
|
|||
|
|
</members>
|
|||
|
|
</doc>
|