Поделиться через

Office.Categories interface

  • Ссылка
Пакет:
outlook

Представляет категории элемента.

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

Важно! В Outlook в Интернете и новом Outlook в Windows нельзя использовать API для управления категориями, примененными к сообщению, в режиме Compose.

Комментарии

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

Минимальный уровень разрешений: чтение элемента

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

Методы

addAsync(categories, options, callback)

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

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

Возвращает категории элемента.

Важно!

  • Если в элементе нет категорий или в зависимости от версии Outlook будет возвращен пустой массив, null обязательно обработайте оба случая.

  • В Outlook в Интернете и новом Outlook в Windows api нельзя использовать для управления категориями, применяемыми к сообщению, в режиме Compose.
getAsync(callback)

Возвращает категории элемента.

Важно!

  • Если в элементе нет категорий или в зависимости от версии Outlook будет возвращен пустой массив, null обязательно обработайте оба случая.

  • В Outlook в Интернете и новом Outlook в Windows api нельзя использовать для управления категориями, применяемыми к сообщению, в режиме Compose.
removeAsync(categories, options, callback)

Удаляет категории из элемента.
removeAsync(categories, callback)

Удаляет категории из элемента.

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

addAsync(categories, options, callback)

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

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

Параметры

categories

string[]

Категории, добавляемые в элемент.

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

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

Важно! В Outlook в Интернете и новых приложениях Outlook в Windows нельзя использовать API для управления категориями, применяемыми к сообщению или элементу встречи, в режиме Compose.

Ошибки:

  • InvalidCategory : указаны недопустимые категории.

Примеры

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

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

addAsync(categories, callback)

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

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

Параметры

categories

string[]

Категории, добавляемые в элемент.

callback

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

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

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

void

Комментарии

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

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

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

Важно! В Outlook в Интернете и новых приложениях Outlook в Windows нельзя использовать API для управления категориями, применяемыми к сообщению или элементу встречи, в режиме Compose.

Ошибки:

  • InvalidCategory : указаны недопустимые категории.

getAsync(options, callback)

Возвращает категории элемента.

Важно!

  • Если в элементе нет категорий или в зависимости от версии Outlook будет возвращен пустой массив, null обязательно обработайте оба случая.

  • В Outlook в Интернете и новом Outlook в Windows api нельзя использовать для управления категориями, применяемыми к сообщению, в режиме Compose.

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)

Возвращает категории элемента.

Важно!

  • Если в элементе нет категорий или в зависимости от версии Outlook будет возвращен пустой массив, null обязательно обработайте оба случая.

  • В Outlook в Интернете и новом Outlook в Windows api нельзя использовать для управления категориями, применяемыми к сообщению, в режиме Compose.

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

Параметры

callback

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

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

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

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-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } 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

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

callback

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

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

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

void

Комментарии

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

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

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

Важно! В Outlook в Интернете и новых приложениях Outlook в Windows нельзя использовать API для управления категориями, применяемыми к сообщению или элементу встречи, в режиме Compose.

Примеры

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

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, callback)

Удаляет категории из элемента.

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

Параметры

categories

string[]

Категории, которые необходимо удалить из элемента.

callback

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

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

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

void

Комментарии

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

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

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

Важно! В Outlook в Интернете и новых приложениях Outlook в Windows нельзя использовать API для управления категориями, применяемыми к сообщению или элементу встречи, в режиме Compose.