Office.Subject interface
Proporciona métodos para obtener y establecer el asunto de una cita o un mensaje en un complemento de Outlook.
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Métodos
| get |
Obtiene el asunto de una cita o un mensaje. El método |
| get |
Obtiene el asunto de una cita o un mensaje. El método |
| set |
Establece el asunto de una cita o un mensaje. El método |
| set |
Establece el asunto de una cita o un mensaje. El método |
Detalles del método
getAsync(options, callback)
Obtiene el asunto de una cita o un mensaje.
El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener el asunto de una cita o de un mensaje.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;Parámetros
- options
- Office.AsyncContextOptions
Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La value propiedad del resultado es el asunto del elemento.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
getAsync(callback)
Obtiene el asunto de una cita o un mensaje.
El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener el asunto de una cita o de un mensaje.
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;Parámetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La value propiedad del resultado es el asunto del elemento.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Ejemplos
Office.context.mailbox.item.subject.getAsync(callback);
function callback(asyncResult) {
const subject = asyncResult.value;
}
setAsync(subject, options, callback)
Establece el asunto de una cita o un mensaje.
El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer el asunto de un mensaje o una cita. Cuando se establece este asunto, se sobrescribe el asunto actual, aunque se conservan los prefijos como "Rv:" y "Re:".
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- subject
-
string
El asunto de la cita o del mensaje. La cadena está limitada a 255 caracteres.
- options
- Office.AsyncContextOptions
Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en el establecimiento del asunto, la propiedad asyncResult.error contendrá un código de error.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Importante: En Outlook en Android y en iOS, este método no se admite en el modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Errores:
-
DataExceedsMaximumSize: el parámetro subject tiene más de 255 caracteres.
Ejemplos
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)
Establece el asunto de una cita o un mensaje.
El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer el asunto de un mensaje o una cita. Cuando se establece este asunto, se sobrescribe el asunto actual, aunque se conservan los prefijos como "Rv:" y "Re:".
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- subject
-
string
El asunto de la cita o del mensaje. La cadena está limitada a 255 caracteres.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en el establecimiento del asunto, la propiedad asyncResult.error contendrá un código de error.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Importante: En Outlook en Android y en iOS, este método no se admite en el modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Errores:
-
DataExceedsMaximumSize: el parámetro subject tiene más de 255 caracteres.