Office.SessionData interface

Ссылка

Пакет:: outlook

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

Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

Методы

clearAsync(options, callback)	Очищает все пары "ключ-значение" данных сеанса.
clearAsync(callback)	Очищает все пары "ключ-значение" данных сеанса.
getAllAsync(callback)	Возвращает все пары "ключ-значение" данных сеанса.
getAsync(name, callback)	Возвращает значение данных сеанса указанного ключа.
removeAsync(name, options, callback)	Удаляет пару "ключ-значение" данных сеанса.
removeAsync(name, callback)	Удаляет пару "ключ-значение" данных сеанса.
setAsync(name, value, options, callback)	Задает пару "ключ-значение" данных сеанса. Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.
setAsync(name, value, callback)	Задает пару "ключ-значение" данных сеанса. Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

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

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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

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

void

Примеры

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

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

void

getAllAsync(callback)

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

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

Параметры

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

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

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

void

Примеры

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

Примеры

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

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

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

void

Примеры

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

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

void

setAsync(name, value, options, callback)

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

Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

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

Параметры

name: string

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

value: string

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

options: Office.AsyncContextOptions

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

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

Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

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

Параметры

name: string

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

value: string

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

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

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

void

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

Office.SessionData interface

Комментарии

Методы

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

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)

Параметры

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

Комментарии

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