Office.MasterCategories interface

Ссылка

Пакет:: outlook

Представляет главный список категорий в почтовом ящике.

В 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

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult.

Возвращаемое значение

void

Примеры

// 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

Возвращаемое значение

void

getAsync(options, callback)

Возвращает главный список категорий в почтовом ящике.

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

Параметры

options: Office.AsyncContextOptions

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. Если добавление категорий завершается ошибкой asyncResult.error , свойство будет содержать код ошибки.

Возвращаемое значение

void

getAsync(callback)

Возвращает главный список категорий в почтовом ящике.

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

Параметры

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult.

Возвращаемое значение

void

Примеры

// 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

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. Если удаление категорий завершается ошибкой asyncResult.error , свойство будет содержать код ошибки.

Возвращаемое значение

void

Примеры

// 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

Возвращаемое значение

void

Office.MasterCategories interface

Комментарии

Методы

Сведения о методе

addAsync(categories, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

addAsync(categories, callback)

Параметры

Возвращаемое значение

Комментарии

getAsync(options, callback)

Параметры

Возвращаемое значение

Комментарии

getAsync(callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

removeAsync(categories, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

removeAsync(categories, callback)

Параметры

Возвращаемое значение

Комментарии

Обратная связь

Дополнительные ресурсы