Office.Location interface

  • 参考
包:
outlook

提供用于获取和设置 Outlook 外接程序中的会议地点的方法。

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

方法

getAsync(options, callback)

获取约会的位置。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会的位置。 约会的位置在 属性中 asyncResult.value 以字符串的形式提供。
getAsync(callback)

获取约会的位置。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会的位置。 约会的位置在 属性中 asyncResult.value 以字符串的形式提供。
setAsync(location, options, callback)

设置约会的位置。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会的位置。 设置约会的位置将覆盖当前位置。
setAsync(location, callback)

设置约会的位置。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会的位置。 设置约会的位置将覆盖当前位置。

方法详细信息

getAsync(options, callback)

获取约会的位置。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会的位置。 约会的位置在 属性中 asyncResult.value 以字符串的形式提供。

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

参数

options
Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback

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

方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

示例

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

getAsync(callback)

获取约会的位置。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会的位置。 约会的位置在 属性中 asyncResult.value 以字符串的形式提供。

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

参数

callback

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

方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});

setAsync(location, options, callback)

设置约会的位置。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会的位置。 设置约会的位置将覆盖当前位置。

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

参数

location

string

约会的位置。 字符串大小限制为 255 个字符。

options
Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback

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

可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置位置失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

错误：

  • DataExceedsMaximumSize：location 参数长度超过 255 个字符。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

setAsync(location, callback)

设置约会的位置。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会的位置。 设置约会的位置将覆盖当前位置。

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

参数

location

string

约会的位置。 字符串大小限制为 255 个字符。

callback

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

可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置位置失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

错误：

  • DataExceedsMaximumSize：location 参数长度超过 255 个字符。