SharePoint Framework での SharePoint REST API 呼び出し (async/await 編)

はじめに

別記事にて、 SharePoint Framework の SPHttpClient による SharePoint REST API 呼び出しで Promise を使った場合のパターンについて記事を書きましたが、今度は Promise を使わず、TypeScript の async/await を使ったパターンについて書きたいと思います。

async/await を使った SharePoint REST API 呼び出しのサンプル

GET 処理

概ね以下のようなコードになるかと思います。 ちなみにこの例は、指定のリストの指定のアイテム ID のアイテムについて列を指定してデータを取得するものとなります。

読了時間: 2分

SharePoint Framework での SharePoint REST API 呼び出し (Promise 編)

はじめに

SharePoint Framework にて SharePoint REST API を呼び出す方法について、Promise チェーンを書く際にあまりにも煩雑に感じた部分があったので、その点を解消するための自分なりのやり方をメモしました。

Promise を使った SharePoint REST API 呼び出しのサンプル

GET 処理

概ね以下のようなコードになるかと思います。 ちなみにこの例は、指定のリストの指定のアイテム ID のアイテムについて列を指定してデータを取得するものとなります。

読了時間: 2分

リストの種類を表す「リストテンプレート ID」

はじめに

SharePoint Framework 拡張機能のコマンドセットを開発する際に、どのリストにカスタムアクションを紐づけるのかを elements.xml の RegistrationId 属性で指定します。 RegistrationId にはリストテンプレート ID を指定するのですが、このリストテンプレート ID とはいったい何者なのか、SharePoint オンプレ時代から SharePoint に関わっていない限り何だかよく分からないと思うので、この記事で簡単に解説します。

リストテンプレート ID とは

リストテンプレート ID は、SharePoint のリストの種類ごとに割り当てられた ID です。 この ID を見ることで、リストがどのテンプレートから作成されたのかを識別することができます。 既存リストの リストテンプレート ID は、プログラムを通じて確認することが可能です。 PowerShell の場合、以下のようなコードで確認できます。

読了時間: 1分

SharePoint Web Service API の一部が廃止されます

はじめに

SharePoint Server の初期の頃から実装されていた、Web Service API の一部が遂に廃止されるようです。 既に大部分が移行済みかと思いますが、もしまだこの API を利用している場合は、移行が必要となります。 Microsoft 365 管理センターにアクセス可能な方は以下のリンクから公式メッセージを確認してください。 https://admin.microsoft.com/AdminPortal/Home#/messagecenter?id=MC221387&MCLinkSource=MajorUpdate

廃止される API

Microsoft.SharePoint.SoapServer.WebPartPagesWebService クラスの以下のメソッド

廃止時期

2020年10月初~中旬

読了時間: 1分

SharePoint Framework Web パーツ開発 その3:デプロイ

はじめに

この記事では、開発環境にて SharePoint Framework で作成した Web パーツを本番環境にデプロイするための手順を説明します。 まだ SharePoint Framework で Web パーツを作成していない場合やビルドしていない場合は、以下の記事を参考に Web パーツを作ってください。

パッケージ作成手順

本番環境にデプロイするためには、SharePoint Framework で作成した Web パーツをデプロイするためのパッケージにまとめる必要があります。 パッケージファイルは、.sppkg というファイル拡張子の zip ファイルで、これを本番環境にデプロイすることになります。 ということで、まずはパッケージを作成する手順からです。

読了時間: 3分

アプリカタログの作成

はじめに

SharePoint Framework で開発したアプリをテナント内で利用するためには、「アプリカタログ」と呼ばれる場所にアプリのパッケージファイルをアップロードする必要があります。 この記事では、この「アプリカタログ」を作成するための手順を紹介します。

アプリカタログの種類

テナントアプリカタログ

テナント全体で使用するアプリを登録するためのアプリカタログです。 テナントアプリカタログに登録されたアプリは、テナント内のすべてのサイトコレクションに展開可能となり、特定のサイトコレクションに限定して展開することはできません。

サイトコレクションアプリカタログ

サイトコレクションごとの個別のアプリカタログです。 サイトコレクション管理者は自身が管理するサイトコレクションにのみアプリを展開することができます。

アプリカタログ作成手順

テナントアプリカタログ

