TileUpdater.StartPeriodicUpdateBatch メソッド

定義

名前空間:

Windows.UI.Notifications

オーバーロード

StartPeriodicUpdateBatch(IIterable<Uri>, PeriodicUpdateRecurrence)	アップデーターがバインドされているタイルを循環する一連の時間指定更新を開始します。 更新内容は、指定された Uniform Resource Identifier (URI) の配列から取得されます。最初の更新は直ちに行われ、その後は定期的な間隔で後続の更新が行われます。 注意 この機能を使用するには、まず EnableNotificationQueue を呼び出してタイルの通知キューを有効にする必要があります。
StartPeriodicUpdateBatch(IIterable<Uri>, DateTime, PeriodicUpdateRecurrence)	アップデーターがバインドされているタイルを循環する一連の時間指定更新を開始します。 更新内容は、指定した Uri (Uniform Resource Identifier) の配列から取得され、指定した時刻から更新が開始され、その後の定期的な間隔で以降の更新が行われます。 注意 この機能を使用するには、まず EnableNotificationQueue を呼び出してタイルの通知キューを有効にする必要があります。

StartPeriodicUpdateBatch(IIterable<Uri>, PeriodicUpdateRecurrence)

アップデーターがバインドされているタイルを循環する一連の時間指定更新を開始します。 更新内容は、指定された Uniform Resource Identifier (URI) の配列から取得されます。最初の更新は直ちに行われ、その後は定期的な間隔で後続の更新が行われます。

注意

この機能を使用するには、まず EnableNotificationQueue を呼び出してタイルの通知キューを有効にする必要があります。

public:
 virtual void StartPeriodicUpdateBatch(IIterable<Uri ^> ^ tileContents, PeriodicUpdateRecurrence requestedInterval) = StartPeriodicUpdateBatch;

/// [Windows.Foundation.Metadata.Overload("StartPeriodicUpdateBatch")]
void StartPeriodicUpdateBatch(IIterable<Uri> const& tileContents, PeriodicUpdateRecurrence const& requestedInterval);

[Windows.Foundation.Metadata.Overload("StartPeriodicUpdateBatch")]
public void StartPeriodicUpdateBatch(IEnumerable<System.Uri> tileContents, PeriodicUpdateRecurrence requestedInterval);

function startPeriodicUpdateBatch(tileContents, requestedInterval)

Public Sub StartPeriodicUpdateBatch (tileContents As IEnumerable(Of Uri), requestedInterval As PeriodicUpdateRecurrence)

パラメーター

tileContents

IIterable<Uri>

IEnumerable<Uri>

循環タイルの更新の XML コンテンツの取得元となる最大 5 つの Uniform Resource Identifier (URI) の配列。 配列に 5 つ以上の Uniform Resource Identifier (URI) が含まれている場合、メソッドは失敗します。

requestedInterval

PeriodicUpdateRecurrence

startTime での最初の更新に続いて、新しいタイル コンテンツに対して Uri (Uniform Resource Identifier) がポーリングされる頻度。

属性

OverloadAttribute

注釈

定期的な更新で通知キューを使用する

通知キューを使用するには、まず、次のコード行を使用してタイルに対して有効にする必要があります。

Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true);

この API は、アプリの有効期間中に 1 回だけ呼び出す必要がありますが、アプリを起動するたびに呼び出しても問題はありません。

定期的な通知の場合は、通知ごとに一意の URL が提供されます。 各 URL は、更新された通知コンテンツについて Windows によって定期的にポーリングされます。 各 URL から返されるコンテンツ ペイロードには、サポートされているすべてのタイル サイズの通知 XML のバージョンが含まれている必要があります。 ポーリングされた各 URL は、必要に応じて独自の一意の有効期限とタグ値を返すこともできます。

定期的な更新に関する通知のタグ付け

通知キューを有効にすると、タイルは最大 5 つのキューに登録された通知を順番に切り替えることができます。 一般に、新しい通知が到着すると、最も古い通知がキューに置き換えられます。 ただし、特定のタグを持つ新しい通知がキュー内の場所に関係なく、古い通知を同じタグに置き換えるように、通知にタグを付けることができます。

