item (conjunto de requisitos de visualização da caixa de correio)
Office.context.mailbox.item
item
é usado para acessar a mensagem, a solicitação de reunião ou o compromisso selecionados no momento. Você pode determinar o tipo do item usando a itemType
propriedade.
Requisitos
Requisito | Valor |
---|---|
Versão do conjunto de requisitos mínimos da caixa de correio | 1.1 |
Nível de permissão mínimo | Restrito |
Modo do Outlook aplicável | Organizador de compromissos, participante de compromisso, Composição de mensagens ou Leitura de Mensagens |
Importante
Android e iOS: há limitações sobre quando os suplementos são ativados e quais APIs estão disponíveis. Para saber mais, consulte Adicionar suporte móvel a um suplemento do Outlook.
Propriedades
Métodos
Método | Minimum nível de permissão |
Detalhes por modo | Minimum conjunto de requisitos |
---|---|---|---|
addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | item de leitura/gravação | Organizador de Compromissos | 1.1 |
Composição da mensagem | 1.1 | ||
addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | item de leitura/gravação | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
addHandlerAsync(eventType, handler, [options], [callback]) | item de leitura | Organizador de Compromissos | 1.7 |
Participante de compromisso | 1.7 | ||
Composição da mensagem | 1.7 | ||
Mensagem lida | 1.7 | ||
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | item de leitura/gravação | Organizador de Compromissos | 1.1 |
Composição da mensagem | 1.1 | ||
close() | Restrito | Organizador de Compromissos | 1.3 |
Composição da mensagem | 1.3 | ||
closeAsync([options], [retorno de chamada]) | item de leitura/gravação | Composição da mensagem | Visualização |
disableClientSignatureAsync([options], [retorno de chamada]) | item de leitura/gravação | Organizador de Compromissos | 1.10 |
Composição da mensagem | 1.10 | ||
displayReplyAllForm(formData) | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
displayReplyAllFormAsync(formData, [options], [callback]) | item de leitura | Participante de compromisso | 1.9 |
Mensagem lida | 1.9 | ||
displayReplyForm(formData) | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
displayReplyFormAsync(formData, [options], [retorno de chamada]) | item de leitura | Participante de compromisso | 1.9 |
Mensagem lida | 1.9 | ||
getAllInternetHeadersAsync([options], [retorno de chamada]) | item de leitura | Mensagem lida | 1.8 |
getAsFileAsync([options], retorno de chamada) | item de leitura | Mensagem lida | Visualização |
getAttachmentContentAsync(attachmentId, [options], [callback]) | item de leitura | Organizador de Compromissos | 1.8 |
Participante de compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
getAttachmentsAsync([options], [retorno de chamada]) | item de leitura | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
getComposeTypeAsync([options], callback) | item de leitura | Composição da mensagem | 1.10 |
getConversationIndexAsync([options], retorno de chamada) | item de leitura | Composição da mensagem | Visualização |
getEntities() | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getEntitiesByType(entityType) | Restrito | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getFilteredEntitiesByName(name) | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getInitializationContextAsync([options], [retorno de chamada]) | item de leitura | Organizador de Compromissos | 1.8 |
Participante de compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
getItemClassAsync([options], retorno de chamada) | item de leitura | Composição da mensagem | Visualização |
getItemIdAsync([options], retorno de chamada) | item de leitura | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
getRegExMatches() | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getRegExMatchesByName(name) | item de leitura | Participante de compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getSelectedDataAsync(coercionType, [options], callback) | item de leitura | Organizador de Compromissos | 1.2 |
Composição da mensagem | 1.2 | ||
getSelectedEntities() | item de leitura | Participante de compromisso | 1.6 |
Mensagem lida | 1.6 | ||
getSelectedRegExMatches() | item de leitura | Participante de compromisso | 1.6 |
Mensagem lida | 1.6 | ||
getSharedPropertiesAsync([options], retorno de chamada) | item de leitura | Organizador de Compromissos | 1.8 |
Participante de compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
isClientSignatureEnabledAsync([options], callback) | item de leitura | Organizador de Compromissos | 1.10 |
Composição da mensagem | 1.10 | ||
loadCustomPropertiesAsync(callback, [userContext]) | item de leitura | Organizador de Compromissos | 1.1 |
Participante de compromisso | 1.1 | ||
Composição da mensagem | 1.1 | ||
Mensagem lida | 1.1 | ||
removeAttachmentAsync(attachmentId, [options], [callback]) | item de leitura/gravação | Organizador de Compromissos | 1.1 |
Composição da mensagem | 1.1 | ||
removeHandlerAsync(eventType, handler, [options], [callback]) | item de leitura | Organizador de Compromissos | 1.7 |
Participante de compromisso | 1.7 | ||
Composição da mensagem | 1.7 | ||
Mensagem lida | 1.7 | ||
saveAsync([options], callback) | item de leitura/gravação | Organizador de Compromissos | 1.3 |
Composição da mensagem | 1.3 | ||
setSelectedDataAsync(data, [options], callback) | item de leitura/gravação | Organizador de Compromissos | 1.2 |
Composição da mensagem | 1.2 |
Eventos
Você pode assinar e cancelar a assinatura dos seguintes eventos usando addHandlerAsync
e removeHandlerAsync
, respectivamente, .
Event | Descrição | Minimum conjunto de requisitos |
---|---|---|
AppointmentTimeChanged |
A data ou hora do compromisso ou série selecionado foi alterada. Disponível apenas com a implementação do painel de tarefas. | 1.7 |
AttachmentsChanged |
Um anexo foi adicionado ou removido do item. Disponível apenas com a implementação do painel de tarefas. | 1.8 |
EnhancedLocationsChanged |
O local do compromisso selecionado foi alterado. Disponível apenas com a implementação do painel de tarefas. | 1.8 |
InfobarClicked |
Uma ação foi selecionada em uma mensagem de notificação. Disponível apenas com a implementação do painel de tarefas. | 1.10 |
RecipientsChanged |
A lista de destinatários do item ou local de compromisso selecionado foi alterada. Disponível apenas com a implementação do painel de tarefas. | 1.7 |
RecurrenceChanged |
O padrão de recorrência da série selecionada foi alterado. Disponível apenas com a implementação do painel de tarefas. | 1.7 |
SensitivityLabelChanged |
O rótulo de confidencialidade de uma mensagem ou compromisso no modo de composição foi alterado. Disponível apenas com a implementação do painel de tarefas. | 1.13 |
SpamReporting |
Uma mensagem não solicitada é relatada no Outlook. Disponível apenas com um comando de função. | Visualização |
Exemplo
O exemplo de código JavaScript a seguir mostra como acessar a propriedade subject
do item atual no Outlook.
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de