Office.Subject interface
提供用于获取和设置 Outlook 外接程序中的约会或邮件的主题的方法。
注解
最低权限级别： 读取项
方法
| get |
获取约会或邮件的主题。
|
| get |
获取约会或邮件的主题。
|
| set |
设置约会或邮件的主题。
|
| set |
设置约会或邮件的主题。
|
方法详细信息
getAsync(options, callback)
获取约会或邮件的主题。
getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;参数
- options
- Office.AsyncContextOptions
包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 结果 value 的 属性是项的主题。
返回
void
注解
最低权限级别： 读取项
getAsync(callback)
获取约会或邮件的主题。
getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;参数
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 结果 value 的 属性是项的主题。
返回
void
注解
最低权限级别： 读取项
示例
Office.context.mailbox.item.subject.getAsync(callback);
function callback(asyncResult) {
const subject = asyncResult.value;
}
setAsync(subject, options, callback)
设置约会或邮件的主题。
setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;参数
- subject
-
string
约会或邮件的主题。 字符串长度限制为 255 个字符。
- options
- Office.AsyncContextOptions
包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置主题失败，asyncResult.error 属性将包含一个错误代码。
返回
void
注解
最低权限级别： 读取项
重要提示：在 Android 版 Outlook 和 iOS 版中，邮件撰写模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。
错误：
DataExceedsMaximumSize：subject 参数长度超过 255 个字符。
示例
Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
if (asyncResult.status === "failed") {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(subject, callback)
设置约会或邮件的主题。
setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;参数
- subject
-
string
约会或邮件的主题。 字符串长度限制为 255 个字符。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置主题失败，asyncResult.error 属性将包含一个错误代码。
返回
void
注解
最低权限级别： 读取项
重要提示：在 Android 版 Outlook 和 iOS 版中，邮件撰写模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。
错误：
DataExceedsMaximumSize：subject 参数长度超过 255 个字符。