タグは、通知で識別子として設定できる最大 16 文字の省略可能な文字列です。 新しい通知がキューに既に存在する通知と同じタグで到着した場合、新しい通知は、既定の先入れ先出しキューの動作に該当するのではなく、古い通知に置き換えられます。 これにより、同じ通知の 2 つのバージョン (そのうちの 1 つが古い) が同時にキューに存在する場合を防ぐことができます。

定期的な通知の場合は、通知の HTTP 応答メッセージの X-WNS-Tag ヘッダーにタグが提供されます。これには、通知の内容も含まれます。 このメッセージは、通知の Uniform Resource Identifier (URI) に対するシステムの定期的な呼び出しに応答して送信されます。 ヘッダー名とタグ値では、大文字と小文字は区別されません。

次に 1 つの例を示します。

X-WNS-Tag: stockMSFT

定期的な更新の有効期限を設定する

定期的な通知は、3 日後に既定で期限切れになります。 通知コンテンツの有効期間が大幅に異なる (短いまたは長い) 場合は、各通知の有効期限を明示的に設定する必要があります。 これにより、古いコンテンツや無関係なコンテンツがキューに残らないようにします。 これは、ユーザーのコンピューターが長期間インターネット接続を失った場合に特に重要です。

たとえば、アクティブな取引中は、株価通知の有効期限をポーリング間隔の 2 倍に設定することをお勧めします。たとえば、更新プログラムを 30 分ごとにポーリングすると送信されてから 1 時間後に期限切れになる通知などです。 ニュース アプリの場合は、1 日の上位のニュースを表示するタイルの有効期限が 1 日に切れるのが適切です。

定期的な通知の場合、有効期限は通知の HTTP 応答メッセージの X-WNS-Expires ヘッダーに設定されます。 有効期限は HTTP 日付として表され、次の例に示す形式のいずれかを使用します。

• 1994 年 11 月 6 日(日) 08:49:37 GMT
• 日曜日, 06-Nov-94 08:49:37 GMT
• 日 11月 6 日 08:49:37 1994

HTTP 日付形式の詳細については、World Wide Web Consortium (W3C) 3 プロトコル パラメーター に関するドキュメントを参照してください。

通知キューと組み合わせて使用される定期的な通知の完全な実装の例については、 プッシュ通知と定期的な通知のサンプル (アーカイブ) のシナリオ 3 を参照してください。

こちらもご覧ください

• StartPeriodicUpdateBatch(IIterable<Uri>, DateTime, PeriodicUpdateRecurrence)
• StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)
• タイルの定期的な通知を設定する方法
• 定期的な通知のガイドラインとチェックリスト
• タイルとタイルの通知の概要

StartPeriodicUpdateBatch(IIterable<Uri>, DateTime, PeriodicUpdateRecurrence)

アップデーターがバインドされているタイルで循環する一連の時間指定更新を開始します。 更新内容は、指定した Uri (Uniform Resource Identifier) の配列から取得され、更新は指定された時刻から開始され、その後の定期的な間隔で更新が発生します。

注意

この機能を使用するには、まず EnableNotificationQueue を呼び出してタイルの通知キューを有効にする必要があります。

public:
 virtual void StartPeriodicUpdateBatch(IIterable<Uri ^> ^ tileContents, DateTime startTime, PeriodicUpdateRecurrence requestedInterval) = StartPeriodicUpdateBatch;

/// [Windows.Foundation.Metadata.Overload("StartPeriodicUpdateBatchAtTime")]
void StartPeriodicUpdateBatch(IIterable<Uri> const& tileContents, DateTime const& startTime, PeriodicUpdateRecurrence const& requestedInterval);

[Windows.Foundation.Metadata.Overload("StartPeriodicUpdateBatchAtTime")]
public void StartPeriodicUpdateBatch(IEnumerable<System.Uri> tileContents, System.DateTimeOffset startTime, PeriodicUpdateRecurrence requestedInterval);

function startPeriodicUpdateBatch(tileContents, startTime, requestedInterval)

Public Sub StartPeriodicUpdateBatch (tileContents As IEnumerable(Of Uri), startTime As DateTimeOffset, requestedInterval As PeriodicUpdateRecurrence)

パラメーター

tileContents

IIterable<Uri>

IEnumerable<Uri>

