Office.Subject interface
Outlook のアドインで、予定またはメッセージの件名を取得および設定するメソッドを提供します。
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
メソッド
| get |
予定またはメッセージの件名を取得します。
|
| get |
予定またはメッセージの件名を取得します。
|
| set |
予定またはメッセージの件名を設定します。
|
| set |
予定またはメッセージの件名を設定します。
|
メソッドの詳細
getAsync(options, callback)
予定またはメッセージの件名を取得します。
getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定またはメッセージの件名を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 結果の value プロパティは、アイテムの件名です。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
getAsync(callback)
予定またはメッセージの件名を取得します。
getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定またはメッセージの件名を取得します。
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 結果の value プロパティは、アイテムの件名です。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
例
Office.context.mailbox.item.subject.getAsync(callback);
function callback(asyncResult) {
const subject = asyncResult.value;
}
setAsync(subject, options, callback)
予定またはメッセージの件名を設定します。
setAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始して、予定またはメッセージの件名を設定します。 件名を設定すると、現在の件名は上書きされますが、"Fwd:" または "Re:" などのプレフィックスはそのまま残ります。
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- subject
-
string
予定またはメッセージの件名。 文字列の長さは最大 255 文字です。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 件名の設定に失敗すると、asyncResult.error プロパティにエラー コードが格納されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
重要: Outlook on Android および iOS では、このメソッドはメッセージ Compose モードではサポートされていません。 予定オーガナイザー モードのみがサポートされています。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
エラー:
-
DataExceedsMaximumSize: subject パラメーターが 255 文字を超えています。
例
Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
if (asyncResult.status === "failed") {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(subject, callback)
予定またはメッセージの件名を設定します。
setAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始して、予定またはメッセージの件名を設定します。 件名を設定すると、現在の件名は上書きされますが、"Fwd:" または "Re:" などのプレフィックスはそのまま残ります。
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- subject
-
string
予定またはメッセージの件名。 文字列の長さは最大 255 文字です。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 件名の設定に失敗すると、asyncResult.error プロパティにエラー コードが格納されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
重要: Outlook on Android および iOS では、このメソッドはメッセージ Compose モードではサポートされていません。 予定オーガナイザー モードのみがサポートされています。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
エラー:
-
DataExceedsMaximumSize: subject パラメーターが 255 文字を超えています。
Office Add-ins