コードサンプル: 仕事仲間アクティビティイベントへのリンクを送る

[アーティクル]
09/18/2014

最終更新日: 2011年8月22日

適用対象: SharePoint Server 2010

この記事の内容
SharePoint アクティビティの概要
アクティビティイベントの作成と発行
サンプルのビルドと実行

このサンプルでは、ActivityType オブジェクトと ActivityEvent オブジェクトを作成する方法、および新しい ActivityEvent オブジェクトをユーザーのニュースフィードに挿入する方法を示します。このサンプルでは、ユーザーがいくつかの簡単な手順を実行するだけで仕事仲間とリンクを共有できるようにするための簡単なフォームを作成します。ユーザーインターフェイスには、ユーザーが仕事仲間のニュースフィードに URL とコメントを挿入するために使用できるポップアップボックスがあります。

サンプルコードの提供者: MVP コントリビューター Mathew McDermott、Catapult Systems | Andrew Connell、Critical Path Training, LLC

このコードサンプルをコンピューターにインストールするには、Microsoft SharePoint 2010 Software Development Kit (英語) (SDK) をダウンロードするか、Code Gallery (英語) からサンプルをダウンロードします。SharePoint 2010 SDK をダウンロードすると、サンプルはファイルシステムの次の場所にインストールされます。C:\Program Files\Microsoft SDKs\SharePoint 2010\Samples\Social Data and User Profiles。

SharePoint アクティビティの概要

Microsoft SharePoint Server 2010 では、個人用サイトのホストのニュースフィードによって、監視対象のイベントと通知を統合できます。この新しいページと新しい機能によってユーザーは、企業中の更新を 1 つの場所で確認できます。ユーザーは、ユーザーの画像と関連情報へのリンクで書式設定された、ニュースと情報のわかりやすい表示に "参加" できます。これにより、ニュースフィードは、追加のアプリケーション通知に便利な場所になります。各ニュースフィード項目は、ActivityEvent オブジェクトの内容を表示します。

アクティビティのテンプレート

アクティビティの設計は、簡単な文から始めます。たとえば、仕事仲間がリンクの共有を望んでいることを表す新しい ActivityType オブジェクトを作成する場合、文は次のようになります。

Jim Brown has sent you the following link of interest: Great SharePoint Article

アクティビティの可変部分は Jim Brown で、リンクテキストは Great SharePoint Article です。アクティビティタイプのテンプレートの開発では、次のサンプルテンプレートのように可変部分をトークンに置き換えます。

{Publisher} has sent you the following link of interest: {Link}

開発するカスタムアプリケーションによって、トークンに必要な情報を入力します。テンプレートのテキストは、対象の言語へのローカライズを容易にするために、リソースファイルとしてサーバーに展開されます。リソースファイルの作成と使用の詳細については、「リソースファイルの操作 (英語)」を参照してください。

このソリューションの展開

表 1 に、このアクティビティフィードソリューションに必要なコンポーネントを示します。

表 1. アクティビティフィードソリューションに必要なコンポーネント

プロジェクトアセット	展開先
プロジェクトアセンブリ (*.dll)	グローバルアセンブリキャッシュ
アクティビティテンプレートのリソースファイル (*.resx)	Resources ディレクトリ
アプリケーションページ (*.aspx)	Template/Layouts/MSDN

アクティビティアセットを展開した後で、新しい ActivityType オブジェクトと関連する ActivityTemplate オブジェクトを、ActivityType オブジェクトと ActivityTemplate オブジェクトをリソースファイルと関連付けるイベントレシーバーによって作成する必要があります。サンプルプロジェクトでは、ソリューションの展開時にこのアクションを実行します。

