Office.RoamingSettings interface
RoamingSettings オブジェクトのメソッドを使用して作成された設定は、アドインごと、およびユーザーごとに保存されます。 つまり、それらを作成したアドインと、それらが保存されているユーザーのメールボックスからのみ利用できます。
Outlook アドイン API は、これらの設定へのアクセスを作成したアドインのみに制限しますが、これらの設定をセキュリティで保護されたストレージと見なすべきではありません。 これらの設定は、Exchange Web サービスや拡張 MAPI からアクセスできます。 ユーザー資格情報やセキュリティ トークンなどの機密情報を格納するために使用しないでください。
設定の名前は String ですが、値は String、Number、Boolean、null、Object、Array のいずれかになります。
RoamingSettings オブジェクトには、Office.context 名前空間の roamingSettings プロパティを介してアクセスできます。
RoamingSettings
の詳細については、「Outlook アドインのアドイン メタデータを取得して設定する」を参照してください。
注釈
重要:
RoamingSettingsオブジェクトは、アドインが最初に読み込まれたときにのみ、永続ストレージから初期化されます。 作業ウィンドウの場合、これは、作業ウィンドウを最初に開いたときにのみ初期化されることを意味します。 作業ウィンドウで別のページに移動するか、現在のページを再読み込みすると、アドインに変更が保持されていても、メモリ内オブジェクトはその初期値にリセットされます。 保持された変更は、作業ウィンドウ (または UI を使用しないアドインの場合は項目) を閉じて再度開くまで利用できません。Windows 上の従来の Outlook では、別の Outlook クライアントでローミング設定が構成されている場合は、デスクトップ クライアントを再起動する必要はありません。 ただし、これらの設定にアクセスするには、アドインを再読み込みする必要があります。 Outlook on the web、Mac、および新しい Outlook on Windows では、別のクライアントに設定されたローミング設定にアクセスするには、ブラウザーを更新するか、クライアントを再起動する必要があります。
最小アクセス許可レベル: 制限付き
適用可能な Outlook モード: Composeまたは読み取り
使用元
メソッド
| get(name) | 指定された設定を取得します。 |
| remove(name) | 指定された設定を削除します。 |
| save |
設定を保存します。 アドインによって以前に保存された設定はすべて、アドインが初期化されるときに読み込まれるため、セッションの有効期間中は、set メソッドと get メソッドを使用するだけで、設定プロパティ バッグのメモリ内コピーを操作できます。 次回アドインを使用するときに使用できるように設定を保持する場合は、 |
| set(name, value) | 指定された設定を行うかまたは作成します。
各アドインの設定には最大 32 KB を使用できます。 サイズ制限を超えると、コード 9057 のエラーがスローされます。
|
メソッドの詳細
get(name)
指定された設定を取得します。
get(name: string): any;パラメーター
- name
-
string
The case-sensitive name of the setting to retrieve.
返品
any
型: 文字列 |Number |Boolean |オブジェクト |配列
注釈
最小アクセス許可レベル: 制限付き
適用可能な Outlook モード: Composeまたは読み取り
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
const settingValue = Office.context.roamingSettings.get(settingName);
(document.getElementById("settingValue") as HTMLInputElement).value = settingValue;
console.log(`The value of setting "${settingName}" is "${settingValue}".`);
remove(name)
指定された設定を削除します。
remove(name: string): void;パラメーター
- name
-
string
The case-sensitive name of the setting to remove.
返品
void
注釈
最小アクセス許可レベル: 制限付き
適用可能な Outlook モード: Composeまたは読み取り
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
// Remove the specified setting from the mailbox.
const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
Office.context.roamingSettings.remove(settingName);
console.log(`The "${settingName}" setting has been removed.`);
saveAsync(callback)
設定を保存します。
アドインによって以前に保存された設定はすべて、アドインが初期化されるときに読み込まれるため、セッションの有効期間中は、set メソッドと get メソッドを使用するだけで、設定プロパティ バッグのメモリ内コピーを操作できます。 次回アドインを使用するときに使用できるように設定を保持する場合は、 saveAsync メソッドを使用します。
saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が型 Office.AsyncResult の 1 つのパラメーターで呼び出されます。
返品
void
注釈
最小アクセス許可レベル: 制限付き
適用可能な Outlook モード: Composeまたは読み取り
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
// Save settings in the mailbox to make it available in future sessions.
Office.context.roamingSettings.saveAsync(function(result) {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
} else {
console.log(`Settings saved with status: ${result.status}`);
}
});
set(name, value)
指定された設定を行うかまたは作成します。
set メソッドは、指定した名前の新しい設定を作成します (まだ存在しない場合) または、指定した名前の既存の設定を設定します。 値は、そのデータ型のシリアル化された JSON 表現としてドキュメントに格納されます。
各アドインの設定には最大 32 KB を使用できます。 サイズ制限を超えると、コード 9057 のエラーがスローされます。
set メソッドを使用して設定を変更しても、saveAsync メソッドが呼び出されるまでサーバーに保存されません。
set(name: string, value: any): void;パラメーター
- name
-
string
The case-sensitive name of the setting to set or create.
- value
-
any
Specifies the value to be stored.
返品
void
注釈
最小アクセス許可レベル: 制限付き
適用可能な Outlook モード: Composeまたは読み取り
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml
const settingName = (document.getElementById("settingName") as HTMLInputElement).value;
const settingValue = (document.getElementById("settingValue") as HTMLInputElement).value;
Office.context.roamingSettings.set(settingName, settingValue);
console.log(`Setting "${settingName}" set to value "${settingValue}".`);