次の方法で共有


Office.MasterCategories interface

メールボックスのカテゴリ マスター リストを表します。

Outlook では、ユーザーはカテゴリを使用してメッセージと予定にタグを付けて色分けすることができます。 ユーザーは自分のメールボックスのマスター リストにカテゴリを定義します。 その後、アイテムに 1 つ以上のカテゴリを適用できます。

重要: デリゲートまたは共有シナリオでは、デリゲートはマスター リスト内のカテゴリを取得できますが、カテゴリを追加または削除することはできません。

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

メソッド

addAsync(categories, options, callback)

メールボックスのマスター リストにカテゴリを追加します。 各カテゴリには一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

addAsync(categories, callback)

メールボックスのマスター リストにカテゴリを追加します。 各カテゴリには一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

getAsync(options, callback)

メールボックスのカテゴリのマスター リストを取得します。

getAsync(callback)

メールボックスのカテゴリのマスター リストを取得します。

removeAsync(categories, options, callback)

メールボックスのマスター リストからカテゴリを削除します。

removeAsync(categories, callback)

メールボックスのマスター リストからカテゴリを削除します。

メソッドの詳細

addAsync(categories, options, callback)

メールボックスのマスター リストにカテゴリを追加します。 各カテゴリには一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

Office.CategoryDetails[]

メールボックスのマスター リストに追加するカテゴリ。

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

エラー:

  • DuplicateCategory: 指定されたカテゴリの 1 つが既にマスター カテゴリ一覧に含まれています。

  • PermissionDenied: ユーザーには、このアクションを実行するアクセス許可がありません。

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml

const masterCategoriesToAdd = [
  {
    displayName: "TestCategory",
    color: Office.MailboxEnums.CategoryColor.Preset0
  }
];

Office.context.mailbox.masterCategories.addAsync(masterCategoriesToAdd, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully added categories to master list");
  } else {
    console.log("masterCategories.addAsync call failed with error: " + asyncResult.error.message);
  }
});

addAsync(categories, callback)

メールボックスのマスター リストにカテゴリを追加します。 各カテゴリには一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

Office.CategoryDetails[]

メールボックスのマスター リストに追加するカテゴリ。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

エラー:

  • DuplicateCategory: 指定されたカテゴリの 1 つが既にマスター カテゴリ一覧に含まれています。

  • PermissionDenied: ユーザーには、このアクションを実行するアクセス許可がありません。

getAsync(options, callback)

メールボックスのカテゴリのマスター リストを取得します。

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

パラメーター

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 カテゴリの追加が失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

getAsync(callback)

メールボックスのカテゴリのマスター リストを取得します。

getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

パラメーター

callback

(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Master categories:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories in the master list.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

メールボックスのマスター リストからカテゴリを削除します。

removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

メールボックスのマスター リストから削除するカテゴリ。

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 カテゴリの削除が失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

エラー:

  • PermissionDenied: ユーザーには、このアクションを実行するアクセス許可がありません。

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml

const masterCategoriesToRemove = ["TestCategory"];

Office.context.mailbox.masterCategories.removeAsync(masterCategoriesToRemove, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully removed categories from master list");
  } else {
    console.log("masterCategories.removeAsync call failed with error: " + asyncResult.error.message);
  }
});

removeAsync(categories, callback)

メールボックスのマスター リストからカテゴリを削除します。

removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

メールボックスのマスター リストから削除するカテゴリ。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 カテゴリの削除が失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

[ API セット: メールボックス 1.8 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用できる Outlook モード: 新規作成または読み取り

エラー:

  • PermissionDenied: ユーザーには、このアクションを実行するアクセス許可がありません。