private void SetupCustomActivity(SPSite site)
{
  try
  {
    //Get a Service Context from the site.
    SPServiceContext context = SPServiceContext.GetContext(site);
    //We need a User Profile Manager to work with Activities.
    UserProfileManager upm = new UserProfileManager(context);
    //Grab the current user's profile.
    UserProfile p = upm.GetUserProfile(true);

    Debug.WriteLine("Got the User Profile for: " + p.DisplayName);
    //Grab an activity manager.
    ActivityManager am = new ActivityManager(p, context);
    //Ensure that we have permission to do this.
    bool hasrights = am.PrepareToAllowSchemaChanges();
    Debug.WriteLine("Does installer have Admin rights to change the schema? " + hasrights);

    // Create our activity application.
    Debug.WriteLine("Create our Activity Application");
    ActivityApplication app = am.ActivityApplications["Send Link to Colleague"];
    if (app == null)
    {
      app = am.ActivityApplications.Create("Send Link to Colleague");
      app.Commit();
    }
    Debug.WriteLine("Send Link to Colleague App id: " + app.ApplicationId);

    //Create our Colleagues Activity Type, but first check to see whether it already exists.
    Debug.WriteLine("Activity Type: SendColleagueUrlNote");
    ActivityType activityType = app.ActivityTypes["SendColleagueUrlNote"];
    if (activityType == null)
    {
      activityType = app.ActivityTypes.Create("SendColleagueUrlNote");
      activityType.ActivityTypeNameLocStringResourceFile = resFile;
      activityType.ActivityTypeNameLocStringName = "ActivityFeed_SendColleagueUrlNote_Type_Display";
      activityType.IsPublished = true;
      activityType.IsConsolidated = true;
      activityType.Commit();
    }
    //SendColleagueUrlNote Activity Template.
    Debug.WriteLine("SendColleagueUrlNote Activity Single Value Template");
    ActivityTemplate urlTemplateSV = activityType.ActivityTemplates[ActivityTemplatesCollection.CreateKey(false)];
    if (urlTemplateSV == null)
    {
      urlTemplateSV = activityType.ActivityTemplates.Create(false);
      urlTemplateSV.TitleFormatLocStringResourceFile = resFile;
      urlTemplateSV.TitleFormatLocStringName = "ActivityFeed_SendColleagueUrlNote_SV_Template";
      urlTemplateSV.Commit();
     }

アクティビティイベントの作成と発行

サンプルアプリケーションの設計目標は、いくつかの簡単な手順を実行するだけで仕事仲間とリンクを共有できる簡単なフォームをユーザーに提供することです。タグとメモ機能をモデルとした、"仕事仲間へリンクを送信" 機能によって、図 1 のように個人用メニューに 1 つのメニュー項目が追加されます。

図 1. [仕事仲間へリンクを送信] メニューの詳細

[仕事仲間へリンクを送信] メニューの詳細

このメニュー項目をユーザーが選択すると、[仕事仲間へリンクを送信] フォームが表示されます。

図 2. [仕事仲間へリンクを送信] ページ

[仕事仲間へリンクを送信] ページ

フォームを開始するために使用される ECMAScript (JavaScript、JScript) は、現在のウィンドウの URL を提供し、URL をパラメーターとしてフォームに渡します。渡される値は、フォームのデバッグセクションに表示されます。カスタムアクティビティを仕事仲間に送信するには、ユーザーは、テキストボックスにメモを追加して、[Post] をクリックします。

アクティビティの作成

サンプルアプリケーションでは、CreateActivity メソッドでユーザー用のアクティビティを作成します。このメソッドは、アクティビティ所有者のユーザープロファイルとアクティビティ発行者のユーザープロファイルを引数として取ります。このメソッドは、各ユーザーの MinimalPerson オブジェクトを作成し、これらのオブジェクト両方を CreateActivityEvent メソッドに渡します。アクティビティリンクは、URL とユーザーが指定したメモで構成されます。

public ActivityEvent CreateActivity(UserProfile ownerProfile, UserProfile publisherProfile, ActivityType activityType, string linkText, string linkUrl)
{
  //Get the Owner and Publisher Profile.
  Entity ownerMP = new MinimalPerson(ownerProfile).CreateEntity(activityManager);
  Entity publisherMP = new MinimalPerson(publisherProfile).CreateEntity(activityManager);

  //Create the activity and set some properties.
  ActivityManager am = new ActivityManager();
  ActivityEvent activityEvent = ActivityEvent.CreateActivityEvent(am, activityType.ActivityTypeId, ownerMP, publisherMP);

  Debug.WriteLine("Got my ActivityEvent");
  activityEvent.Name = activityType.ActivityTypeName;
  activityEvent.ItemPrivacy = (int)Privacy.Public;
  activityEvent.Owner = ownerMP;
  activityEvent.Publisher = publisherMP;
           
  //Create the link for the activity.
  Link link = new Link();
  link.Href = linkUrl;
  link.Name = linkText;
  activityEvent.Link = link;
  //Save your work.
  activityEvent.Commit();

  Debug.WriteLine("End of Activity event: " + activityType.ActivityTypeName);
  return activityEvent;
}

ユーザーの仕事仲間へのアクティビティイベントの送信

このソリューションでは、ActivityFeedGatherer オブジェクトによって提供されるバッチメソッドを使用して、アクティビティをユーザーの仕事仲間全員にマルチキャストします。

//Send activity to the Owner’s Colleagues.
//Create Dictionary objects that will be output parameters for the batch gatherer methods.
  Dictionary<long, MinimalPerson> owners;
  Dictionary<long, List<MinimalPerson>> colleaguesOfOwners;
//Create List objects that contain the ActivityEvent and its publisher.
  List<ActivityEvent> events = new List<ActivityEvent>();
  events.Add(activityEvent);
  List<long> publishers = new List<long>();
  publishers.Add(activityEvent.Owner.Id);
  ActivityFeedGatherer.GetUsersColleaguesAndRights(activityManager, publishers, out owners, out colleaguesOfOwners);
  Dictionary<long, List<ActivityEvent>> eventsConsolidatedPerOwner;
  ActivityFeedGatherer.MulticastActivityEvents(activityManager, events, colleaguesOfOwners, out eventsConsolidatedPerOwner);
  List<ActivityEvent> eventsConsolidated;
  ActivityFeedGatherer.CollectActivityEventsToConsolidate(eventsConsolidatedPerOwner, out eventsConsolidated);
  ActivityFeedGatherer.BatchWriteActivityEvents(eventsConsolidated, 0, events.Count);

サンプルのビルドと実行

以下の手順では、開発サイトあるいはテストサイトで、このプロジェクトをテストする方法を説明します。

サンプルをビルドするには

「Microsoft.SDK.Server.Samples」という名前のフォルダーを作成し、MSDN SharePoint 2010 Activity Feeds - Code.zip ファイルをそのフォルダーに解凍します。
Visual Studio 2010 を起動し、手順 1. で作成したフォルダーにある SendColleagueURLNote.sln ファイルを開きます。
[プロパティ] ウィンドウで、開発サイトまたはテストサイトのサイト URL の値を絶対アドレス (たとえば、http://mysite/) で指定します。終了スラッシュを入力していることを確認してください。
SendColleagueURLNote.EventReceiver.cs ファイルで、SendColleagueURLNoteEventReceiver メソッドで SharePoint サーバーの全体管理サイトの URL を指定します。
もし存在しない場合は、プロジェクトに以下のアセンブリへの参照を追加します。
- Microsoft.SharePoint.dll
- Microsoft.Office.Server.dll
- Microsoft.Office.Server.UserProfiles.dll
Resources ディレクトリのリソースファイル (URLNote.en-US.resx と URLNote.resx) を \Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Resources ディレクトリに追加します。
[ビルド] メニューの [ソリューションの展開] をクリックします。ビルドが完了した後で、アプリケーションページは開発あるいはテストサイトにインストールされます。

サンプルを実行するには

ソリューションをビルドし、展開した後で、SharePoint Server 2010 サイトに移動します。ページの右上にあるドロップダウンメニューで [仕事仲間へリンクを送信] をクリックします。
テキストボックスにオプションのメモを入力し、[Post] をクリックしてそのメモとリンクを仕事仲間のニュースフィードに挿入します。

次の方法で共有

コードサンプル: 仕事仲間アクティビティイベントへのリンクを送る

SharePoint アクティビティの概要

アクティビティのテンプレート

このソリューションの展開

アクティビティイベントの作成と発行

アクティビティの作成

ユーザーの仕事仲間へのアクティビティイベントの送信

サンプルのビルドと実行

サンプルをビルドするには

サンプルを実行するには

関連項目

参照

概念

その他のリソース

次の方法で共有

コード サンプル: 仕事仲間アクティビティ イベントへのリンクを送る

SharePoint アクティビティの概要

アクティビティのテンプレート

このソリューションの展開

アクティビティ イベントの作成と発行

アクティビティの作成

ユーザーの仕事仲間へのアクティビティ イベントの送信

サンプルのビルドと実行

サンプルをビルドするには

サンプルを実行するには

関連項目

参照

概念

その他のリソース

コードサンプル: 仕事仲間アクティビティイベントへのリンクを送る

アクティビティイベントの作成と発行

ユーザーの仕事仲間へのアクティビティイベントの送信