Yi.Framework.Rbac.Application.xml
22.9 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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<?xml version="1.0"?>
<doc>
<assembly>
<name>Yi.Framework.Rbac.Application</name>
</assembly>
<members>
<member name="T:Yi.Framework.Rbac.Application.ObjectMapping.RbacMapsterRegister">
<summary>
<c>Menu.ParentId</c> 实体为字符串，对外 DTO 仍为 <see cref="T:System.Guid"/>。
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.ValidationImageCaptcha(System.String,System.String)">
<summary>
校验图片登录验证码,无需和账号绑定
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostLoginAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.LoginInputVo)">
<summary>
登录
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostLoginAsync(System.Guid)">
<summary>
提供其他服务使用，根据用户id，直接返回token
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostRefreshAsync(System.String)">
<summary>
刷新token
</summary>
<param name="refresh_token"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.GetCaptchaImageAsync">
<summary>
生成验证码
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.ValidationPhone(System.String)">
<summary>
验证电话号码
</summary>
<param name="str_handset"></param>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostCaptchaPhoneForRegisterAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.PhoneCaptchaImageDto)">
<summary>
手机验证码-注册
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostCaptchaPhoneForRetrievePasswordAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.PhoneCaptchaImageDto)">
<summary>
手机验证码-找回密码
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostCaptchaPhoneForBindAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.PhoneCaptchaImageDto)">
<summary>
手机验证码-绑定
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostCaptchaPhoneAsync(Yi.Framework.Rbac.Domain.Shared.Enums.ValidationPhoneTypeEnum,Yi.Framework.Rbac.Application.Contracts.Dtos.Account.PhoneCaptchaImageDto)">
<summary>
手机验证码-需通过图形验证码
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.ValidationPhoneCaptchaAsync(Yi.Framework.Rbac.Domain.Shared.Enums.ValidationPhoneTypeEnum,System.Int64,System.String)">
<summary>
校验电话验证码，需要与电话号码绑定
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostRetrievePasswordAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RetrievePasswordDto)">
<summary>
找回密码
</summary>
<param name="input"></param>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostRegisterAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto)">
<summary>
注册，需要验证码通过
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostTempRegisterAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RegisterDto)">
<summary>
临时注册
不需要验证，为了给第三方使用，例如微信小程序，后续可通过绑定操作，进行账号合并
</summary>
<param name="input"></param>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.GetAsync">
<summary>
查询已登录的账户信息
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.GetVue3Router(System.String)">
<summary>
获取当前登录用户的前端路由
支持ruoyi/pure
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.PostLogout">
<summary>
退出登录
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.UpdatePasswordAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.UpdatePasswordDto)">
<summary>
更新密码
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.RestPasswordAsync(System.Guid,Yi.Framework.Rbac.Application.Contracts.Dtos.Account.RestPasswordDto)">
<summary>
重置密码
</summary>
<param name="userId"></param>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.AccountService.UpdateIconAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.UpdateIconDto)">
<summary>
更新头像
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.Authentication.AuthService">
<summary>
第三方授权服务
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Authentication.AuthService.AuthOauthLoginAsync(System.String,System.String)">
<summary>
第三方oauth登录
</summary>
<param name="scheme"></param>
<param name="code">code是为了swagger更好的处理和显示</param>
<returns></returns>
<exception cref="T:Volo.Abp.UserFriendlyException"></exception>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Authentication.AuthService.AuthOauthBindAsync(System.String,System.String)">
<summary>
第三方oauth绑定
</summary>
<param name="scheme"></param>
<param name="code">code是为了swagger更好的处理和显示</param>
<returns></returns>
<exception cref="T:Volo.Abp.UserFriendlyException"></exception>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Authentication.AuthService.GetListAccountAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Account.AuthGetListInput)">
<summary>
获取当前账户的授权信息
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Authentication.AuthService.DeleteAsync(System.Collections.Generic.IEnumerable{System.Guid})">
<summary>
删除第三方授权
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.ConfigService">
<summary>
Config服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.ConfigService.GetListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Config.ConfigGetListInputVo)">
<summary>
多查
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.ConfigService.GetConfigKeyAsync(System.String)">
<summary>
根据key查配置
</summary>
<param name="key"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.DictionaryService">
<summary>
Dictionary服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.DictionaryService.GetListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Dictionary.DictionaryGetListInputVo)">
<summary>
查询
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.DictionaryService.GetDicType(System.String)">
<summary>
根据字典类型获取字典列表
</summary>
<param name="dicType"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.DictionaryTypeService">
<summary>
DictionaryType服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.FileService.Get(System.Guid,System.Nullable{System.Boolean})">
<summary>
下载文件,支持缩略图
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.FileService.Post(Microsoft.AspNetCore.Http.IFormFileCollection)">
<summary>
上传文件
</summary>
<returns></returns>
</member>
<member name="P:Yi.Framework.Rbac.Application.Services.Monitor.MonitorCacheService.CacheKeyPrefix">
<summary>
缓存前缀
</summary>
</member>
<member name="P:Yi.Framework.Rbac.Application.Services.Monitor.MonitorCacheService.RedisClient">
<summary>
使用懒加载防止报错
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Monitor.MonitorCacheService.GetName">
<summary>
获取所有key并分组
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Monitor.OnlineService.GetListAsync(Yi.Framework.Rbac.Domain.Shared.Model.OnlineUserModel)">
<summary>
动态条件获取当前在线用户
</summary>
<param name="online"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.Monitor.OnlineService.ForceOut(System.String)">
<summary>
强制退出用户
</summary>
<param name="connnectionId"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.NoticeService">
<summary>
Notice服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.NoticeService.GetListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Notice.NoticeGetListInput)">
<summary>
多查
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.NoticeService.SendOnlineAsync(System.Guid)">
<summary>
发送在线消息
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.NoticeService.SendOfflineAsync(System.Guid)">
<summary>
发送离线消息
</summary>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.RecordLog.OperationLogService">
<summary>
OperationLog服务实现
</summary>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.System.DeptService">
<summary>
Dept服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetRoleIdAsync(System.Guid)">
<summary>
通过角色id查询该角色全部部门
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Dept.DeptGetListInputVo)">
<summary>
多查
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetAllListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Dept.DeptGetListInputVo)">
<summary>
多查
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetTreeAsync">
<summary>
获取树形结构的部门列表
</summary>
<returns>树形结构的部门列表</returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetListExcludeAsync(System.Guid)">
<summary>
获取排除指定部门及其子孙部门的部门列表
</summary>
<param name="id">要排除的部门ID</param>
<returns>排除后的部门列表</returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetAllChildrenIdsAsync(System.Guid)">
<summary>
递归获取指定部门的所有子孙部门ID
</summary>
<param name="deptId">部门ID</param>
<returns>所有子孙部门ID列表</returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.DeptService.GetChildrenIdsRecursive(System.Guid,System.Collections.Generic.List{Yi.Framework.Rbac.Domain.Entities.DeptAggregateRoot},System.Collections.Generic.List{System.Guid})">
<summary>
递归辅助方法：获取子孙部门ID
</summary>
<param name="parentId">父部门ID</param>
<param name="allDepts">所有部门列表</param>
<param name="result">结果列表</param>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.System.MenuService">
<summary>
Menu服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.MenuService.GetListRoleIdAsync(System.Guid)">
<summary>
查询当前角色的菜单
</summary>
<param name="roleId"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.MenuService.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.Services.System.MenuService.GetTreeAsync">
<summary>
获取菜单树
</summary>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.System.PostService">
<summary>
Post服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.PostService.UpdateStateAsync(System.Guid,System.Boolean)">
<summary>
更新状态
</summary>
<param name="id"></param>
<param name="state"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.System.RoleService">
<summary>
Role服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.CreateAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleCreateInputVo)">
<summary>
添加角色
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.UpdateAsync(System.Guid,Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleUpdateInputVo)">
<summary>
修改角色
</summary>
<param name="id"></param>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.UpdateStateAsync(System.Guid,System.Boolean)">
<summary>
更新状态
</summary>
<param name="id"></param>
<param name="state"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.GetAuthUserByRoleIdAsync(System.Guid,System.Boolean,Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleAuthUserGetListInput)">
<summary>
获取角色下的用户
</summary>
<param name="roleId"></param>
<param name="input"></param>
<param name="isAllocated">是否在该角色下</param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.CreateAuthUserAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleAuthUserCreateOrDeleteInput)">
<summary>
批量给用户授权
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.DeleteAuthUserAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.Role.RoleAuthUserCreateOrDeleteInput)">
<summary>
批量取消授权
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.GetMenuTreeAsync(System.Guid)">
<summary>
获取角色菜单树
</summary>
<param name="roleId"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.RoleService.GetDeptTreeAsync(System.Guid)">
<summary>
获取角色部门树
</summary>
<param name="roleId"></param>
<returns></returns>
</member>
<member name="T:Yi.Framework.Rbac.Application.Services.System.UserService">
<summary>
User服务实现
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.GetListAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.User.UserGetListInputVo)">
<summary>
查询用户
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.CreateAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.User.UserCreateInputVo)">
<summary>
添加用户
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.GetAsync(System.Guid)">
<summary>
单查
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.UpdateAsync(System.Guid,Yi.Framework.Rbac.Application.Contracts.Dtos.User.UserUpdateInputVo)">
<summary>
更新用户
</summary>
<param name="id"></param>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.UpdateProfileAsync(Yi.Framework.Rbac.Application.Contracts.Dtos.User.ProfileUpdateInputVo)">
<summary>
更新个人中心
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.UpdateStateAsync(System.Guid,System.Boolean)">
<summary>
更新状态
</summary>
<param name="id"></param>
<param name="state"></param>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.Services.System.UserService.GetUsersByDeptAsync(System.Guid)">
<summary>
获取指定部门及其所有子部门下的用户列表
</summary>
<param name="deptId">部门ID</param>
<returns>用户列表</returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.SignalRHubs.NoticeHub.#ctor">
<summary>
由于发布功能，主要是服务端项客户端主动推送
</summary>
</member>
<member name="M:Yi.Framework.Rbac.Application.SignalRHubs.OnlineHub.OnConnectedAsync">
<summary>
成功连接
</summary>
<returns></returns>
</member>
<member name="M:Yi.Framework.Rbac.Application.SignalRHubs.OnlineHub.OnDisconnectedAsync(System.Exception)">
<summary>
断开连接
</summary>
<param name="exception"></param>
<returns></returns>
</member>
</members>
</doc>