Office.MasterCategories interface

Пакет:

outlook

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

В Outlook пользователь может помечать сообщения и встречи, используя для них цветовую маркировку. Пользователь определяет категории в главном списке своего почтового ящика. Затем он может применить одну или несколько категорий к элементу.

Важно! В делегированных или общих сценариях делегат может получать категории из списка master, но не может добавлять или удалять категории.

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Используется

• Office.Mailbox: masterCategories

Методы

addAsync(categories, options, callback)	Добавляет категории в список master в почтовом ящике. Каждая категория должна иметь уникальное название, но несколько категорий могут использовать один и тот же цвет.
addAsync(categories, callback)	Добавляет категории в список master в почтовом ящике. Каждая категория должна иметь уникальное название, но несколько категорий могут использовать один и тот же цвет.
getAsync(options, callback)	Получает master список категорий в почтовом ящике.
getAsync(callback)	Получает master список категорий в почтовом ящике.
removeAsync(categories, options, callback)	Удаляет категории из списка master в почтовом ящике.
removeAsync(categories, callback)	Удаляет категории из списка master в почтовом ящике.

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

addAsync(categories, options, callback)

Добавляет категории в список master в почтовом ящике. Каждая категория должна иметь уникальное название, но несколько категорий могут использовать один и тот же цвет.

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

Параметры

categories

Office.CategoryDetails[]

Категории, добавляемые в список master в почтовом ящике.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Ошибки:

• DuplicateCategory : одна из предоставленных категорий уже находится в списке категорий Master.

• 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)

Добавляет категории в список master в почтовом ящике. Каждая категория должна иметь уникальное название, но несколько категорий могут использовать один и тот же цвет.

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

Параметры

categories

Office.CategoryDetails[]

Категории, добавляемые в список master в почтовом ящике.

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Ошибки:

• DuplicateCategory : одна из предоставленных категорий уже находится в списке категорий Master.

• PermissionDenied : у пользователя нет разрешения на выполнение этого действия.

getAsync(options, callback)

Получает master список категорий в почтовом ящике.

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

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

getAsync(callback)

Получает master список категорий в почтовом ящике.

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Примеры

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

Удаляет категории из списка master в почтовом ящике.

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

Параметры

categories

string[]

Категории, которые нужно удалить из списка master в почтовом ящике.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Ошибки:

• 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)

Удаляет категории из списка master в почтовом ящике.

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

Параметры

categories

string[]

Категории, которые нужно удалить из списка master в почтовом ящике.

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

Минимальный уровень разрешений: почтовый ящик для чтения и записи

Применимый режим Outlook: Compose или чтение

Ошибки:

• PermissionDenied : у пользователя нет разрешения на выполнение этого действия.