context (メールボックス要件セット 1.13)
Office.context
Office.context は、すべての Office アプリでアドインによって使用される共有インターフェイスを提供します。 この一覧には、Outlook アドインで使用されるインターフェイスのみが記載されています。Office.context 名前空間の完全な一覧については、 Common API の Office.context リファレンスを参照してください。
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
プロパティ
| プロパティ | モード | 戻り値の種類 | 最小値 要件セット |
|---|---|---|---|
| 認証 | 作成 読み取り |
Auth | IdentityAPI 1.3 |
| contentLanguage | 作成 読み取り |
文字列 | 1.1 |
| 診断 | 作成 読み取り |
ContextInformation | 1.5 |
| displayLanguage | 作成 読み取り |
文字列 | 1.1 |
| ホスト | 作成 読み取り |
HostType | 1.5 |
| mailbox | 作成 読み取り |
メールボックス | 1.1 |
| プラットフォーム | 作成 読み取り |
PlatformType | 1.5 |
| 要件 | 作成 読み取り |
RequirementSetSupport | 1.1 |
| roamingSettings | 作成 読み取り |
RoamingSettings | 1.1 |
| sensitivityLabelsCatalog | 作成 | SensitivityLabelsCatalog | 1.13 |
| UI | 作成 読み取り |
UI | 1.1 |
プロパティの詳細
認証: Auth
Office アプリケーションがアドインの Web アプリケーションへのアクセス トークンを取得できるようにするメソッドを提供することで、 シングル サインオン (SSO) をサポートします。 これにより、間接的に、サインインしたユーザーの Microsoft Graph データにアドインがアクセスできるようにもなります。ユーザーがもう一度サインインする必要はありません。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.10 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
Office.context.auth.getAccessTokenAsync(function(result) {
if (result.status === "succeeded") {
var token = result.value;
// ...
} else {
console.log("Error obtaining token", result.error);
}
});
contentLanguage: String
アイテムを編集するためにユーザーによって指定されたロケール (言語) を取得します。
この値はcontentLanguage、Office クライアント アプリケーションの [ファイル > オプション言語] で指定されている現在の [編集言語] > 設定を反映します。
型
- String
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
function sayHelloWithContentLanguage() {
var myContentLanguage = Office.context.contentLanguage;
switch (myContentLanguage) {
case 'en-US':
write('Hello!');
break;
case 'en-NZ':
write('G\'day mate!');
break;
}
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
診断: ContextInformation
アドインが実行されている環境に関する情報を取得します。
注:
すべてのメールボックス要件セットについて、Office.context.mailbox.診断 プロパティを使用して同様の情報を取得することもできます。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.5 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
var contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);
displayLanguage: 文字列
Office クライアント アプリケーションの UI に対してユーザーによって指定された RFC 1766 言語タグ形式のロケール (言語) を取得します。
この値はdisplayLanguage、Office クライアント アプリケーションの [ファイル>オプション言語]> で指定されている現在の表示言語設定を反映します。
型
- String
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
function sayHelloWithDisplayLanguage() {
var myDisplayLanguage = Office.context.displayLanguage;
switch (myDisplayLanguage) {
case 'en-US':
write('Hello!');
break;
case 'en-NZ':
write('G\'day mate!');
break;
}
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
host: HostType
アドインをホストしている Office アプリケーションを取得します。
注:
または、Office.context.診断 プロパティを使用してホストを取得することもできます。 すべてのメールボックス要件セットについて、Office.context.mailbox.診断 プロパティを使用して同様の情報を取得することもできます。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.5 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
console.log(JSON.stringify(Office.context.host));
platform: PlatformType
アドインが実行されているプラットフォームを提供します。
注:
または、Office.context.診断 プロパティを使用してプラットフォームを取得することもできます。 すべてのメールボックス要件セットについて、Office.context.mailbox.診断 プロパティを使用して同様の情報を取得することもできます。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.5 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
console.log(JSON.stringify(Office.context.platform));
requirements: RequirementsSetSupport
現在のアプリケーションとプラットフォームでサポートされている要件セットを決定するためのメソッドを提供します。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
例
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));
roamingSettings: RoamingSettings
ユーザーのメールボックスに保存されている、メール アドインのカスタム設定や状態を表すオブジェクトを取得します。
RoamingSettingsオブジェクトを使用すると、ユーザーのメールボックスに格納されているメール アドインのデータを格納およびアクセスできるため、そのメールボックスへのアクセスに使用される Outlook クライアントから実行されている場合に、そのアドインで使用できます。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 最小限のアクセス許可レベル | 制限 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
sensitivityLabelsCatalog: SensitivityLabelsCatalog
Outlook で秘密度ラベルのカタログの状態をチェックするオブジェクトを取得し、カタログが有効になっている場合は使用可能なすべての秘密度ラベルを取得します。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.13 |
| 最小限のアクセス許可レベル | 読み取り/書き込み項目 |
| 適用可能な Outlook のモード | 作成 |
ui: UI
Office アドインで、ダイアログ ボックスなどの UI コンポーネントを作成および操作するために使用できるオブジェクトとメソッドを提供します。
型
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 適用可能な Outlook のモード | 新規作成または閲覧 |
Office Add-ins