User クラス
Microsoft SharePoint Foundationでユーザーを表します。
継承階層
System.Object
Microsoft.SharePoint.Client.ClientObject
Microsoft.SharePoint.Client.Principal
Microsoft.SharePoint.Client.User
名前空間: Microsoft.SharePoint.Client
アセンブリ: Microsoft.SharePoint.Client.Silverlight (Microsoft.SharePoint.Client.Silverlight.dll 内); Microsoft.SharePoint.Client.Phone (Microsoft.SharePoint.Client.Phone.dll 内) Microsoft.SharePoint.Client (Microsoft.SharePoint.Client.dll 内)
構文
'宣言
Public NotInheritable Class User _
Inherits Principal
'使用
Dim instance As User
public sealed class User : Principal
注釈
サイトのすべてのユーザーに戻るには、 WebクラスのAllUsersプロパティを使用します。これには、ユーザーが直接アクセス許可が含まれているユーザーは、グループ、サイトを訪問した、[ユーザーとユーザー フィールドをタスクに割り当てられているなどで参照されているユーザーを使用してアクセス許可を付与します。AllUsers[name]を呼び出す場合は、ユーザーがない場合例外がスローされます。
サイト コレクション内のすべてのユーザーを取得するのにには、 WebクラスのSiteUsersプロパティを使用します。
サイトのすべての認証されたユーザーに戻るには、 UtilityクラスのGetAllAuthenticatedUsersメソッドを使います。
SPAlertCollectionクラスのGetUniqueUsersメソッドを使用して、通知のコレクションのユーザーのリストを返します。
それ以外の場合、ユーザーをグループまたはサイトに戻るにはGroupまたはWebクラスのUsersプロパティを使用します。
コレクションから 1 人のユーザーを取得するにはインデクサを使用します。たとえば、コレクションが collUsers という名前の変数に割り当てられている場合、collUsers[index] (C#) または collUsers(index) (Visual Basic) を使用します。ここでは、index はコレクション内のユーザーのインデックス番号か、ユーザーのユーザー名です。
各ユーザーは一意のメンバ ID (ID プロパティ) を持ち、そのメンバシップに関連付けられた権限を持ちます。また、ユーザーは SPMember オブジェクトで表されます。次の例は、SharePoint Web サイトを指定して、ユーザーを SPMember オブジェクトに割り当てます。
Dim oWebsite As SPWeb = SPContext.Current.Web
Dim oMember As SPMember = oWebsite.AllUsers("Domain\\User_Alias")
SPWeb oWebsite = SPContext.Current.Web;
SPMember oMember = oWebsite.AllUsers["Domain\\User_Alias"];
ユーザーおよびセキュリティに関する一般的な情報については、「セキュリティ、ユーザー、およびグループ」を参照してください。
例
この例では、現在のサイトの閲覧者グループに現在のユーザーを追加します。
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointFoundation.Samples
{
class UserExample
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web site = clientContext.Web;
GroupCollection collGroup = site.SiteGroups;
// Get the visitors group, assuming its ID is 4.
Group visitorsGroup = collGroup.GetById(4);
User currentUser = site.CurrentUser;
UserCollection collUser = visitorsGroup.Users;
collUser.AddUser(currentUser);
clientContext.Load(currentUser);
clientContext.Load(visitorsGroup);
clientContext.ExecuteQuery();
Console.WriteLine(currentUser.Title + " added to group " + visitorsGroup.Title);
}
}
}
スレッド セーフ
この型のパブリック static (Visual Basic のShared ) メンバーはいずれもスレッド セーフです。インスタンス メンバーはスレッド セーフになるという保証はありません。