item (Requisito da caixa de correio definido como 1.11)
Office.context.mailbox.item
item
é utilizado para aceder à mensagem, pedido de reunião ou compromisso atualmente selecionado. Pode determinar o tipo do item com 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 do Compromisso, Participante do Compromisso, Compose de mensagens ou Mensagem lida |
Importante
Android e iOS: existem limitações sobre quando os suplementos são ativados e quais as APIs que 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]) | ler/escrever item | Organizador de Compromissos |
1.1 (Windows clássico, Mac) 1.8 (Web, novo Windows) |
Composição da mensagem |
1.1 (Windows clássico, Mac) 1.8 (Web, novo Windows) |
||
addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | ler/escrever item | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
addHandlerAsync(eventType, handler, [options], [callback]) | ler item | Organizador de Compromissos | 1.7 |
Participante do Compromisso | 1.7 | ||
Composição da mensagem | 1.7 | ||
Mensagem lida | 1.7 | ||
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | ler/escrever item | Organizador de Compromissos | 1.1 |
Composição da mensagem | 1.1 | ||
close() | restrito | Organizador de Compromissos | 1.3 |
Composição da mensagem | 1.3 | ||
disableClientSignatureAsync([options], [callback]) | ler/escrever item | Organizador de Compromissos | 1.10 |
Composição da mensagem | 1.10 | ||
displayReplyAllForm(formData) | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
displayReplyAllFormAsync(formData, [options], [callback]) | ler item | Participante do Compromisso | 1.9 |
Mensagem lida | 1.9 | ||
displayReplyForm(formData) | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
displayReplyFormAsync(formData, [options], [callback]) | ler item | Participante do Compromisso | 1.9 |
Mensagem lida | 1.9 | ||
getAllInternetHeadersAsync([options], [callback]) | ler item | Mensagem lida | 1.8 |
getAttachmentContentAsync(attachmentId, [options], [callback]) | ler item | Organizador de Compromissos | 1.8 |
Participante do Compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
getAttachmentsAsync([options], [callback]) | ler item | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
getComposeTypeAsync([opções], chamada de retorno) | ler item | Composição da mensagem | 1.10 |
getEntities() (preterido) | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getEntitiesByType(entityType) (preterido) | restrito | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getFilteredEntitiesByName(name) (preterido) | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getInitializationContextAsync([options], [callback]) | ler item | Organizador de Compromissos | 1.8 |
Participante do Compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
getItemIdAsync([opções], chamada de retorno) | ler item | Organizador de Compromissos | 1.8 |
Composição da mensagem | 1.8 | ||
getRegExMatches() | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getRegExMatchesByName(name) | ler item | Participante do Compromisso | 1.1 |
Mensagem lida | 1.1 | ||
getSelectedDataAsync(coercionType, [opções], chamada de retorno) | ler item | Organizador de Compromissos | 1.2 |
Composição da mensagem | 1.2 | ||
getSelectedEntities() (preterido) | ler item | Participante do Compromisso | 1.6 |
Mensagem lida | 1.6 | ||
getSelectedRegExMatches() | ler item | Participante do Compromisso | 1.6 |
Mensagem lida | 1.6 | ||
getSharedPropertiesAsync([opções], chamada de retorno) | ler item | Organizador de Compromissos | 1.8 |
Participante do Compromisso | 1.8 | ||
Composição da mensagem | 1.8 | ||
Mensagem lida | 1.8 | ||
isClientSignatureEnabledAsync([opções], chamada de retorno) | ler item | Organizador de Compromissos | 1.10 |
Composição da mensagem | 1.10 | ||
loadCustomPropertiesAsync(callback, [userContext]) | ler item | Organizador de Compromissos | 1.1 |
Participante do Compromisso | 1.1 | ||
Composição da mensagem | 1.1 | ||
Mensagem lida | 1.1 | ||
removeAttachmentAsync(attachmentId, [options], [callback]) | ler/escrever item | Organizador de Compromissos | 1.1 |
Composição da mensagem | 1.1 | ||
removeHandlerAsync(eventType, handler, [options], [callback]) | ler item | Organizador de Compromissos | 1.7 |
Participante do Compromisso | 1.7 | ||
Composição da mensagem | 1.7 | ||
Mensagem lida | 1.7 | ||
saveAsync([options], callback) | ler/escrever item | Organizador de Compromissos | 1.3 |
Composição da mensagem | 1.3 | ||
setSelectedDataAsync(data, [options], callback) | ler/escrever item | Organizador de Compromissos | 1.2 |
Composição da mensagem | 1.2 |
Eventos
Pode subscrever e anular a subscrição dos seguintes eventos com addHandlerAsync
e removeHandlerAsync
respetivamente.
Importante
Os eventos só estão disponíveis com a implementação do painel de tarefas.
Event | Descrição | Minimum conjunto de requisitos |
---|---|---|
AppointmentTimeChanged |
A data ou hora do compromisso ou série selecionado foi alterada. | 1.7 |
AttachmentsChanged |
Foi adicionado ou removido um anexo do item. | 1.8 |
EnhancedLocationsChanged |
A localização do compromisso selecionado foi alterada. | 1.8 |
InfobarClicked |
Foi selecionada uma ação a partir de uma mensagem de notificação. | 1.10 |
RecipientsChanged |
A lista de destinatários do item selecionado ou da localização do compromisso foi alterada. | 1.7 |
RecurrenceChanged |
O padrão de periodicidade da série selecionada foi alterado. | 1.7 |
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.
});
};