Office.SessionData interface

Пакет:

outlook

Предоставляет методы для управления данными сеанса элемента.

Данные сеанса относятся к одному элементу почты. Они не используются несколькими элементами, даже если одна и та же надстройка используется для установки или получения данных.

Комментарии

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

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

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

Важно! В клиентах Outlook, поддерживающих почтовый ящик 1.15 или более ранних версий, длина всего объекта SessionData для каждого элемента почты ограничена 50 000 символов на надстройку. В клиентах, поддерживающих почтовые ящики версии 1.16 или более поздней версии, максимальная длина одной надстройки составляет 2 621 440 символов.

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

• Office.AppointmentCompose: sessionData
• Office.MessageCompose: sessionData

Методы

clearAsync(options, callback)	Очищает все пары "ключ-значение" для данных сеанса.
clearAsync(callback)	Очищает все пары "ключ-значение" для данных сеанса.
getAllAsync(callback)	Получает все пары "ключ-значение" данных сеанса.
getAsync(name, callback)	Получает значение данных сеанса для указанного ключа.
removeAsync(name, options, callback)	Удаляет пару "ключ-значение" данных сеанса.
removeAsync(name, callback)	Удаляет пару "ключ-значение" данных сеанса.
setAsync(name, value, options, callback)	Устанавливает пару "ключ-значение" данных сеанса.
setAsync(name, value, callback)	Устанавливает пару "ключ-значение" данных сеанса.

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

clearAsync(options, callback)

Очищает все пары "ключ-значение" для данных сеанса.

clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.clearAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.clearAsync succeeded");
  } else {
    console.log("Failed to clear sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

clearAsync(callback)

Очищает все пары "ключ-значение" для данных сеанса.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

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

getAllAsync(callback)

Получает все пары "ключ-значение" данных сеанса.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

getAsync(name, callback)

Получает значение данных сеанса для указанного ключа.

getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

name

string

Ключ данных сеанса.

callback

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

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

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

void

Комментарии

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

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAsync(
  "Date",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData value is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

removeAsync(name, options, callback)

Удаляет пару "ключ-значение" данных сеанса.

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

Параметры

name

string

Ключ данных сеанса.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.removeAsync(
  "Date",
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("sessionData.removeAsync succeeded");
    } else {
      console.log("Failed to remove sessionData. Error: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(name, callback)

Удаляет пару "ключ-значение" данных сеанса.

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

Параметры

name

string

Ключ данных сеанса.

callback

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

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

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

void

Комментарии

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

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

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

setAsync(name, value, options, callback)

Устанавливает пару "ключ-значение" данных сеанса.

setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

name

string

Ключ данных сеанса.

value

string

Значение данных сеанса в виде строки.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

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

Важно! В клиентах Outlook, поддерживающих почтовый ящик 1.15 или более ранних версий, длина всего объекта SessionData для каждого элемента почты ограничена 50 000 символов на надстройку. В клиентах, поддерживающих почтовые ящики версии 1.16 или более поздней версии, максимальная длина одной надстройки составляет 2 621 440 символов.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.setAsync(
  "Date",
  "7/24/2020",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.setAsync succeeded");
  } else {
    console.log("Failed to set sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(name, value, callback)

Устанавливает пару "ключ-значение" данных сеанса.

setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

name

string

Ключ данных сеанса.

value

string

Значение данных сеанса в виде строки.

callback

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

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

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

void

Комментарии

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

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

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

Важно! В клиентах Outlook, поддерживающих почтовый ящик 1.15 или более ранних версий, длина всего объекта SessionData для каждого элемента почты ограничена 50 000 символов на надстройку. В клиентах, поддерживающих почтовые ящики версии 1.16 или более поздней версии, максимальная длина одной надстройки составляет 2 621 440 символов.