SharePoint で JavaScript オブジェクト モデルを使用して投稿の作成と削除、およびソーシャル フィードの取得を行う
SharePoint JavaScript オブジェクト モデルを使用して、ミニブログの投稿を作成および削除する方法と、ソーシャル フィードを取得する方法について説明します。
SharePoint のソーシャル フィードとは
SharePoint の場合、ソーシャル フィードは、会話、1 つのマイクロブログの投稿、または通知のコレクションを表します。 スレッドには、最初の投稿と返信投稿のコレクションが含まれています。 JavaScript オブジェクト モデルでは、フィードは SocialFeed オブジェクトで表され、スレッドは SocialThread オブジェクトで表され、投稿と返信は SocialPost オブジェクトによって表されます。 フィード関連のコア タスクを実行するには、SocialFeedManager オブジェクトを使用します。 この記事では、JavaScript オブジェクト モデルを使用してソーシャル フィードを操作するアプリケーション ページの作成方法について説明します。
SocialFeedManager の操作の詳細、または他の API を使用してソーシャル フィードを操作する方法の詳細については、「SharePoint でのソーシャル フィードの操作」を参照してください。
SharePoint JavaScript オブジェクト モデルでソーシャル フィードを操作する開発環境をセットアップするための前提条件
JavaScript オブジェクト モデルを使用してソーシャル フィードを操作するアプリケーション ページを作成するには、次のものが必要になります。
個人用サイトが公開するように構成済みで、現在のユーザー用の個人サイトとターゲット ユーザー用の個人サイトを作成済みであり、ターゲット ユーザーを現在のユーザーがフォローしていて、ターゲット ユーザーによる投稿がいくつかある SharePoint
Office Developer Tools for Visual Studio 2013 を持つ Visual Studio 2012 または Visual Studio 2013
ログオン ユーザーに対する User Profile Service アプリケーションへの フル コントロールのアクセス許可とファーム ソリューションを展開するためのアクセス許可
個人用サイト Web アプリケーションのコンテンツ データベースにアクセスするためのアプリケーション プール アカウントに対する十分な権限
SharePoint JavaScript オブジェクト モデルを使用した、ソーシャル フィードを操作するアプリケーション ページの作成
Visual Studio を開き、[ ファイル]、[ [新規]、[ プロジェクト] を選択します。
[ 新しいプロジェクト] ダイアログ ボックスの上部にあるドロップダウン リストから [ .NET Framework 4.5] を選択します。
[ テンプレート] リストの [ Office SharePoint] を展開し、[ SharePoint ソリューション] カテゴリを選択して、[ SharePoint Project] テンプレートを選択します。
プロジェクト名に 「SocialFeedJSOM」という名前を付け、[ OK] をクリックします。
[ SharePoint カスタマイズ ウィザード] ダイアログ ボックスで、[ ファーム ソリューションとして配置する] を選択して、[ 完了] をクリックします。
Solution Explorer で、SocialFeedJSOM プロジェクトのショートカット メニューを開き、SharePoint のマップされた "Layouts" フォルダーを追加します。
レイアウト フォルダーで、SocialFeedJSOM フォルダーのショートカット メニューを開いて、SocialFeed.aspx という名前の新しい SharePoint アプリケーション ページを追加します。
注: この記事のコード例では、ページ マークアップにカスタム コードを定義していますが、Visual Studio によって作成されるページの分離コードは使用しません。
SocialFeed.aspx ページのショートカット メニューを開いて、［スタートアップ アイテムとして設定］ を選択します。
SocialFeed.aspx ページのマーク アップで、次のコードに示すように、"Main" の asp:Content タグの内側でコントロールを定義します。
<table width="100%" id="tblPosts"></table><br/>
<button id="btnDelete" type="button"></button><br />
<span id="spanMessage" style="color: #FF0000;"></span>
注: これらのコントロールは、すべてのシナリオで使用されるわけではありません。 たとえば、"投稿と返信の公開" シナリオは、span コントロールのみを使用します。
- 終了 スパン タグの後に、次のコードに示すように、 SharePoint:ScriptLink コントロール、 SharePoint:FormDigest コントロール、 スクリプト タグを追加します。 SharePoint:ScriptLink タグは、My Site Social 開発に使用できる JavaScript オブジェクト モデルを定義するクラス ライブラリ ファイルを参照します。 SharePoint:FormDigest タグは、サーバー コンテンツを更新する操作で必要な場合に、セキュリティ検証用のメッセージ ダイジェストを生成します。
<SharePoint:ScriptLink ID="ScriptLink1" name="SP.js" runat="server" ondemand="false" localizable="false" loadafterui="true" />
<SharePoint:ScriptLink ID="ScriptLink2" name="SP.UserProfiles.js" runat="server" ondemand="false" localizable="false" loadafterui="true" />
<SharePoint:FormDigest id="FormDigest" runat="server"/>
<script type="text/javascript">
// Replace this comment with the code for your scenario.
</script>
- フィードとやり取りするロジックを追加するには、 script タグで囲まれたコメントの内容を、次のいずれかのシナリオのコード例で置き換えます。
- アプリケーション ページをテストするには、[ デバッグ] メニューの [ デバッグ開始] をクリックします。 web.config ファイルの変更を確認するメッセージが表示されたら、[ OK] をクリックします。
応答が失敗のコールバック メソッドを呼び出す場合、メソッドにブレークポイントを設定し、 args オブジェクトにウォッチを追加するか、詳細について ULS ログおよびイベント ビューアーを確認します。
コード例: SharePoint JavaScript オブジェクト モデルを使用した、ソーシャル フィードへの投稿と返信の公開
次のコードは、投稿と返信を公開する例です。 以下の操作方法が記述されています。
投稿内容を定義する。 この例では、投稿にリンクが含まれています。
createPost メソッドを使用し、 null を targetId パラメーターとして渡すことで、現在のユーザーのフィードに投稿を公開する。
createPost メソッドを使用して、targetId パラメーターとしてスレッド ID を渡すことで投稿に返信する。
注:
「アプリケーション ページの作成」の手順で追加した script タグの間に次のコードを貼り付けます。
// Ensure that the SP.UserProfiles.js file is loaded before the custom code runs.
SP.SOD.executeOrDelayUntilScriptLoaded(PublishPost, 'SP.UserProfiles.js');
// Declare global variables.
var clientContext;
var feedManager;
var resultThread;
function PublishPost() {
// Initialize the current client context and the SocialFeedManager instance.
clientContext = SP.ClientContext.get_current();
feedManager = new SP.Social.SocialFeedManager(clientContext);
// Create a link to include in the post.
var linkDataItem = new SP.Social.SocialDataItem();
linkDataItem.set_itemType(SP.Social.SocialDataItemType.link);
linkDataItem.set_text('link');
linkDataItem.set_uri('http://bing.com');
var socialDataItems = [ linkDataItem ];
// Create the post content.
var postCreationData = new SP.Social.SocialPostCreationData();
postCreationData.set_contentText('The text for the post, which contains a {0}.');
postCreationData.set_contentItems(socialDataItems);
// Publish the post. Pass null for the "targetId" parameter because this is a root post.
resultThread = feedManager.createPost(null, postCreationData);
clientContext.executeQueryAsync(PublishReply, PostFailed);
}
function PublishReply(sender, args) {
// Create the reply content.
var postCreationData = new SP.Social.SocialPostCreationData();
postCreationData.set_contentText('The text for the reply.');
// Publish the reply.
resultThread = feedManager.createPost(resultThread.get_id(), postCreationData);
clientContext.executeQueryAsync(PostSucceeded, PostFailed);
}
function PostSucceeded(sender, args) {
$get("spanMessage").innerText = 'The post and reply were published.';
}
function PostFailed(sender, args) {
$get("spanMessage").innerText = 'Request failed: ' + args.get_message();
}
コード例: JavaScript オブジェクト モデルを使用してソーシャル フィードを取得する
次のコード例では、現在のユーザーとターゲット ユーザーのフィードを取得します。 以下の操作方法が記述されています。
getFeed メソッドを使用して、現在のユーザーの Personal、 News、および Timeline のフィード タイプを取得する。
getFeedFor メソッドを使用して、ターゲット ユーザーの Personal フィード タイプを取得する。
フィードを反復処理して非参照スレッドをすべて検出し、それらのスレッドと投稿に関する情報を取得する。 参照スレッドは、別のスレッドに関する情報を含む通知を表します。 たとえば、誰かに関するユーザーのメンションが投稿内にあると、元の投稿へのリンクと投稿についての他のメタデータを含む MentionReference 型のスレッドがサーバーによって生成されます。
フィードの種類の詳細については、「 My Site Social API のフィードの種類の概要」を参照してください。 参照スレッドの詳細については、「 SharePoint ソーシャル フィードの参照スレッドとダイジェスト スレッド」を参照してください。
注:
「アプリケーション ページの作成」の手順で追加した script タグの間に次のコードを貼り付けます。 Then, change the placeholder value for the targetUser variable before you run the code.
// Replace the placeholder value with the account name of the target user.
var targetUser = 'domainName\\\\userName';
// Ensure that the SP.UserProfiles.js file is loaded before the custom code runs.
SP.SOD.executeOrDelayUntilScriptLoaded(GetFeeds, 'SP.UserProfiles.js');
// Declare global variables.
var clientContext;
var feedManager;
var personalFeed;
var newsFeed;
var timelineFeed;
var targetUserFeed;
function GetFeeds() {
// Initialize the current client context and the SocialFeedManager instance.
clientContext = SP.ClientContext.get_current();
feedManager = new SP.Social.SocialFeedManager(clientContext);
// Set parameters for the feed content that you want to retrieve.
var feedOptions = new SP.Social.SocialFeedOptions();
feedOptions.set_maxThreadCount(10); // default is 20
// Get all feed types for current user and get the Personal feed
// for the target user.
personalFeed = feedManager.getFeed(SP.Social.SocialFeedType.personal, feedOptions);
newsFeed = feedManager.getFeed(SP.Social.SocialFeedType.news, feedOptions);
targetUserFeed = feedManager.getFeedFor(targetUser, feedOptions);
// Change the sort order to optimize the Timeline feed results.
feedOptions.set_sortOrder(SP.Social.SocialFeedSortOrder.byCreatedTime);
timelineFeed = feedManager.getFeed(SP.Social.SocialFeedType.timeline, feedOptions);
clientContext.load(feedManager);
clientContext.executeQueryAsync(CallIterateFunctionForFeeds, RequestFailed);
}
function CallIterateFunctionForFeeds() {
IterateThroughFeed(personalFeed, "Personal", true);
IterateThroughFeed(newsFeed, "News", true);
IterateThroughFeed(timelineFeed, "Timeline", true);
IterateThroughFeed(targetUserFeed, "Personal", false);
}
function IterateThroughFeed(feed, feedType, isCurrentUser) {
tblPosts.insertRow().insertCell();
var feedHeaderRow = tblPosts.insertRow();
var feedOwner = feedManager.get_owner().get_name();
// Iterate through the array of threads in the feed.
var threads = feed.get_threads();
for (var i = 0; i < threads.length ; i++) {
var thread = threads[i];
var actors = thread.get_actors();
if (i == 0) {
// Get the name of the target user for the feed header row. Users are
// owners of all threads in their Personal feed.
if (!isCurrentUser) {
feedOwner = actors[thread.get_ownerIndex()].get_name();
}
feedHeaderRow.insertCell().innerText = feedType.toUpperCase() + ' FEED FOR '
+ feedOwner.toUpperCase();
}
// Use only Normal-type threads and ignore reference-type threads. (SocialThreadType.Normal = 0)
if (thread.get_threadType() == 0) {
// Get the root post's author, content, and number of replies.
var post = thread.get_rootPost();
var authorName = actors[post.get_authorIndex()].get_name();
var postContent = post.get_text();
var totalReplies = thread.get_totalReplyCount();
var postRow = tblPosts.insertRow();
postRow.insertCell().innerText = authorName + ' posted \\"' + postContent
+ '\\" (' + totalReplies + ' replies)';
// If there are any replies, iterate through the array and
// get the author and content.
// If a thread contains more than two replies, the server
// returns a thread digest that contains only the two most
// recent replies. To get all replies, call the
// SocialFeedManager.getFullThread method.
if (totalReplies > 0) {
var replies = thread.get_replies();
for (var j = 0; j < replies.length; j++) {
var replyRow = tblPosts.insertRow();
var reply = replies[j];
replyRow.insertCell().innerText = ' - ' + actors[reply.get_authorIndex()].get_name()
+ ' replied \\"' + reply.get_text() + '\\"';
}
}
}
}
}
function RequestFailed(sender, args) {
$get("spanMessage").innerText = 'Request failed: ' + args.get_message();
}
コード例: JavaScript オブジェクト モデルを使用してソーシャル フィードから投稿と返信を削除する
次のコード例では、投稿または返信を削除します。 以下の操作方法が記述されています。
getFeed メソッドを使用して、現在のユーザーの News フィード タイプを取得する。
フィード内で投稿と返信を繰り返し処理して、投稿または返信を削除するために使用する id プロパティを取得する。
deletePost メソッドを使用して、最初の投稿または返信を削除する (最初の投稿を削除すると、スレッド全体が削除されます)。
注:
「アプリケーション ページの作成」の手順で追加した script タグの間に次のコードを貼り付けます。 この例では、現在のユーザーのニュースフィードに少なくとも 1 つの投稿があることを前提としています。
// Ensure that the SP.UserProfiles.js file is loaded before the custom code runs.
SP.SOD.executeOrDelayUntilScriptLoaded(GetFeeds, 'SP.UserProfiles.js');
// Declare global variables.
var clientContext;
var feedManager;
var feed;
var postOrReplyToDelete;
function GetFeeds() {
// Initialize the current client context and the SocialFeedManager instance.
clientContext = SP.ClientContext.get_current();
feedManager = new SP.Social.SocialFeedManager(clientContext);
// Set parameters for the feed content that you want to retrieve.
var feedOptions = new SP.Social.SocialFeedOptions();
feedOptions.set_maxThreadCount(10); // default is 20
// Get all the News feed type for current user.
feed = feedManager.getFeed(SP.Social.SocialFeedType.news, feedOptions);
clientContext.executeQueryAsync(IterateThroughFeed, RequestFailed);
}
function IterateThroughFeed() {
// Iterate through the array of threads in the feed.
var threads = feed.get_threads();
for (var i = 0; i < threads.length ; i++) {
var thread = threads[i];
var actors = thread.get_actors();
// Get the root post's author, content, and number of replies.
var post = thread.get_rootPost();
var authorName = actors[post.get_authorIndex()].get_name();
var postContent = post.get_text();
var totalReplies = thread.get_totalReplyCount();
var postRow = tblPosts.insertRow();
postRow.insertCell().innerText = authorName + ' posted \\"' + postContent
+ '\\" (' + totalReplies + ' replies)';
postOrReplyToDelete = post.get_id();
// If there are any replies, iterate through the array and
// get the author and content.
// If a thread contains more than two replies, the server
// returns a thread digest that contains only the two most
// recent replies. To get all replies, call the
// SocialFeedManager.getFullThread method.
if (totalReplies > 0) {
var replies = thread.get_replies();
for (var j = 0; j < replies.length; j++) {
var replyRow = tblPosts.insertRow();
var reply = replies[j];
replyRow.insertCell().innerText = ' - ' + actors[reply.get_authorIndex()].get_name()
+ ' replied \\"' + reply.get_text() + '\\"';
postOrReplyToDelete = reply.get_id();
}
}
// Initialize button properties.
$get("btnDelete").onclick = function () { DeletePostOrReply(); };
$get("btnDelete").innerText = 'Click to delete the last post or reply';
}
}
// Delete the last post or reply listed on the page.
function DeletePostOrReply() {
feedManager.deletePost(postOrReplyToDelete);
clientContext.executeQueryAsync(DeleteSucceeded, RequestFailed);
}
function DeleteSucceeded(sender, args) {
$get("spanMessage").innerText = 'The post or reply was deleted. Refresh the page to see your changes.';
}
function RequestFailed(sender, args) {
$get("spanMessage").innerText = 'Request failed: ' + args.get_message();
}