在 SharePoint 中使用 .NET 客户端对象模型检索用户配置文件属性

项目
06/29/2022

了解如何使用 SharePoint .NET 客户端对象模型以编程方式检索用户配置文件属性。

什么是 SharePoint 中的用户配置文件属性？

用户属性和用户配置文件属性提供有关 SharePoint 用户的信息，如显示名称、电子邮件、标题以及其他业务和个人信息。在客户端 API 中，您可以从 PersonProperties 对象及其 UserProfileProperties 属性访问这些属性。 UserProfileProperties 属性包含所有用户配置文件属性，但 PersonProperties 对象包含更容易访问的常用属性（例如， AccountName 、 DisplayName 和 Email ）。

PeopleManager 对象包含以下方法，您可以使用这些方法来通过 .NET 客户端对象模型检索用户属性和用户配置文件属性：

GetMyProperties 方法和 GetPropertiesFor 方法返回一个 PersonProperties 对象。
GetUserProfilePropertiesFor 方法和 GetUserProfilePropertyFor 方法返回您指定的用户配置文件属性的值。

来自客户端 API 的用户配置文件属性是只读的（配置文件图片除外，您可以使用 PeopleManager.SetMyProfilePicture 方法对该图片进行更改）。如果您希望更改其他用户配置文件属性，则必须使用服务器对象模型。

备注

客户端版本的 UserProfile 对象不包含服务器端版本的所有用户属性。但是，客户端版本提供了为当前用户创建个人网站的方法。若要检索当前用户的客户端 UserProfile，请使用 ProfileLoader.GetUserProfile 方法。

若要详细了解如何处理配置文件，请参阅在 SharePoint 中处理用户配置文件。

设置使用 SharePoint .NET 客户端对象模型检索用户配置文件属性的开发环境的先决条件

若要创建使用 .NET 客户端对象模型检索用户配置文件属性的控制台应用，需要满足以下条件：

为当前用户和目标用户创建了配置文件的 SharePoint
Visual Studio 2012
对当前用户的 User Profile Service 应用的 完全控制 连接访问权限

备注

如果开发计算机上没有运行 SharePoint，请下载包含 SharePoint 客户端程序集的 SharePoint 客户端组件。

创建使用 SharePoint .NET 客户端对象模型检索用户配置文件属性的控制台应用

在您的开发计算机上，打开 Visual Studio 并依次选择"文件"、"新建"、"项目"。
在"新建项目"对话框中，从对话框顶部的下拉列表中选择".NET Framework 4.5"。
从项目模板中，选择"Windows"，然后选择"控制台应用程序"。
将项目命名为 UserProfilesCSOM，然后选择"确定"按钮。
添加对以下程序集的引用：

Microsoft.SharePoint.Client
Microsoft.SharePoint.ClientRuntime
Microsoft.SharePoint.Client.UserProfiles

在 Main 方法中，定义服务器 URL 和目标用户名的变量，如下面的代码所示。

const string serverUrl = "http://serverName/";
const string targetUser = "domainName\\userName";

注意：运行代码前，请务必先替换 http://serverName/ 和 domainName\\\\userName 占位符值。

初始化 SharePoint 客户端上下文，如下面的代码所示。

ClientContext clientContext = new ClientContext(serverUrl);

从 PeopleManager 对象中获取目标用户的属性，如以下代码所示。

PeopleManager peopleManager = new PeopleManager(clientContext);
PersonProperties personProperties = peopleManager.GetPropertiesFor(targetUser);

personProperties 对象是一个客户端对象。有些客户端对象在被初始化之后才会包含数据。例如，直到您初始化 personProperties 对象之后，才能访问该对象的属性值。如果您在其初始化之前尝试访问属性，则会收到一条 PropertyOrFieldNotInitializedException 异常消息。

若要初始化 personProperties 对象，请先注册您要运行的请求，然后在服务器上运行该请求，如以下代码所示。

clientContext.Load(personProperties, p => p.AccountName, p => p.UserProfileProperties);
clientContext.ExecuteQuery();

