GrapeCity.Forguncy.ServerApi.IUserInfos

接口 IUserInfos

提供用于管理用户帐户的方法。

命名空间: GrapeCity.Forguncy.ServerApi

程序集: GrapeCity.Forguncy.ServerApi.dll

语法

public interface IUserInfos

属性

AuthenticationMode

认证模式

声明

AuthMode AuthenticationMode { get; }

属性值

类型	描述
AuthMode

UserServiceURL

活字格服务器Url

声明

string UserServiceURL { get; }

属性值

类型	描述
string

方法

AddOrganizationAsync(string, int?, int?)

添加组织机构

声明

Task<int> AddOrganizationAsync(string organizationName, int? parentOrganizationId, int? organizationLevelId)

参数

类型	名称	描述
string	organizationName	组织机构名称
int?	parentOrganizationId	父组织机构 ID
int?	organizationLevelId	组织机构级别 ID

返回值

类型	描述
System.Threading.Tasks.Task<TResult><int>	新创建组织的 ID

AddOrganizationAsync(string, string, string)

添加组织机构

声明

Task AddOrganizationAsync(string organizationName, string parentOrganizationPath, string organizationLevel)

参数

类型	名称	描述
string	organizationName	组织机构名称
string	parentOrganizationPath	父组织机构路径
string	organizationLevel	组织机构级别

返回值

类型	描述
System.Threading.Tasks.Task

AddOrganizationLeadersAsync(int, IEnumerable<string>)

为组织添加主管

声明

Task AddOrganizationLeadersAsync(int organizationId, IEnumerable<string> userNames)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	添加的主管名称列表

返回值

类型	描述
System.Threading.Tasks.Task

AddOrganizationLevelAsync(string)

添加组织机构级别

声明

Task AddOrganizationLevelAsync(string organizationLevelName)

参数

类型	名称	描述
string	organizationLevelName	组织机构级别名称

返回值

类型	描述
System.Threading.Tasks.Task

AddOrganizationMembersRolesAsync(int, IEnumerable<string>, IEnumerable<int>)

为组织成员添加组织角色

声明

Task AddOrganizationMembersRolesAsync(int organizationId, IEnumerable<string> userNames, IEnumerable<int> roleIds)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

AddOrganizationsToRolesAsync(IEnumerable<int>, IEnumerable<int>, bool?)

添加组织到角色

声明

Task AddOrganizationsToRolesAsync(IEnumerable<int> roleIds, IEnumerable<int> organizationIds, bool? isEffectedForSubOrganizations)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表
bool?	isEffectedForSubOrganizations	是否对子组织生效，如果不传或为false，则表示不对下级组织生效；如果为true，则表示对下级组织生效

返回值

类型	描述
System.Threading.Tasks.Task

AddRoleAsync(string, string, int?)

添加角色

声明

Task<int> AddRoleAsync(string roleName, string description, int? folderId)

参数

类型	名称	描述
string	roleName	角色名称
string	description	描述
int?	folderId	分类 ID

返回值

类型	描述
System.Threading.Tasks.Task<TResult><int>	新创建角色的 ID

AddRoleFolderAsync(string, int?)

添加角色分类

声明

Task<int> AddRoleFolderAsync(string folderName, int? parentFolderId)

参数

类型	名称	描述
string	folderName	分类名称
int?	parentFolderId	上级分类 ID

返回值

类型	描述
System.Threading.Tasks.Task<TResult><int>	新创建分类的 ID

AddRoleOwnedPermissionsAsync(int, IEnumerable<int>, int)

添加角色拥有权限

声明

Task AddRoleOwnedPermissionsAsync(int roleId, IEnumerable<int> ownedRoleIds, int type)

参数

类型	名称	描述
int	roleId	角色 ID
System.Collections.Generic.IEnumerable<T><int>	ownedRoleIds	拥有权限的角色 ID 列表
int	type	类型，0——拥有角色权限；1——被角色拥有权限

返回值

类型	描述
System.Threading.Tasks.Task

AddUser(string, string, string, string, Dictionary<string, string>)

添加用户帐户。

声明

void AddUser(string userName, string password, string email, string displayName, Dictionary<string, string> extendedPropertyList)

参数

类型	名称	描述
string	userName	用户名
string	password	密码
string	email	邮件地址
string	displayName	显示名称
System.Collections.Generic.Dictionary<TKey, TValue><string, string>	extendedPropertyList	扩展属性列表

