Microsoft Graph Toolkit でコンポーネントを取得する
mgt-get を使用すると、HTML で Microsoft Graph から直接 GET クエリを作成することができます。 コンポーネントには既定の UI がないため、テンプレートを記述する必要があります。
例
次の例では、mgt-get コンポーネントを使用してユーザーのメールを表示しています。 コード エディターを使用して、プロパティと属性がコンポーネントの動作をどのように変更させるかを確認することができます。
プロパティと属性
いくつかの属性を使用して、コンポーネントの動作を変更することができます。 唯一の必須属性は resource です。
| 属性 | プロパティ | 説明 |
|---|---|---|
| リソース | resource | Microsoft Graph から取得するリソース (/me など)。 |
| scopes | scopes | プロパティを使用する場合は文字列の省略可能な配列、属性を使用する場合はコンマ区切りのスコープ。 コンポーネントとサポートされているプロバイダーは、ユーザーが指定されたアクセス許可の少なくとも 1 つに同意していることを確認します。 |
| version | version | 要求を行うときに使用する省略可能な GET API バージョン。 既定値は v1.0 です。 |
| max-pages | maxPages | ページ数 (ページングをサポートするリソースの場合のオプション)。 既定値は 3 です。 この値を 0 に設定すると、すべてのページが取得されます。 |
| polling-rate | pollingRate | オプションのミリ秒単位。 設定すると、コンポーネントは定義された間隔で更新の要求 URI をポーリングします。 デルタ クエリを使用する場合、ポーリングは常にデルタ API に対してクエリを実行します。 テンプレートは、データが変更されたときにのみ更新されます。 |
| cache-enabled | cacheEnabled | ブール値 (オプション)。 設定すると、リソースからの応答がキャッシュされることを示します。 が呼び出された場合 refresh() 、または使用中の場合 pollingRate はオーバーライドします。 既定値は false です。 |
| cache-invalidation-period | cacheInvalidationPeriod | オプションのミリ秒単位。 と cacheEnabled組み合わせて設定すると、キャッシュが無効化期間に達するまでの遅延によって値が変更されます。 既定値は であり 0 、既定の無効化期間が使用されます。 |
| type | type | 想定される応答の型 (オプション)。 既定値は json です。
json または image をサポートします (/photo/value$ で終わるエンドポイントでのみサポートされます)。 |
| 該当なし | response | 要求が成功した場合の Microsoft Graph からの読み取り専用の応答。 |
| 該当なし | error | 要求が成功しなかった場合の Microsoft Graph からの読み取り専用エラー。 |
メソッド
| メソッド | 説明 |
|---|---|
| refresh(force?: boolean) | メソッドを呼び出してデータを更新します。 既定では、UI はデータが変更された場合にのみ更新されます。 強制的にコンポーネントを更新するには、true を渡します。 |
イベント
| イベント | いつ出力されるか | カスタム データ | キャンセル | 泡 | カスタム テンプレートを使用する |
|---|---|---|---|---|---|
dataChange |
コンポーネントがデータを読み込んだ後に発生します。 |
{ response: any, error: any }.
responseプロパティには、Microsoft Graph から取得した応答が含まれています。 プロパティには error 、エラーが発生した場合のエラーに関する情報が含まれます |
いいえ | いいえ | はい |
ヒント
プロパティで返されるデータの詳細については、Get コンポーネントの プロパティでresponseresource使用した API の API リファレンスを参照してください。
イベントの処理の詳細については、「 イベント」を参照してください。
テンプレート
mgt-get コンポーネントは、外観を定義するために使用できるいくつかの テンプレート をサポートしています。 テンプレートを指定するには、コンポーネント内に 要素を <template> 含め、 を data-type 次のいずれかの値に設定します。
| データ型 | データ コンテキスト | 説明 |
|---|---|---|
| default | Microsoft Graph からの応答。 | Microsoft Graph から送信されるデータをレンダリングするには、既定のテンプレートが必要です。 |
| 値 | 返された value 配列のデータ アイテム |
Microsoft Graph からの応答に メッセージ、ファイル、ユーザーなどのアイテムの配列が含まれることが予想される場合は、default テンプレートの代わりに value テンプレートを使用します。 テンプレートは value 、リソースによって返される各項目に対して自動的に繰り返されます。 テンプレートは value 、準備が整うとすぐに (既定のテンプレートとは異なり) アイテムのレンダリングを開始します。 |
| error | Microsoft Graph からのエラー。 | このテンプレートは、要求の作成中にエラーが発生した場合に使用されます。 |
| loading | 該当なし | このテンプレートは要求が行われている間に使用されます。 |
| no-data | 該当なし | このテンプレートは、要求がデータを返さなかった場合に使用されます。 |
Microsoft Graph のアクセス許可
このコンポーネントに必要なアクセス許可は、Microsoft Graph から取得するデータによって異なります。 Microsoft Graph Toolkit は、現在のユーザーが指定 scopesされた の少なくとも 1 つに同意したことを確認します。 アクセス許可の詳細については、「Microsoft Graph のアクセス許可リファレンス」を参照してください。
認証
このコントロールは、認証ドキュメントに記述されているグローバル認証プロバイダーを使用して、必要なデータを取得します。
キャッシュ
キャッシュを有効にして構成するには、 プロパティと プロパティをcacheInvalidationPeriod使用しますcacheEnabled。 既定では、 mgt-get コンポーネントは応答をキャッシュしません。
| オブジェクト ストア | キャッシュされたデータ | 注釈 |
|---|---|---|
response |
の プロパティで指定されたクエリに対して、Microsoft Graph から取得した応答を resource 完了します mgt-get |
詳細については、「 キャッシュ」を参照してください。
ローカリゼーション
コントロールでは、ローカライズ変数は公開されません。