循環タイルの更新の XML コンテンツの取得元となる最大 5 つの Uniform Resource Identifier (URI) の配列。 配列に 5 つ以上の Uniform Resource Identifier (URI) が含まれている場合、メソッドは失敗します。

startTime

DateTime DateTimeOffset

最初の Uniform Resource Identifier (URI) が最初に新しいコンテンツに対してポーリングされる時刻。

requestedInterval

PeriodicUpdateRecurrence

startTime での最初の更新に続いて、新しいタイル コンテンツに対して Uri (Uniform Resource Identifier) がポーリングされる頻度。

属性

OverloadAttribute

注釈

定期的な更新で通知キューを使用する

通知キューを使用するには、まず、次のコード行を使用してタイルに対して有効にする必要があります。

Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true);

この API は、アプリの有効期間中に 1 回だけ呼び出す必要がありますが、アプリを起動するたびに呼び出しても問題はありません。

定期的な通知の場合は、通知ごとに一意の URL が提供されます。 各 URL は、更新された通知コンテンツについて Windows によって定期的にポーリングされます。 各 URL から返されるコンテンツ ペイロードには、サポートされているすべてのタイル サイズの通知 XML のバージョンが含まれている必要があります。 ポーリングされた各 URL は、必要に応じて独自の一意の有効期限とタグ値を返すこともできます。

定期的な更新に関する通知のタグ付け

通知キューを有効にすると、タイルは最大 5 つのキューに登録された通知を順番に切り替えることができます。 一般に、新しい通知が到着すると、最も古い通知がキューに置き換えられます。 ただし、特定のタグを持つ新しい通知がキュー内の場所に関係なく、古い通知を同じタグに置き換えるように、通知にタグを付けることができます。

タグは、通知で識別子として設定できる最大 16 文字の省略可能な文字列です。 新しい通知がキューに既に存在する通知と同じタグで到着した場合、新しい通知は、既定の先入れ先出しキューの動作に該当するのではなく、古い通知に置き換えられます。 これにより、同じ通知の 2 つのバージョン (そのうちの 1 つが古い) が同時にキューに存在する場合を防ぐことができます。

定期的な通知の場合は、通知の HTTP 応答メッセージの X-WNS-Tag ヘッダーにタグが提供されます。これには、通知の内容も含まれます。 このメッセージは、通知の Uniform Resource Identifier (URI) に対するシステムの定期的な呼び出しに応答して送信されます。 ヘッダー名とタグ値では、大文字と小文字は区別されません。

次に 1 つの例を示します。

X-WNS-Tag: stockMSFT

定期的な更新の有効期限を設定する

タイルは、3 日後に既定で期限切れになります。 通知コンテンツの有効期間が大幅に異なる (短いまたは長い) 場合は、各通知の有効期限を明示的に設定する必要があります。 これにより、古いコンテンツや無関係なコンテンツがキューに残らないようにします。 これは、ユーザーのコンピューターが長期間インターネット接続を失った場合に特に重要です。

たとえば、アクティブな取引中は、株価通知の有効期限をポーリング間隔の 2 倍に設定することをお勧めします。たとえば、更新プログラムを 30 分ごとにポーリングすると送信されてから 1 時間後に期限切れになる通知などです。 ニュース アプリの場合は、1 日の上位のニュースを表示するタイルの有効期限が 1 日に切れるのが適切です。

定期的な通知の場合、有効期限は通知の HTTP 応答メッセージの X-WNS-Expires ヘッダーに設定されます。 有効期限は HTTP 日付として表され、次の例に示す形式のいずれかを使用します。

• 1994 年 11 月 6 日(日) 08:49:37 GMT
• 日曜日, 06-Nov-94 08:49:37 GMT
• 日 11月 6 日 08:49:37 1994

HTTP 日付形式の詳細については、World Wide Web Consortium (W3C) 3 プロトコル パラメーター に関するドキュメントを参照してください。

通知キューと組み合わせて使用される定期的な通知の完全な実装の例については、 プッシュ通知と定期的な通知のサンプル (アーカイブ) のシナリオ 3 を参照してください。

こちらもご覧ください

• StartPeriodicUpdateBatch(IIterable<Uri>, PeriodicUpdateRecurrence)
• StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)
• タイルの定期的な通知を設定する方法
• 定期的な通知のガイドラインとチェックリスト
• タイルとタイルの通知の概要