示例

指定注册所需的信息并添加一个用户帐户。

public class SampleApi : ForguncyApi
{
    [Get]
    public void TestAddUser()
    {
    var dic = new Dictionary<string, string>();
    dic.Add("上级", "Administrator");//设定名为'上级'、'头衔'的扩展属性的值
    dic.Add("头衔", "产品经理");
    this.UserInfos.AddUser("testUser1", "123456", "example1@example.com", "测试人员", dic);
    }
}

AddUserAsync(string, string, string, string, Dictionary<string, string>)

添加用户帐户。

声明

Task AddUserAsync(string userName, string password, string email, string displayName, Dictionary<string, string> extendedPropertyList)

参数

类型	名称	描述
string	userName	用户名
string	password	密码
string	email	邮件地址
string	displayName	显示名称
System.Collections.Generic.Dictionary<TKey, TValue><string, string>	extendedPropertyList	扩展属性列表

返回值

类型	描述
System.Threading.Tasks.Task

示例

指定注册所需的信息并添加一个用户帐户。

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestAddUser()
    {
        var dic = new Dictionary<string, string>();
        dic.Add("上级", "Administrator");//设定名为'上级'、'头衔'的扩展属性的值
        dic.Add("头衔", "产品经理");
        await this.UserInfos.AddUserAsync("testUser1", "123456", "example1@example.com","测试人员", dic);
    }
}

AddUsersToOrganizationAsync(string, IEnumerable<OrganizationMember>)

将用户添加到组织机构

声明

Task AddUsersToOrganizationAsync(string organizationPath, IEnumerable<OrganizationMember> organizationMembers)

参数

类型	名称	描述
string	organizationPath	组织机构路径
System.Collections.Generic.IEnumerable<T><OrganizationMember>	organizationMembers	组织机构成员列表

返回值

类型	描述
System.Threading.Tasks.Task

AddUsersToOrganizationsAsync(IEnumerable<int>, IEnumerable<string>)

将用户添加到组织机构

声明

