Yi.Framework.Rbac.Application.Contracts.xml
17.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
<?xml version="1.0"?>
<doc>
<assembly>
<name>Yi.Framework.Rbac.Application.Contracts</name>
</assembly>
<members>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.UserName">
<summary>
账号
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.Password">
<summary>
密码
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.Uuid">
<summary>
唯一标识码
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.Phone">
<summary>
电话
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.Code">
<summary>
验证码
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto.Nick">
<summary>
昵称
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RetrievePasswordDto.Password">
<summary>
密码
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RetrievePasswordDto.Uuid">
<summary>
唯一标识码
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RetrievePasswordDto.Phone">
<summary>
电话
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RetrievePasswordDto.Code">
<summary>
验证码
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigCreateInputVo">
<summary>
Config输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListInputVo">
<summary>
配置查询参数
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListInputVo.ConfigName">
<summary>
配置名称
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListInputVo.ConfigKey">
<summary>
配置键
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.ConfigName">
<summary>
配置名称
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.ConfigKey">
<summary>
配置主键
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.ConfigValue">
<summary>
配置值
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.ConfigType">
<summary>
配置类型
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.OrderNum">
<summary>
排序字段
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.Remark">
<summary>
备注
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListOutputDto.CreationTime">
<summary>
创建时间
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Dept.DeptCreateInputVo">
<summary>
Dept输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.DictionaryType.DictionaryTypeCreateInputVo">
<summary>
DictionaryType输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Dictionary.DictionaryCreateInputVo">
<summary>
Dictionary输入创建对象
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.LoginLog.LoginLogGetListOutputDto.LoginIp">
<summary>
登录Ip
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.LoginLog.LoginLogGetListOutputDto.Browser">
<summary>
浏览器
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.LoginLog.LoginLogGetListOutputDto.Os">
<summary>
操作系统
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.LoginLog.LoginLogGetListOutputDto.LogMsg">
<summary>
登录信息
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Menu.MenuCreateInputVo">
<summary>
Menu输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Notice.NoticeCreateInput">
<summary>
Notice输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Notice.NoticeGetListInput">
<summary>
查询参数
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Post.PostCreateInputVo">
<summary>
Post输入创建对象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleCreateInputVo">
<summary>
Role输入创建对象
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.JobId">
<summary>
作业 Id
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.GroupName">
<summary>
作业组名称
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.JobType">
<summary>
作业处理程序类型
</summary>
<remarks>存储的是类型的 FullName</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.AssemblyName">
<summary>
作业处理程序类型所在程序集
</summary>
<remarks>存储的是程序集 Name</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.Description">
<summary>
描述信息
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.Concurrent">
<summary>
是否采用并行执行
</summary>
<remarks>如果设置为 false，那么使用串行执行</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.IncludeAnnotations">
<summary>
是否扫描 IJob 实现类 [Trigger] 特性触发器
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.Properties">
<summary>
作业信息额外数据
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.LastRunTime">
<summary>
作业更新时间
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.Blocked">
<summary>
标记其他作业正在执行
</summary>
<remarks>当 <see cref="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.Concurrent"/> 为 false 时有效，也就是串行执行</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.RuntimeJobType">
<summary>
作业处理程序运行时类型
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.RuntimeProperties">
<summary>
作业信息额外数据运行时实例
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetListOutput.TriggerArgs">
<summary>
触发器参数
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.JobId">
<summary>
作业 Id
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.GroupName">
<summary>
作业组名称
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.JobType">
<summary>
作业处理程序类型
</summary>
<remarks>存储的是类型的 FullName</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.AssemblyName">
<summary>
作业处理程序类型所在程序集
</summary>
<remarks>存储的是程序集 Name</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.Description">
<summary>
描述信息
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.Concurrent">
<summary>
是否采用并行执行
</summary>
<remarks>如果设置为 false，那么使用串行执行</remarks>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.IncludeAnnotations">
<summary>
是否扫描 IJob 实现类 [Trigger] 特性触发器
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.Properties">
<summary>
作业信息额外数据
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.UpdatedTime">
<summary>
作业更新时间
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.Status">
<summary>
状态
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.Task.TaskGetOutput.Type">
<summary>
触发器类型
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.Dtos.User.UserCreateInputVo">
<summary>
User输入创建对象
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Contracts.Dtos.User.UserUpdateInputVo.Password">
<summary>
该成员需忽略
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IAccountService.GetAsync(System.String,System.Nullable{System.Int64})">
<summary>
根据信息查询用户，可能为空，代表该用户不存在或禁用
</summary>
<param name="userName"></param>
<param name="phone"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IAccountService.ValidationPhoneCaptchaAsync(Yi.Framework.Rbac.Domain.Shared.Enums.ValidationPhoneTypeEnum,System.Int64,System.String)">
<summary>
校验电话验证码，需要与电话号码绑定
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IAccountService.PostTempRegisterAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto)">
<summary>
临时注册
不需要验证，为了给第三方使用，例如微信小程序，后续可通过绑定操作，进行账号合并
</summary>
<param name="input"></param>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IConfigService">
<summary>
Config服务抽象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IDeptService">
<summary>
Dept服务抽象
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IDeptService.GetListExcludeAsync(System.Guid)">
<summary>
获取排除指定部门及其子孙部门的部门列表
</summary>
<param name="id">要排除的部门ID</param>
<returns>排除后的部门列表</returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IDictionaryService">
<summary>
Dictionary服务抽象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IDictionaryTypeService">
<summary>
DictionaryType服务抽象
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IFileService.Get(System.Guid,System.Nullable{System.Boolean})">
<summary>
下载文件,支持缩略图
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IFileService.Post(Microsoft.AspNetCore.Http.IFormFileCollection)">
<summary>
上传文件
</summary>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IMenuService">
<summary>
Menu服务抽象
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IMenuService.GetAllListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Menu.MenuGetListInputVo)">
<summary>
获取所有菜单
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IMenuService.GetTreeAsync">
<summary>
获取菜单树
</summary>
<returns>菜单树结构列表</returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.INoticeService">
<summary>
Notice服务抽象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IOperationLogService">
<summary>
OperationLog服务抽象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IPostService">
<summary>
Post服务抽象
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IRoleService">
<summary>
Role服务抽象
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IRoleService.GetMenuTreeAsync(System.Guid)">
<summary>
获取角色菜单树
</summary>
<param name="roleId">角色ID</param>
<returns>角色菜单树数据，包含已选中的菜单ID和菜单树结构</returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IRoleService.GetDeptTreeAsync(System.Guid)">
<summary>
获取角色部门树
</summary>
<param name="roleId">角色ID</param>
<returns>角色部门树数据，包含已选中的部门ID和部门树结构</returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Contracts.IServices.IUserService">
<summary>
User服务抽象
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Contracts.IServices.IUserService.GetUsersByDeptAsync(System.Guid)">
<summary>
获取指定部门及其所有子部门下的用户列表
</summary>
<param name="deptId">部门ID</param>
<returns>用户列表</returns>
</member>
</members>
</doc>