当您调用 Load 方法（或 LoadQuery 方法）时，您即传入了要检索或更改的对象。在此示例中，调用 Load 方法可传入可选参数以用于筛选请求。这些参数是 lambda 表达式，仅请求 personProperties 对象的 AccountName 属性和 UserProfileProperties 属性。

提示：若要减少网络流量，请在调用 Load 方法时仅请求要使用的属性。此外，如果使用多个对象，请在调用 ExecuteQuery 方法之前，尽可能对 Load 方法进行多个调用分组。

遍历用户配置文件属性，并读取每个属性的名称和值，如下面的代码所示。

foreach (var property in personProperties.UserProfileProperties)
{
    Console.WriteLine(string.Format("{0}: {1}", 
        property.Key.ToString(), property.Value.ToString()));
}

代码示例：使用 SharePoint .NET 客户端对象模型检索所有用户配置文件属性

以下代码示例演示如何检索和循环访问目标用户的所有用户配置文件属性，如上一过程中所述。

备注

运行代码前，请务必先替换 http://serverName/ 和 domainName\\\\userName 占位符值。


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.SharePoint.Client;
using Microsoft.SharePoint.Client.UserProfiles;

namespace UserProfilesCSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace the following placeholder values with the target SharePoint site and
            // target user.
            const string serverUrl = "http://serverName/";  
            const string targetUser = "domainName\\\\userName";  

            // Connect to the client context.
            ClientContext clientContext = new ClientContext(serverUrl);

            // Get the PeopleManager object and then get the target user's properties.
            PeopleManager peopleManager = new PeopleManager(clientContext);
            PersonProperties personProperties = peopleManager.GetPropertiesFor(targetUser);

            // Load the request and run it on the server.
            // This example requests only the AccountName and UserProfileProperties
            // properties of the personProperties object.
            clientContext.Load(personProperties, p => p.AccountName, p => p.UserProfileProperties);
            clientContext.ExecuteQuery();

            foreach (var property in personProperties.UserProfileProperties)
            {
                Console.WriteLine(string.Format("{0}: {1}", 
                    property.Key.ToString(), property.Value.ToString()));
            }
            Console.ReadKey(false);

            // TODO: Add error handling and input validation.
        }
    }
}

代码示例：使用 SharePoint .NET 客户端对象模型检索关注我的人员的用户配置文件属性

以下代码示例表明如何在 SharePoint 外接程序中获取关注您的人员的用户配置文件属性。


string contextTokenString = TokenHelper.GetContextTokenFromRequest(Request);

if (contextTokenString != null)
{
    Uri sharepointUrl = new Uri(Request.QueryString["SP.Url"]);

    ClientContext clientContext = TokenHelper.GetClientContextWithContextToken(sharepointUrl.ToString(), contextTokenString, Request.Url.Authority);

    PeopleManager peopleManager = new PeopleManager(clientContext);
    ClientObjectList<PersonProperties> peopleFollowedBy = peopleManager.GetMyFollowers();
    clientContext.Load(peopleFollowedBy, people => people.Include(person => person.PictureUrl, person => person.DisplayName));
    clientContext.ExecuteQuery();

    foreach (PersonProperties personFollowedBy in peopleFollowedBy)
    {
        if (!string.IsNullOrEmpty(personFollowedBy.PictureUrl))
        {
        Response.Write("<img src=\\"" + personFollowedBy.PictureUrl + "\\" alt=\\"" + personFollowedBy.DisplayName + "\\"/>");
        }
    }
    clientContext.Dispose();
}

代码示例：使用 SharePoint .NET 客户端对象模型检索用户配置文件属性集

下面的代码示例展示了如何检索目标用户的一组特定用户配置文件属性。

备注

若要仅检索一个用户配置文件属性的值，请使用 GetUserProfilePropertyFor 方法。

与上述检索目标用户的 PersonProperties 对象的代码示例不同，此示例调用 PeopleManager.GetUserProfilePropertiesFor 方法并传入指定目标用户和要检索的用户配置文件属性的 UserProfilePropertiesForUser 对象。 GetUserProfilePropertiesFor 将返回一个包含所指定属性的值的 IEnumerable<string> 集合。

备注