Office.SensitivityLabel interface
Proporciona métodos para obtener o establecer la etiqueta de confidencialidad de un mensaje o una cita. Para obtener más información sobre las etiquetas de confidencialidad, consulte Información sobre las etiquetas de confidencialidad.
Comentarios
[ Conjunto de API: Buzón 1.13 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.
Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.
Métodos
get |
Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se va a componer. |
get |
Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se va a componer. |
set |
Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se va a componer. |
set |
Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se va a componer. |
Detalles del método
getAsync(options, callback)
Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se va a componer.
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, asyncResult
, que es un Office.AsyncResult
objeto . El GUID de la etiqueta de confidencialidad se devuelve en la asyncResult.value
propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.13 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.
Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.
getAsync(callback)
Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se va a componer.
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, asyncResult
, que es un Office.AsyncResult
objeto . El GUID de la etiqueta de confidencialidad se devuelve en la asyncResult.value
propiedad .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.13 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.
Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml
// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(asyncResult.value);
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(sensitivityLabel, options, callback)
Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se va a componer.
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parámetros
- sensitivityLabel
-
string | Office.SensitivityLabelDetails
Etiqueta de confidencialidad que se va a aplicar al mensaje o cita que se va a componer. El valor del parámetro puede ser el identificador único (GUID) de una etiqueta de confidencialidad o un objeto SensitivityLabelDetails .
- 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, asyncResult
, que es un Office.AsyncResult
objeto .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.13 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.
Sugerencia: Para determinar las etiquetas de confidencialidad disponibles para su uso, llame al Office.context.sensitivityLabelsCatalog.getAsync
método .
Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.
setAsync(sensitivityLabel, callback)
Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se va a componer.
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parámetros
- sensitivityLabel
-
string | Office.SensitivityLabelDetails
Etiqueta de confidencialidad que se va a aplicar al mensaje o cita que se va a componer. El valor del parámetro puede ser el identificador único (GUID) de una etiqueta de confidencialidad o un objeto SensitivityLabelDetails .
- 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, asyncResult
, que es un Office.AsyncResult
objeto .
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.13 ]
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.
Sugerencia: Para determinar las etiquetas de confidencialidad disponibles para su uso, llame al Office.context.sensitivityLabelsCatalog.getAsync
método .
Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml
// This snippet sets the sensitivity label on the current mail item.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
Office.context.sensitivityLabelsCatalog.getAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const catalog = asyncResult.value;
if (catalog.length > 0) {
var id = catalog[0].id;
Office.context.mailbox.item.sensitivityLabel.setAsync(id, (asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(asyncResult.status);
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
}
else {
console.log("Catalog list is empty");
}
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});