Office.SmartAlertsEventCompletedOptions interface
または OnAppointmentSend
イベントの処理が完了したときのスマート アラート アドインの動作をOnMessageSend
指定します。
注釈
例
// The following example checks whether a location is specified in an appointment before it's sent.
function onAppointmentSendHandler(event) {
Office.context.mailbox.item.location.getAsync({ asyncContext: event }, asyncResult => {
const event = asyncResult.asyncContext;
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
// If the add-in is unable to retrieve the appointment's location, the appointment isn't sent.
event.completed({ allowEvent: false, errorMessage: "Failed to get the appointment's location." });
return;
}
if (asyncResult.value === "") {
// If no location is specified, the appointment isn't sent and the user is alerted to include a location.
event.completed(
{
allowEvent: false,
cancelLabel: "Add a location",
commandId: "msgComposeOpenPaneButton",
contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
errorMessage: "Don't forget to add a meeting location.",
sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
}
);
} else {
// If a location is specified, the appointment is sent.
event.completed({ allowEvent: true });
}
});
}
プロパティ
allow |
完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントが実行を続行するか、取り消されるかを示します。 たとえば、 または |
cancel |
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのプロパティを 例については、 スマート アラートのチュートリアルを参照してください。 |
command |
完了したメソッドを使用してイベント ハンドラーの完了を通知し、その 例については、 スマート アラートのチュートリアルを参照してください。 |
context |
完了したメソッドを使用してイベント ハンドラーの完了を通知し、その |
error |
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのプロパティを |
send |
完了したメソッドを使用してイベント ハンドラーの完了を通知し、その 例については、 スマート アラートのチュートリアルを参照してください。 |
プロパティの詳細
allowEvent
完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、処理されたイベントが実行を続行するか、取り消されるかを示します。 たとえば、 または OnAppointmentSend
イベントを処理するアドインを OnMessageSend
にfalse
設定allowEvent
すると、アイテムの送信を取り消すことができます。 完全なサンプルについては、 スマート アラートのチュートリアルを参照してください。
allowEvent?: boolean;
プロパティ値
boolean
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
cancelLabel
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのプロパティを allowEvent
にfalse
設定すると、スマート アラート ダイアログの [送信しない] ボタンのテキストがカスタマイズされます。 カスタム テキストは 20 文字以下にする必要があります。
例については、 スマート アラートのチュートリアルを参照してください。
cancelLabel?: string;
プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
commandId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent
プロパティを にfalse
設定すると、このプロパティは、[スマート アラート] ダイアログで [送信しない] ボタンが選択されたときに開く作業ウィンドウの ID を指定します。
例については、 スマート アラートのチュートリアルを参照してください。
commandId?: string;
プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
重要:
値は commandId
、アドインのマニフェストで指定された作業ウィンドウ ID と一致する必要があります。 マークアップは、アドインで使用するマニフェストの種類によって異なります。
XML マニフェスト:
id
作業ウィンドウを表す Control 要素の属性。Microsoft 365 の統合マニフェスト: "extensions.ribbons.tabs.groups.controls" 配列の作業ウィンドウ コマンドの "id" プロパティ。
呼び出しでオプションをevent.completed
指定するcontextData
場合は、作業ウィンドウ ID もオプションにcommandId
割り当てる必要があります。 それ以外の場合、割り当てられた contextData
JSON データは無視されます。
contextData
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent
プロパティを にfalse
設定すると、このプロパティは、[スマート アラート] ダイアログで [送信しない] ボタンが選択されたときに処理するためにアドインに渡されるすべての JSON データを指定します。
contextData?: any;
プロパティ値
any
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
重要:
Outlook on Windows では、
any
種類はバージョン 2402 (ビルド 17308.20000) 以降でサポートされています。 以前のバージョンの Outlook on Windows では、型のみがstring
サポートされています。呼び出しでオプションを
event.completed
指定するcontextData
場合は、作業ウィンドウ ID もオプションにcommandId
割り当てる必要があります。 それ以外の場合、割り当てられたcontextData
JSON データは無視されます。プロパティの値を
contextData
取得するには、作業ウィンドウの JavaScript 実装で を呼び出すOffice.context.mailbox.item.getInitializationContextAsync
必要があります。 を使用してJSON.stringify()
JSON 文字列を作成し、 プロパティにcontextData
割り当てる場合は、取得後に を使用して文字列をJSON.parse()
解析する必要があります。
errorMessage
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのプロパティを allowEvent
にfalse
設定すると、このプロパティはユーザーに表示されるエラー メッセージを設定します。 例については、 スマート アラートのチュートリアルを参照してください。
errorMessage?: string;
プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
sendModeOverride
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent
プロパティを にfalse
設定すると、このプロパティは実行時にマニフェストで指定された送信モード オプションをオーバーライドします。
例については、 スマート アラートのチュートリアルを参照してください。
sendModeOverride?: MailboxEnums.SendModeOverride | string;
プロパティ値
Office.MailboxEnums.SendModeOverride | string
注釈
最小アクセス許可レベル (Outlook): 制限あり
適用できる Outlook モード: 新規作成
重要: 現時点では、 sendModeOverride
プロンプト ユーザー オプションにのみ設定できます。
Office Add-ins
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示