PerformReminderAction 操作

[アーティクル]
03/29/2023

PerformReminderAction EWS 操作に関する情報を検索します。

PerformReminderAction Exchange Web Services (EWS) 操作は、リマインダーに対して無視またはスヌーズアクションを開始します。

この操作は Exchange Server 2013 で導入されました。

PerformReminderAction 操作の使用

PerformReminderAction 操作を使用して、GetReminders 操作によって返されるアラームを無視またはスヌーズ (遅延) できます。アラームをスヌーズするには、 ActionType を Snooze に設定し、 NewReminderTime 値を現在の ReminderTime より後の時刻に設定します。それ以外の場合、 NewReminderTime はサーバーによって無視されます。アラームが定期的な会議の発生に対するものであり、次の予定のリマインダーを過ぎた NewReminderTime を使用してアラームに対して Snooze アクションが実行された場合、アラームは実質的に無視されます。

アラームを無視するには、 ActionType を [閉じる] に設定します。サーバーが要求を処理すると、サーバーはアイテムの IsReminderSet 値を True から False に変更 します。

PerformReminderAction 操作 SOAP ヘッダー

PerformReminderAction 操作では、次の表に示す SOAP ヘッダーを使用できます。

ヘッダー名	要素	説明
偽装	ExchangeImpersonation	クライアントアプリケーションが偽装しているユーザーを識別します。このヘッダーは要求に適用されます。
MailboxCulture	MailboxCulture	RFC 3066 で定義されている "言語の識別用タグ" で定義されているカルチャを識別し、メールボックスにアクセスするために使用します。このヘッダーは要求に適用されます。
RequestVersion	RequestServerVersion	操作要求のスキーマバージョンを識別します。このヘッダーは要求に適用されます。
ServerVersion	ServerVersionInfo	要求に応答したサーバーのバージョンを識別します。このヘッダーは、応答に適用できます。

PerformReminderAction 操作要求の例

次の PerformReminderAction 操作要求の例は、現在のアラームをスヌーズし、新しいアラーム時間を設定する方法を示しています。 ItemId には ChangeKey を含める必要があり、NewReminderTime は GetReminders 操作によって返される ReminderTime より後の時刻に設定する必要があることに注意してください。

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <t:RequestServerVersion Version="Exchange2013" />
  </soap:Header>
  <soap:Body>
    <m:PerformReminderAction>
      <m:ReminderItemActions>
        <t:ReminderItemAction>
          <t:ActionType>Snooze</t:ActionType>
          <t:ItemId Id="vwAAAA=="
           ChangeKey="DwAAABQAAACOs0HEMq1WTKpI7sNu5qXNAAAUDA=="/>
          <t:NewReminderTime>2014-04-16T17:00:00Z</t:NewReminderTime>
        </t:ReminderItemAction>
      </m:ReminderItemActions>
    </m:PerformReminderAction>
  </soap:Body>
</soap:Envelope>

注:

ItemId 値は、読みやすさを維持するために短縮されました。

要求 SOAP 本文には、次の要素が含まれています。

PerformReminderAction 操作の応答に成功しました

次の例は、 PerformReminderAction 操作要求に対する正常な応答を示しています。 UpdatedItemIds 要素には、更新された予定表アイテムの ItemId が含まれています。

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="921"
                       MinorBuildNumber="20"
                       Version="V2_10"
                       xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <PerformReminderActionResponse ResponseClass="Success"
                                   xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <UpdatedItemIds>
        <ItemId Id="vwAAAA=="
                ChangeKey="DwAAABYAAAB4to43JyybTYwHLBM1k8MxAAAJKP+S"/>
      </UpdatedItemIds>
    </PerformReminderActionResponse>
  </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。

PerformReminderAction 操作エラー応答の例

次の例は、サーバーで変更が行われなかった場合の PerformReminderAction 操作要求への応答を示しています。これは、要求が送信されたが、 UpdatedItemIds が返されなかった応答です。つまり、アラームは変更されませんでした。

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="918"
                       MinorBuildNumber="7"
                       Version="V2_10"
                       xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <PerformReminderActionResponse ResponseClass="Success"
                                   xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <UpdatedItemIds />
    </PerformReminderActionResponse>
  </s:Body>
</s:Envelope>

エラー応答 SOAP 本文には、次の要素が含まれています。

EWS に一般的なその他のエラーコードについては、「 ResponseCode」を参照してください。