Sys.Services RoleService IsUserinRole 属性

更新:2007 年 11 月

检查当前经过身份验证的用户是否具有指定的角色。

说明:

若要获取或设置客户端 API 属性的属性值,必须调用以 get_set_ 为名称前缀的属性访问器方法。例如,若要获取或设置属性 cancel 的值,需要调用 get_cancel 或 set_cancel 方法。

Sys.Services.RoleService.get_isUserInRole(role);

参数

参数

说明

role

要检查的角色的名称。

返回值

如果当前用户具有指定的角色,则为 true;否则为 false。

备注

在使用 IsUserInRole 属性之前,必须使用 load 方法加载角色。如果未加载任何角色,则此属性返回 false。

示例

下面的示例演示如何使用 IsUserInRole 属性检查经过身份验证的用户是否具有指定的角色。此代码摘自 RoleService 类概述中的一个完整示例。

// This function gets the role service path.
function GetRoleServicePath()
{
    // Get the role service path.
    var roleServicePath = 
        Sys.Services.RoleService.get_path();
    if (roleServicePath == "")
    {
        DisplayInformation(
            "The role service path is the default value.");
    }
}

请参见

概念

Sys.Services.AuthenticationService 类

Sys.Services.ProfileService 类