テナントアプリカタログは Microsoft 365 管理センターから作成します。 ① Microsoft 365 管理センターにアクセスし、SharePoint 管理センターを開く。 ② メニューから [その他の機能] をクリック、右ペインの [アプリ] の下の [開く] をクリックする。 ③ [アプリ カタログ] をクリックする。 ④ [新しいアプリ カタログ サイトを作成する] をクリックする。 ⑤ アプリカタログを作成する。 必要事項を入力し、[OK] ボタンをクリックすると、アプリカタログのサイトコレクションが作成されます。 ⑥ アプリカタログを開く。 アプリカタログはサイトコレクションなので、⑤で決めた URL にアクセスすると通常のサイトと同様に開くことができます。

読了時間: 1分

gulp serve でエラーが出た時の対応

最終更新日:2020/07/26

はじめに

SharePoint Framework 開発中、gulp serve でエラーが発生することがありますが、実際に発生したエラーと対処法をこの記事にまとめていきたいと思います。

エラーケース

ケース1:dist フォルダの権限エラー

**■エラーメッセージ(下線箇所は状況により異なります)**Error - Unknown EPERM: operation not permitted, chmod ‘/usr/app/spfx/dist/link-list-web-part-web-part.js■対処法/usr/app/spfx/dist フォルダにあるファイルへのアクセスができないために発生しているものと思われます。 プロジェクト作業フォルダ内の dist フォルダを削除して再度 gulp serve を実施してください。

読了時間: 1分

SharePoint Framework v1.11 の変更点

2020年7月17日に SharePoint Framework v1.11 がリリースされました。 この記事では v1.11 の変更点について気になるところだけ抜粋して記載します。 詳細は以下のリリースノートを確認してください。 SharePoint Framework v1.11 release notes なお、SharePoint Framework v1.11 に対応した Docker イメージは Docker Hub からダウンロード可能です。

読了時間: 1分

Microsoft 365 Virtual Marathon で初めてのオンラインイベント

ご報告

2020年5月28日~29日に、世界規模で開催された Microsoft 365 Virtual Marathon というオンラインイベントにスピーカーとして参加させていただきました。 私はこれが初めてのオンラインイベントでの登壇で、リハーサルの時から機材大丈夫かなとか、おでこテカってないかなとか、背面大丈夫かなとか、色々考えて無駄に緊張してしまいましたw これから YouTube で動画が公開される予定ですが現時点では自分の喋りっぷりは確認できておらず、これまた大丈夫かなと不安な点はあるのですが、ひとまずいつも通りの感じでできたかなと思っています。 ちなみに今回私のセッションをご視聴いただいた方の人数は180名弱くらいだったようです。 ご視聴いただいた多くの方々、本イベントの主催者やスタッフの方々、この度はとても良い機会をご提供いただき誠にありがとうございました。 またオンラインイベントやっていきたいですね。

オンラインイベントの醍醐味

通常コミュニティイベントというと、休日にどこかの場所に集まってみんなで和気あいあいと楽しく勉強をするという感じで、それはそれでとても楽しいのですが、休日に家を空けるというのはなかなか大変なことで、これまであまりコミュニティイベントに参加できていませんでした。 でも、今回オンラインイベントを経験してみて、これはこれでオフラインのコミュニティイベントと同様にやりがいがあるし、何より参加いただける方が桁違いに多い! だから、今までアプローチできなかった方々にも視聴いただくことができるようになったし、それによって生まれた新たなコミュニケーションもありました。 オンラインならではのこの経験はなかなか興味深いもので、これからのイベントの在り方を見直す良い機会なのかなと思いました。 さて、今回のイベントの詳細につきましては、日本チームのリーダーである平野愛さんが既にまとめ記事を投稿されているので、詳細はそちらをご覧ください。 Microsoft 365 Virtual Marathon 無事に終了しました

読了時間: 1分

Edge で使える SharePoint 用 REST テストツール「SP REST Client」

はじめに

SharePoint の REST API をテストする時、みなさんはどんなツールを使っていますか? 私はこれまで Internet Explorer のフィードを表示する機能を使っていたのですが、IE の未来に光が見えないので他のツールに乗り換えようと色々探していました。 IE と同じように、ブラウザで SharePoint サイト認証をクリアしていればその認証情報を使いまわしてくれるものが使い勝手が良くていいなと。 そしてようやくニーズにあったツールに出会えたので紹介します。 その名も「SP REST Client」 Google の拡張機能として提供されています。 ひと目で SharePoint 用だと想像がつく分かりやすい名前ですね。

読了時間: 1分