Task AddUsersToOrganizationsAsync(IEnumerable<int> organizationIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织机构 ID 列表
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

AddUsersToRoleAsync(string, IEnumerable<string>)

将用户添加到角色

声明

Task AddUsersToRoleAsync(string roleName, IEnumerable<string> userNames)

参数

类型	名称	描述
string	roleName	角色名称
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

AddUsersToRolesAsync(IEnumerable<int>, IEnumerable<string>)

添加用户到角色

声明

Task AddUsersToRolesAsync(IEnumerable<int> roleIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

ClearCache()

清空活字格中的用户信息缓存

声明

void ClearCache()

示例

public class SampleApi : ForguncyApi
{
    [Get]
    public void TestClearCache()
    {
        this.UserInfos.ClearCache();
    }
}

DeleteOrganizationAsync(string)

删除组织机构

声明

Task DeleteOrganizationAsync(string organizationPath)

参数

类型	名称	描述
string	organizationPath	组织机构路径

返回值

类型	描述
System.Threading.Tasks.Task

DeleteOrganizationLevelAsync(string)

删除组织机构级别

声明

Task DeleteOrganizationLevelAsync(string organizationLevelName)

参数

类型	名称	描述
string	organizationLevelName	组织机构级别名称

返回值

类型	描述
System.Threading.Tasks.Task

DeleteOrganizationsAsync(IEnumerable<int>)

删除组织机构

声明

Task DeleteOrganizationsAsync(IEnumerable<int> organizationIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织机构 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

DeleteRoleFoldersAsync(IEnumerable<int>)

删除角色分类

声明

Task DeleteRoleFoldersAsync(IEnumerable<int> folderIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	folderIds	分类 ID

返回值

类型	描述
System.Threading.Tasks.Task

DeleteRolesAsync(IEnumerable<int>)

删除角色

声明

Task DeleteRolesAsync(IEnumerable<int> roleIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID

返回值

类型	描述
System.Threading.Tasks.Task

DeleteUser(string)

删除用户帐户。

声明

void DeleteUser(string userName)

参数

类型	名称	描述
string	userName	用户名

示例

通过用户名删除用户帐户。

public class SampleApi : ForguncyApi
{
    [Get]
    public void TestDeleteUser()
    {
        this.UserInfos.DeleteUser("testUser1");
    }
}

DeleteUserAsync(string)

删除用户帐户。

声明

Task DeleteUserAsync(string userName)

参数

类型	名称	描述
string	userName	用户名

返回值

类型	描述
System.Threading.Tasks.Task

示例

通过用户名删除用户帐户。

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestDeleteUser()
    {
        await this.UserInfos.DeleteUserAsync("testUser1");
    }
}

DeleteUsersAsync(IEnumerable<string>)

批量删除用户帐户。

声明

Task DeleteUsersAsync(IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名集合

返回值

类型	描述
System.Threading.Tasks.Task

示例

通过用户名集合批量删除用户帐户。

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestDeleteUsers()
    {
        var userNames = new string[] { "testUser1", "testUser2", "testUser3" };
        await this.UserInfos.DeleteUsersAsync(userNames);
    }
}

ExportToExcelAsync(string)

导出用户信息到Excel

声明

Task ExportToExcelAsync(string filePath)

参数

类型	名称	描述
string	filePath	导出文件

返回值

类型	描述
System.Threading.Tasks.Task

GetExtendedProperties()

获取自定义属性列表

声明

List<string> GetExtendedProperties()

返回值

类型	描述
System.Collections.Generic.List<T><string>	自定义属性列表

GetOrganizationLevels()

获取组织机构级别列表的方法

声明

List<string> GetOrganizationLevels()

返回值

类型	描述
System.Collections.Generic.List<T><string>	组织机构级别列表

GetOrganizationsAsync()

获取组织机构列表

声明

Task<List<OrganizationInfo>> GetOrganizationsAsync()

返回值

类型	描述
System.Threading.Tasks.Task<TResult><System.Collections.Generic.List<T><OrganizationInfo>>	组织机构列表

GetRolesAsync()

获取活字格中所有用户的角色

声明

Task<List<string>> GetRolesAsync()

返回值

类型	描述
System.Threading.Tasks.Task<TResult><System.Collections.Generic.List<T><string>>	包含所有用户角色名称的列表

示例

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestGetUserRoles()
    {
       var roles = await this.UserInfos.GetRolesAsync();
    }
}

GetRolesOfUserOwnedPermissionsAsync(string)

获取用户所拥有权限的角色

声明

Task<HashSet<string>> GetRolesOfUserOwnedPermissionsAsync(string userName)

参数

类型	名称	描述
string	userName	用户名

返回值

类型	描述
System.Threading.Tasks.Task<TResult><HashSet<string>>	包含角色名称的哈希集合

GetUserInfoAsync(string)

获取指定用户的用户帐户信息。

声明

Task<UserInfo> GetUserInfoAsync(string userName)

参数

类型	名称	描述
string	userName

返回值

类型	描述
System.Threading.Tasks.Task<TResult><UserInfo>

示例

以下代码示例获取用户帐户信息并将其打印到控制台。

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestGetUser()
    {
        var userInfo = await this.UserInfos.GetUserInfoAsync("TestUser");
        Console.Write(userInfo.UserName);
        Console.Write(userInfo.Email);
        Console.Write(userInfo.GetPropertyValue("Title"));
    }
}

GetUserInfos()

获取所有注册的Forguncy用户帐户信息。

声明

[Obsolete("GetUserInfos is deprecated, please use GetUserInfosAsync instead")]
List<UserInfo> GetUserInfos()

返回值

类型	描述
System.Collections.Generic.List<T><UserInfo>

示例

以下代码示例检索所有Forguncy用户帐户信息并将其打印到控制台。

public class SampleApi : ForguncyApi
{
    [Get]
    public void TestGetUser()
    {
        var userInfos = this.UserInfos.GetUserInfos();
        for (int i = 0; i < userInfos.Count; i++)

        {
            var userInfo = userInfos[i];
            Console.Write(userInfo.UserName);
            Console.Write(userInfo.Email);
            Console.Write(userInfo.GetPropertyValue("上级")); //获取名为'上级'的扩展属性
        }
    }
}

GetUserInfosAsync()

获取所有注册的用户帐户信息。

声明

Task<List<UserInfo>> GetUserInfosAsync()

返回值

类型	描述
System.Threading.Tasks.Task<TResult><System.Collections.Generic.List<T><UserInfo>>

示例

以下代码示例检索所有用户帐户信息并将其打印到控制台。

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestGetUser()
    {
        var userInfos = await this.UserInfos.GetUserInfosAsync();
        for (int i = 0; i < userInfos.Count; i++)

        {
            var userInfo = userInfos[i];
            Console.Write(userInfo.UserName);
            Console.Write(userInfo.Email);
            Console.Write(userInfo.GetPropertyValue("上级")); //获取名为'上级'的扩展属性
        }
    }
}

GetUserNameByExtendedPropertyAsync(string, string)

通过扩展属性值获取用户名。

声明

Task<string> GetUserNameByExtendedPropertyAsync(string extendedPropertyName, string value)

参数

类型	名称	描述
string	extendedPropertyName	扩展属性名
string	value	扩展属性值

返回值

类型	描述
System.Threading.Tasks.Task<TResult><string>	基于扩展属性值找到的第一个用户名，如果找不到特定用户，则返回值为 null。

GetValidateErrorAsync(string, string)

验证用户名密码，如果失败，返回错误信息。

声明

Task<string> GetValidateErrorAsync(string userName, string password)

参数

类型	名称	描述
string	userName	用户名
string	password	密码

返回值

类型	描述
System.Threading.Tasks.Task<TResult><string>	验证错误信息。

ImportFromExcelAsync(string, int)

从Excel文件导入用户信息

声明

Task<string> ImportFromExcelAsync(string fileName, int mode)

参数

类型	名称	描述
string	fileName	导入文件
int	mode	导入模式，0为合并导入，1为覆盖导入

返回值

类型	描述
System.Threading.Tasks.Task<TResult><string>	导入结果信息汇总

LoginAsync(HttpContext, string, bool)

声明

Task LoginAsync(HttpContext context, string userName, bool rememberMe)

参数

类型	名称	描述
Microsoft.AspNetCore.Http.HttpContext	context	Http上下文
string	userName	用户名
bool	rememberMe	关闭浏览器后是否保存登录状态

返回值

类型	描述
System.Threading.Tasks.Task

LogoutAsync(HttpContext)

登出

声明

Task LogoutAsync(HttpContext context)

参数

类型	名称	描述
Microsoft.AspNetCore.Http.HttpContext	context	Http上下文

返回值

类型	描述
System.Threading.Tasks.Task

MoveEntireOrganizationAsync(int, int, int)

移动整个组织机构

声明

Task MoveEntireOrganizationAsync(int organizationId, int targetOrganizationId, int type)

参数

类型	名称	描述
int	organizationId	组织机构 ID
int	targetOrganizationId	目标组织机构 ID
int	type	类型，-1——移动到目标节点之上；0——移动到目标节点内；1——移动到目标节点之下。

返回值

类型	描述
System.Threading.Tasks.Task

MoveEntireOrganizationAsync(string, string)

移动整个组织机构

声明

Task MoveEntireOrganizationAsync(string organizationPath, string newParentOrganizationPath)

参数

类型	名称	描述
string	organizationPath	组织机构路径
string	newParentOrganizationPath	新的父组织机构路径

返回值

类型	描述
System.Threading.Tasks.Task

MoveRoleOrFolderAsync(int, bool, int, bool, int)

移动角色或分类

声明

Task MoveRoleOrFolderAsync(int dragNodeId, bool isDraggedRole, int dropNodeId, bool isDroppedRole, int moveType)

参数

类型	名称	描述
int	dragNodeId	拖动的节点 ID
bool	isDraggedRole	拖拽的节点是否为角色
int	dropNodeId	放置的节点 ID
bool	isDroppedRole	放置的节点是否为角色
int	moveType	移动类型，-1：目标节点前边，0：目标节点里边，1：目标后边

返回值

类型	描述
System.Threading.Tasks.Task

RemoveOrganizationLeadersAsync(int, IEnumerable<string>)

为组织移除主管

声明

Task RemoveOrganizationLeadersAsync(int organizationId, IEnumerable<string> userNames)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	移除的主管名称列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveOrganizationMembersRolesAsync(int, IEnumerable<string>, IEnumerable<int>)

为组织成员移除组织角色

声明

Task RemoveOrganizationMembersRolesAsync(int organizationId, IEnumerable<string> userNames, IEnumerable<int> roleIds)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveOrganizationsFromRolesAsync(IEnumerable<int>, IEnumerable<int>)

从角色中移除组织

声明

Task RemoveOrganizationsFromRolesAsync(IEnumerable<int> roleIds, IEnumerable<int> organizationIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveRoleOwnedPermissionsAsync(int, IEnumerable<int>, int)

移除角色拥有权限

声明

Task RemoveRoleOwnedPermissionsAsync(int roleId, IEnumerable<int> ownedRoleIds, int type)

参数

类型	名称	描述
int	roleId	角色 ID
System.Collections.Generic.IEnumerable<T><int>	ownedRoleIds	拥有权限的角色 ID 列表
int	type	类型，0——拥有角色权限；1——被角色拥有权限

返回值

类型	描述
System.Threading.Tasks.Task

RemoveUsersFromOrganizationAsync(string, IEnumerable<string>)

从组织机构中移除用户

声明

Task RemoveUsersFromOrganizationAsync(string organizationPath, IEnumerable<string> userNames)

参数

类型	名称	描述
string	organizationPath	组织机构路径
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveUsersFromOrganizationsAsync(IEnumerable<int>, IEnumerable<string>)

从组织机构中移除用户

声明

Task RemoveUsersFromOrganizationsAsync(IEnumerable<int> organizationIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织机构 ID 列表
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveUsersFromRoleAsync(string, IEnumerable<string>)

从角色中移除用户

声明

Task RemoveUsersFromRoleAsync(string roleName, IEnumerable<string> userNames)

参数

类型	名称	描述
string	roleName	角色名称
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

RemoveUsersFromRolesAsync(IEnumerable<int>, IEnumerable<string>)

从角色中移除用户

声明

Task RemoveUsersFromRolesAsync(IEnumerable<int> roleIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

SetOrganizationLeadersAsync(int, IEnumerable<string>)

为组织设置主管

声明

Task SetOrganizationLeadersAsync(int organizationId, IEnumerable<string> userNames)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	设置的主管名称列表

返回值

类型	描述
System.Threading.Tasks.Task

SetOrganizationMembersRolesAsync(int, IEnumerable<string>, IEnumerable<int>)

为组织成员设置组织角色

声明

Task SetOrganizationMembersRolesAsync(int organizationId, IEnumerable<string> userNames, IEnumerable<int> roleIds)

参数

类型	名称	描述
int	organizationId	组织 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

SetOrganizationsForRolesAsync(IEnumerable<int>, IEnumerable<int>, bool?)

为角色设置组织

声明

Task SetOrganizationsForRolesAsync(IEnumerable<int> roleIds, IEnumerable<int> organizationIds, bool? isEffectedForSubOrganizations)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表
bool?	isEffectedForSubOrganizations	是否对子组织生效，如果不传或为false，则表示不对下级组织生效；如果为true，则表示对下级组织生效

返回值

类型	描述
System.Threading.Tasks.Task

SetOrganizationsForUsersAsync(IEnumerable<string>, IEnumerable<int>)

为用户设置组织

声明

Task SetOrganizationsForUsersAsync(IEnumerable<string> userNames, IEnumerable<int> organizationIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表

返回值

类型	描述
System.Threading.Tasks.Task

SetRoleOwnedPermissionsAsync(int, IEnumerable<int>, int)

设置角色拥有权限

声明

Task SetRoleOwnedPermissionsAsync(int roleId, IEnumerable<int> ownedRoleIds, int type)

参数

类型	名称	描述
int	roleId	角色 ID
System.Collections.Generic.IEnumerable<T><int>	ownedRoleIds	拥有权限的角色 ID 列表
int	type	类型，0——拥有角色权限；1——被角色拥有权限

返回值

类型	描述
System.Threading.Tasks.Task

SetRolesForOrganizationsAsync(IEnumerable<int>, IEnumerable<int>, bool?)

为组织设置角色

声明

Task SetRolesForOrganizationsAsync(IEnumerable<int> organizationIds, IEnumerable<int> roleIds, bool? isEffectedForSubOrganizations)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID 列表
bool?	isEffectedForSubOrganizations	是否对子组织生效，如果不传或为false，则表示不对下级组织生效；如果为true，则表示对下级组织生效

返回值

类型	描述
System.Threading.Tasks.Task

SetRolesForUsersAsync(IEnumerable<string>, IEnumerable<int>)

为用户批量设置角色

声明

Task SetRolesForUsersAsync(IEnumerable<string> userNames, IEnumerable<int> roleIds)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID

返回值

类型	描述
System.Threading.Tasks.Task

SetUsersForOrganizationsAsync(IEnumerable<int>, IEnumerable<string>)

为组织设置用户

声明

Task SetUsersForOrganizationsAsync(IEnumerable<int> organizationIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	organizationIds	组织 ID 列表
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

SetUsersForRolesAsync(IEnumerable<int>, IEnumerable<string>)

为角色批量设置用户

声明

Task SetUsersForRolesAsync(IEnumerable<int> roleIds, IEnumerable<string> userNames)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><int>	roleIds	角色 ID
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名列表

返回值

类型	描述
System.Threading.Tasks.Task

SetUsersPasswordAsync(IEnumerable<string>, string)

设置用户密码。

声明

Task SetUsersPasswordAsync(IEnumerable<string> userNames, string password)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名
string	password	密码

返回值

类型	描述
System.Threading.Tasks.Task

SetUsersValidityAsync(IEnumerable<string>, bool)

设置用户有效性。

声明

Task SetUsersValidityAsync(IEnumerable<string> userNames, bool isValid)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	userNames	用户名
bool	isValid	有效性

返回值

类型	描述
System.Threading.Tasks.Task

UpdateOrganizationAsync(int, string, int?, int?)

更新组织机构信息

声明

Task UpdateOrganizationAsync(int organizationId, string organizationName, int? parentOrganizationId, int? organizationLevelId)

参数

类型	名称	描述
int	organizationId	组织机构 ID
string	organizationName	组织机构名称
int?	parentOrganizationId	父组织机构 ID
int?	organizationLevelId	组织机构级别 ID

返回值

类型	描述
System.Threading.Tasks.Task

UpdateOrganizationInfoAsync(string, string, string, string)

更新组织机构信息

声明

Task UpdateOrganizationInfoAsync(string oldOrganizationName, string parentOrganizationPath, string newOrganizationName, string newOrganizationLevel)

参数

类型	名称	描述
string	oldOrganizationName	旧的组织机构名称
string	parentOrganizationPath	父组织机构路径
string	newOrganizationName	新的组织机构名称
string	newOrganizationLevel	新的组织机构级别

返回值

类型	描述
System.Threading.Tasks.Task

UpdateOrganizationLevelAsync(string, string)

更新组织机构级别

声明

Task UpdateOrganizationLevelAsync(string oldOrganizationLevelName, string newOrganizationLevelName)

参数

类型	名称	描述
string	oldOrganizationLevelName	旧的组织机构级别名称
string	newOrganizationLevelName	新的组织机构级别名称

返回值

类型	描述
System.Threading.Tasks.Task

UpdateRoleAsync(int, string, string, int?)

更新角色

声明

Task UpdateRoleAsync(int roleId, string roleName, string description, int? folderId)

参数

类型	名称	描述
int	roleId	角色 ID
string	roleName	角色名称
string	description	描述
int?	folderId	分类 ID

返回值

类型	描述
System.Threading.Tasks.Task

UpdateRoleFolderAsync(int, string, int?)

更新角色分类

声明

Task UpdateRoleFolderAsync(int folderId, string folderName, int? parentFolderId)

参数

类型	名称	描述
int	folderId	分类 ID
string	folderName	分类名称
int?	parentFolderId	上级分类 ID

返回值

类型	描述
System.Threading.Tasks.Task

UpdateUserAsync(string, string, string, Dictionary<string, string>)

更新用户帐户。

声明

Task UpdateUserAsync(string userName, string email, string displayName, Dictionary<string, string> extendedPropertyList)

参数

类型	名称	描述
string	userName	用户名
string	email	邮件地址
string	displayName	显示名称
System.Collections.Generic.Dictionary<TKey, TValue><string, string>	extendedPropertyList	扩展属性列表

返回值

类型	描述
System.Threading.Tasks.Task

示例

更新指定用户的信息

public class SampleApi : ForguncyApi
{
    [Get]
    public async Task TestUpdateUser()
    {
        var dic = new Dictionary<string, string>();
        dic.Add("Leader", "Administrator");
        dic.Add("Title", "Manager");
        await this.UserInfos.UpdateUserAsync("testUser1", "example1@example.com", "TestUser", dic);
    }
}

ValidateAsync(string, string)

验证用户名密码

声明

Task<bool> ValidateAsync(string userName, string password)

参数

类型	名称	描述
string	userName	用户名
string	password	密码

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否通过验证