Office.AppointmentCompose interface

Pacote:

outlook

O modo de organizador de compromissos de Office.context.mailbox.item.

Importante: este é um objeto interno do Outlook, não exposto diretamente através de interfaces existentes. Deve tratar isto como um modo de Office.context.mailbox.item. Para obter mais informações, veja a página Modelo de Objeto .

Interfaces principais:

• ItemCompose

• Compromisso

Extends

Office.Appointment

Propriedades

body	Obtém um objeto que fornece métodos para manipular o corpo de um item.
categories	Obtém um objeto que fornece métodos para gerir as categorias do item.
end	Obtém ou define a data e a hora em que o compromisso deve terminar. A end propriedade é um objeto Hora expresso como um valor de data e hora Universal Coordenada (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor da end propriedade para a data e hora locais do cliente. Ao usar o método Time.setAsync para definir a hora de término, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor. Importante: no cliente Windows, não pode utilizar esta propriedade para atualizar o fim de uma periodicidade.
enhancedLocation	Obtém ou define as localizações do compromisso. A enhancedLocation propriedade devolve um objeto EnhancedLocation que fornece métodos para obter, remover ou adicionar localizações num item.
itemType	Obtém o tipo de item que representa uma instância. A propriedade itemType retorna um dos valores de enumeração ItemType, indicando se a instância do objeto item é uma mensagem ou um compromisso.
location	Obtém ou define o local de um compromisso. A location propriedade devolve um objeto Localização que fornece métodos que são utilizados para obter e definir a localização do compromisso.
notificationMessages	Obtém as mensagens de notificação de um item.
optionalAttendees	Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. A propriedade optionalAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes opcionais de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.
organizer	Obtém o organizador da reunião especificada. A organizer propriedade devolve um objeto Organizador que fornece um método para obter o valor do organizador.
recurrence	Obtém ou define o padrão de periodicidade de um compromisso. A recurrence propriedade devolve um objeto de periodicidade para compromissos periódicos ou pedidos de reuniões se um item for uma série ou uma instância numa série. null é devolvido para compromissos únicos e pedidos de reunião de compromissos únicos. Nota: os pedidos de reunião têm um itemClass valor de IPM.Schedule.Meeting.Request. Nota: se o objeto de periodicidade for nulo, significa que o objeto é um compromisso único ou um pedido de reunião de um único compromisso e NÃO uma parte de uma série.
requiredAttendees	Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. A propriedade requiredAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes obrigatórios de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.
seriesId	Obtém o ID da série à qual pertence uma instância. No Outlook na Web, no Windows (novo e clássico) e no Mac, a seriesId propriedade devolve o ID dos Serviços Web exchange (EWS) do item principal (série) ao qual este item pertence. No entanto, no Outlook para Android e no iOS, seriesId devolve o ID REST do item principal. Nota: o seriesId identificador devolvido pela propriedade é o mesmo que o identificador de item dos Serviços Web exchange. A seriesId propriedade não é idêntica aos IDs do Outlook utilizados pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId. Para obter mais detalhes, consulte Utilizar as APIs REST do Outlook a partir de um suplemento do Outlook. A seriesId propriedade devolve null itens que não têm itens principais, como compromissos individuais, itens de série ou pedidos de reunião e devoluções undefined para quaisquer outros itens que não sejam pedidos de reunião.
sessionData	Gere o SessionData de um item no modo Compose. Importante: todo o objeto SessionData está limitado a 50 000 carateres por suplemento.
start	Obtém ou define a data e a hora em que o compromisso deve começar. A start propriedade é um objeto Hora expresso como um valor de data e hora Universal Coordenada (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor para a data e hora locais do cliente. Ao usar o método Time.setAsync para definir a hora de início, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor. Importante: no cliente Windows, não pode utilizar esta propriedade para atualizar o início de uma periodicidade.
subject	Obtém ou define a descrição que aparece no campo de assunto de um item. A propriedade subject obtém ou define o assunto completo do item, conforme enviado pelo servidor de email. A propriedade subject retorna um objeto Subject que fornece métodos para obter e definir o assunto.

Métodos

addFileAttachmentAsync(uri, attachmentName, options, callback)	Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.
addFileAttachmentAsync(uri, attachmentName, callback)	Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.
addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)	Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. O addFileAttachmentFromBase64Async método carrega o ficheiro a partir da codificação Base64 e anexa-o ao item no formulário de composição. Este método devolve o identificador de anexo no asyncResult.value objeto . Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão. Nota: se estiver a utilizar uma API de URL de dados (por exemplo, readAsDataURL), terá de retirar o prefixo do URL de dados e, em seguida, enviar o resto da cadeia para esta API. Por exemplo, se a cadeia completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.
addFileAttachmentFromBase64Async(base64File, attachmentName, callback)	Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. O addFileAttachmentFromBase64Async método carrega o ficheiro a partir da codificação Base64 e anexa-o ao item no formulário de composição. Este método devolve o identificador de anexo no asyncResult.value objeto . Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão. Nota: se estiver a utilizar uma API de URL de dados (por exemplo, readAsDataURL), terá de retirar o prefixo do URL de dados e, em seguida, enviar o resto da cadeia para esta API. Por exemplo, se a cadeia completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.
addHandlerAsync(eventType, handler, options, callback)	Adiciona um manipulador de eventos a um evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos suportados, veja a secção Eventos do modelo de objeto de item.
addHandlerAsync(eventType, handler, callback)	Adiciona um manipulador de eventos a um evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos suportados, veja a secção Eventos do modelo de objeto de item.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso. O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se especificar uma função de chamada de retorno, o método é chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro que tenha ocorrido ao anexar o item. Pode utilizar o options parâmetro para transmitir informações de estado para a função de chamada de retorno, se necessário. Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão. Se o seu Suplemento do Office estiver a ser executado no Outlook na Web e no novo Outlook no Windows, o addItemAttachmentAsync método pode anexar itens a itens diferentes do item que está a editar. No entanto, isto não é suportado e não é recomendado.
addItemAttachmentAsync(itemId, attachmentName, callback)	Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso. O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se especificar uma função de chamada de retorno, o método é chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro que tenha ocorrido ao anexar o item. Pode utilizar o options parâmetro para transmitir informações de estado para a função de chamada de retorno, se necessário. Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão. Se o seu Suplemento do Office estiver a ser executado no Outlook na Web e no novo Outlook no Windows, o addItemAttachmentAsync método pode anexar itens a itens diferentes do item que está a editar. No entanto, isto não é suportado e não é recomendado.
close()	Fecha o item atual que está sendo composto. O comportamento do método close depende do estado atual do item que está sendo redigido. Se o item tiver alterações não guardadas, o cliente pede ao utilizador para guardar, eliminar ou fechar a ação. No Outlook no Windows (clássico) e no Mac, o close método não tem qualquer efeito numa resposta no Painel de Leitura.
disableClientSignatureAsync(options, callback)	Desativa a assinatura de cliente do Outlook. No Outlook no Windows (clássico) e no Mac, esta API define a assinatura nas secções "Nova Mensagem" e "Respostas/Reencaminhamentos" para a conta de envio para "(nenhum)", desativando efetivamente a assinatura. No Outlook na Web e no novo Outlook no Windows, a API desativa a opção de assinatura para novos e-mails, respostas e reencaminhamentos. Se a assinatura estiver selecionada, esta chamada à API desativa-a.
disableClientSignatureAsync(callback)	Desativa a assinatura de cliente do Outlook. No Outlook no Windows (clássico) e no Mac, esta API define a assinatura nas secções "Nova Mensagem" e "Respostas/Reencaminhamentos" para a conta de envio para "(nenhum)", desativando efetivamente a assinatura. No Outlook na Web e no novo Outlook no Windows, a API desativa a opção de assinatura para novos e-mails, respostas e reencaminhamentos. Se a assinatura estiver selecionada, esta chamada à API desativa-a.
getAttachmentContentAsync(attachmentId, options, callback)	Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent objeto. O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
getAttachmentContentAsync(attachmentId, callback)	Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent objeto. O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
getAttachmentsAsync(options, callback)	Obtém os anexos do item como uma matriz.
getAttachmentsAsync(callback)	Obtém os anexos do item como uma matriz.
getInitializationContextAsync(options, callback)	Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(callback)	Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.
getItemIdAsync(options, callback)	De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado. Quando invocado, este método devolve o ID do item através da função de chamada de retorno.
getItemIdAsync(callback)	De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado. Quando invocado, este método devolve o ID do item através da função de chamada de retorno.
getSelectedDataAsync(coercionType, options, callback)	Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem. Se não houver seleção, mas o cursor estiver no corpo ou assunto, o método devolve uma cadeia vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection. Para aceder aos dados selecionados a partir da função de chamada de retorno, chame asyncResult.value.data. Para aceder à source propriedade de origem da seleção, chame asyncResult.value.sourceProperty, que será body ou subject.
getSelectedDataAsync(coercionType, callback)	Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem. Se não houver seleção, mas o cursor estiver no corpo ou assunto, o método devolve uma cadeia vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection. Para aceder aos dados selecionados a partir da função de chamada de retorno, chame asyncResult.value.data. Para aceder à source propriedade de origem da seleção, chame asyncResult.value.sourceProperty, que será body ou subject.
getSharedPropertiesAsync(options, callback)	Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada. Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.
getSharedPropertiesAsync(callback)	Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada. Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.
isClientSignatureEnabledAsync(options, callback)	Obtém se a assinatura do cliente estiver ativada. No Outlook no Windows (clássico) e no Mac, devolve true se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, devolve true se a assinatura está ativada para os tiposnewMail de composição , replyou forward. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou no Mac ou desativadas no Outlook na Web ou no novo Outlook no Windows, devolve false.
isClientSignatureEnabledAsync(callback)	Obtém se a assinatura do cliente estiver ativada. No Outlook no Windows (clássico) e no Mac, devolve true se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, devolve true se a assinatura está ativada para os tiposnewMail de composição , replyou forward. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou no Mac ou desativadas no Outlook na Web ou no novo Outlook no Windows, devolve false.
loadCustomPropertiesAsync(callback, userContext)	Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado. As propriedades personalizadas são armazenadas como pares chave-valor numa base por aplicação, por item. Este método devolve um objeto CustomProperties na chamada de retorno, que fornece métodos para aceder às propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são encriptadas no item, pelo que não deve ser utilizado como armazenamento seguro. As propriedades personalizadas são fornecidas como um objeto CustomProperties na propriedade asyncResult.value. Este objeto pode ser utilizado para obter, definir, guardar e remover propriedades personalizadas do item de correio.
removeAttachmentAsync(attachmentId, options, callback)	Remove um anexo de uma mensagem ou de um compromisso. O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
removeAttachmentAsync(attachmentId, callback)	Remove um anexo de uma mensagem ou de um compromisso. O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
removeHandlerAsync(eventType, options, callback)	Remove um manipulador de eventos para um tipo de evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos suportados, veja a secção Eventos do modelo de objeto de item.
removeHandlerAsync(eventType, callback)	Remove um manipulador de eventos para um tipo de evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas. Para eventos suportados, veja a secção Eventos do modelo de objeto de item.
saveAsync(options, callback)	Salva um item de forma assíncrona. Uma vez que os compromissos não têm nenhum estado de rascunho, se saveAsync for chamado para um compromisso no modo de composição, o item é guardado como um compromisso normal no calendário do utilizador. Para novos compromissos que ainda não tenham sido guardados, não é enviado nenhum convite. Para compromissos existentes, é enviada uma atualização aos participantes adicionados ou removidos.
saveAsync(callback)	Salva um item de forma assíncrona. Uma vez que os compromissos não têm nenhum estado de rascunho, se saveAsync for chamado para um compromisso no modo de composição, o item é guardado como um compromisso normal no calendário do utilizador. Para novos compromissos que ainda não tenham sido guardados, não é enviado nenhum convite. Para compromissos existentes, é enviada uma atualização aos participantes adicionados ou removidos.
setSelectedDataAsync(data, options, callback)	Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem. O setSelectedDataAsync método insere a cadeia especificada na localização do cursor no assunto ou corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no corpo ou no campo do assunto, é devolvido um erro. Após a inserção, o cursor é colocado no final do conteúdo inserido.
setSelectedDataAsync(data, callback)	Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem. O setSelectedDataAsync método insere a cadeia especificada na localização do cursor no assunto ou corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no corpo ou no campo do assunto, é devolvido um erro. Após a inserção, o cursor é colocado no final do conteúdo inserido.

Detalhes da propriedade

body

Obtém um objeto que fornece métodos para manipular o corpo de um item.

body: Body;

Valor da propriedade

Office.Body

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of an object that is passed as the result parameter to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

categories

Obtém um objeto que fornece métodos para gerir as categorias do item.

categories: Categories;

Valor da propriedade

Office.Categories

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

end

Obtém ou define a data e a hora em que o compromisso deve terminar.

A end propriedade é um objeto Hora expresso como um valor de data e hora Universal Coordenada (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor da end propriedade para a data e hora locais do cliente.

Ao usar o método Time.setAsync para definir a hora de término, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.

Importante: no cliente Windows, não pode utilizar esta propriedade para atualizar o fim de uma periodicidade.

end: Time;

Valor da propriedade

Office.Time

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("End Time " + result.asyncContext.verb);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml

Office.context.mailbox.item.end.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment ends: ${result.value}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

enhancedLocation

Obtém ou define as localizações do compromisso. A enhancedLocation propriedade devolve um objeto EnhancedLocation que fornece métodos para obter, remover ou adicionar localizações num item.

enhancedLocation: EnhancedLocation;

Valor da propriedade

Office.EnhancedLocation

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully added locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to add locations. Error message: ${result.error.message}`);
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to remove locations. Error message: ${result.error.message}`);
  }
});

itemType

Obtém o tipo de item que representa uma instância.

A propriedade itemType retorna um dos valores de enumeração ItemType, indicando se a instância do objeto item é uma mensagem ou um compromisso.

itemType: MailboxEnums.ItemType | string;

Valor da propriedade

Office.MailboxEnums.ItemType | string

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

Obtém ou define o local de um compromisso. A location propriedade devolve um objeto Localização que fornece métodos que são utilizados para obter e definir a localização do compromisso.

location: Location;

Valor da propriedade

Office.Location

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});

...

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

notificationMessages

Obtém as mensagens de notificação de um item.

notificationMessages: NotificationMessages;

Valor da propriedade

Office.NotificationMessages

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

optionalAttendees

Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A propriedade optionalAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes opcionais de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.

optionalAttendees: Recipients;

Valor da propriedade

Office.Recipients

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailOptional")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

organizer

Obtém o organizador da reunião especificada.

A organizer propriedade devolve um objeto Organizador que fornece um método para obter o valor do organizador.

organizer: Organizer;

Valor da propriedade

Office.Organizer

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-organizer.yaml

Office.context.mailbox.item.organizer.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOrganizer = asyncResult.value;
    console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

recurrence

Obtém ou define o padrão de periodicidade de um compromisso.

A recurrence propriedade devolve um objeto de periodicidade para compromissos periódicos ou pedidos de reuniões se um item for uma série ou uma instância numa série. null é devolvido para compromissos únicos e pedidos de reunião de compromissos únicos.

Nota: os pedidos de reunião têm um itemClass valor de IPM.Schedule.Meeting.Request.

Nota: se o objeto de periodicidade for nulo, significa que o objeto é um compromisso único ou um pedido de reunião de um único compromisso e NÃO uma parte de uma série.

recurrence: Recurrence;

Valor da propriedade

Office.Recurrence

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

requiredAttendees

Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.

A propriedade requiredAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes obrigatórios de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.

requiredAttendees: Recipients;

Valor da propriedade

Office.Recipients

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfRequiredAttendeesRecipients = asyncResult.value;
    console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailRequired")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

seriesId

Obtém o ID da série à qual pertence uma instância.

No Outlook na Web, no Windows (novo e clássico) e no Mac, a seriesId propriedade devolve o ID dos Serviços Web exchange (EWS) do item principal (série) ao qual este item pertence. No entanto, no Outlook para Android e no iOS, seriesId devolve o ID REST do item principal.

Nota: o seriesId identificador devolvido pela propriedade é o mesmo que o identificador de item dos Serviços Web exchange. A seriesId propriedade não é idêntica aos IDs do Outlook utilizados pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId. Para obter mais detalhes, consulte Utilizar as APIs REST do Outlook a partir de um suplemento do Outlook.

A seriesId propriedade devolve null itens que não têm itens principais, como compromissos individuais, itens de série ou pedidos de reunião e devoluções undefined para quaisquer outros itens que não sejam pedidos de reunião.

seriesId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

sessionData

Gere o SessionData de um item no modo Compose.

Importante: todo o objeto SessionData está limitado a 50 000 carateres por suplemento.

sessionData: SessionData;

Valor da propriedade

Office.SessionData

Comentários

[ Conjunto de API: Caixa de Correio 1.11 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

start

Obtém ou define a data e a hora em que o compromisso deve começar.

A start propriedade é um objeto Hora expresso como um valor de data e hora Universal Coordenada (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor para a data e hora locais do cliente.

Ao usar o método Time.setAsync para definir a hora de início, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.

Importante: no cliente Windows, não pode utilizar esta propriedade para atualizar o início de uma periodicidade.

start: Time;

Valor da propriedade

Office.Time

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

...

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

subject

Obtém ou define a descrição que aparece no campo de assunto de um item.

A propriedade subject obtém ou define o assunto completo do item, conforme enviado pelo servidor de email.

A propriedade subject retorna um objeto Subject que fornece métodos para obter e definir o assunto.

subject: Subject;

Valor da propriedade

Office.Subject

Comentários

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

Detalhes do método

addFileAttachmentAsync(uri, attachmentName, options, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

uri

string

O URI que fornece o local do arquivo anexado à mensagem ou compromisso. O comprimento máximo é de 2048 caracteres.

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options

Office.AsyncContextOptions & { isInline: boolean }

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno. isInline : se for verdadeiro, indica que o anexo será apresentado inline como uma imagem no corpo da mensagem e não será apresentado na lista de anexos.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao carregar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 para Outlook no Windows (clássico) e no Mac, Caixa de Correio 1.8 para Outlook na Web e novo Outlook no Windows ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• Este método não é suportado no Outlook para iOS ou Android. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Nas compilações recentes do Outlook clássico no Windows, foi introduzido um erro que acrescenta incorretamente um Authorization: Bearer cabeçalho a esta ação (quer esteja a utilizar esta API ou a IU do Outlook). Para contornar este problema, utilize a API introduzida com o addFileAttachmentFromBase64 conjunto de requisitos 1.8.

• O URI do ficheiro a anexar tem de suportar a colocação em cache na produção. O servidor que aloja a imagem não deve devolver um Cache-Control cabeçalho que especifique no-cache, no-storeou opções semelhantes na resposta HTTP. No entanto, quando estiver a desenvolver o suplemento e a fazer alterações aos ficheiros, a colocação em cache pode impedi-lo de ver as suas alterações. Recomendamos a utilização de Cache-Control cabeçalhos durante o desenvolvimento.

• Pode utilizar o mesmo URI com o removeAttachmentAsync método para remover o anexo na mesma sessão.

Erros:

• AttachmentSizeExceeded : o anexo é maior do que o permitido.

• FileTypeNotSupported : o anexo tem uma extensão que não é permitida.

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O método addFileAttachmentAsync carrega o arquivo no URI especificado e anexa-o ao item no formulário de composição.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

uri

string

O URI que fornece o local do arquivo anexado à mensagem ou compromisso. O comprimento máximo é de 2048 caracteres.

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao carregar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 para Outlook no Windows (clássico) e no Mac, Caixa de Correio 1.8 para Outlook na Web e novo Outlook no Windows ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• Este método não é suportado no Outlook para iOS ou Android. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Nas compilações recentes do Outlook clássico no Windows, foi introduzido um erro que acrescenta incorretamente um Authorization: Bearer cabeçalho a esta ação (quer esteja a utilizar esta API ou a IU do Outlook). Para contornar este problema, utilize a API introduzida com o addFileAttachmentFromBase64 conjunto de requisitos 1.8.

• O URI do ficheiro a anexar tem de suportar a colocação em cache na produção. O servidor que aloja a imagem não deve devolver um Cache-Control cabeçalho que especifique no-cache, no-storeou opções semelhantes na resposta HTTP. No entanto, quando estiver a desenvolver o suplemento e a fazer alterações aos ficheiros, a colocação em cache pode impedi-lo de ver as suas alterações. Recomendamos a utilização de Cache-Control cabeçalhos durante o desenvolvimento.

• Pode utilizar o mesmo URI com o removeAttachmentAsync método para remover o anexo na mesma sessão.

Erros:

• AttachmentSizeExceeded : o anexo é maior do que o permitido.

• FileTypeNotSupported : o anexo tem uma extensão que não é permitida.

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O addFileAttachmentFromBase64Async método carrega o ficheiro a partir da codificação Base64 e anexa-o ao item no formulário de composição. Este método devolve o identificador de anexo no asyncResult.value objeto .

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Nota: se estiver a utilizar uma API de URL de dados (por exemplo, readAsDataURL), terá de retirar o prefixo do URL de dados e, em seguida, enviar o resto da cadeia para esta API. Por exemplo, se a cadeia completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions &  { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

base64File

string

O conteúdo codificado com Base64 de uma imagem ou ficheiro a adicionar a um e-mail ou evento. O comprimento máximo da cadeia codificada é de 27 892 122 carateres (cerca de 25 MB).

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options

Office.AsyncContextOptions & { isInline: boolean }

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno. isInline : se for verdadeiro, indica que o anexo será apresentado inline como uma imagem no corpo da mensagem e não será apresentado na lista de anexos.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao carregar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• AttachmentSizeExceeded : o anexo é maior do que o permitido.

• FileTypeNotSupported : o anexo tem uma extensão que não é permitida.

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

Nota: se estiver a adicionar uma imagem base64 inline ao corpo de uma mensagem ou compromisso que está a ser composto, primeiro tem de obter o corpo do item atual com o método Office.context.mailbox.item.body.getAsync antes de inserir a imagem com addFileAttachmentFromBase64Async. Caso contrário, a imagem não será composta no corpo depois de ser inserida. Para obter mais orientações, consulte Anexar um ficheiro.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.

O addFileAttachmentFromBase64Async método carrega o ficheiro a partir da codificação Base64 e anexa-o ao item no formulário de composição. Este método devolve o identificador de anexo no asyncResult.value objeto .

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Nota: se estiver a utilizar uma API de URL de dados (por exemplo, readAsDataURL), terá de retirar o prefixo do URL de dados e, em seguida, enviar o resto da cadeia para esta API. Por exemplo, se a cadeia completa for representada por data:image/svg+xml;base64,<rest of Base64 string>, remova data:image/svg+xml;base64,.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

base64File

string

O conteúdo codificado com Base64 de uma imagem ou ficheiro a adicionar a um e-mail ou evento. O comprimento máximo da cadeia codificada é de 27 892 122 carateres (cerca de 25 MB).

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao carregar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• AttachmentSizeExceeded : o anexo é maior do que o permitido.

• FileTypeNotSupported : o anexo tem uma extensão que não é permitida.

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

Nota: se estiver a adicionar uma imagem base64 inline ao corpo de uma mensagem ou compromisso que está a ser composto, primeiro tem de obter o corpo do item atual com o método Office.context.mailbox.item.body.getAsync antes de inserir a imagem com addFileAttachmentFromBase64Async. Caso contrário, a imagem não será composta no corpo depois de ser inserida. Para obter mais orientações, consulte Anexar um ficheiro.

addHandlerAsync(eventType, handler, options, callback)

Adiciona um manipulador de eventos a um evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos suportados, veja a secção Eventos do modelo de objeto de item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve invocar o manipulador.

handler

any

A função para manipular o evento. A função deve aceitar um parâmetro exclusivo, que é um objeto literal. A type propriedade no parâmetro corresponderá ao eventType parâmetro transmitido a addHandlerAsync.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Adiciona um manipulador de eventos a um evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos suportados, veja a secção Eventos do modelo de objeto de item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve invocar o manipulador.

handler

any

A função para manipular o evento. A função deve aceitar um parâmetro exclusivo, que é um objeto literal. A type propriedade no parâmetro corresponderá ao eventType parâmetro transmitido a addHandlerAsync.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.

O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se especificar uma função de chamada de retorno, o método é chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro que tenha ocorrido ao anexar o item. Pode utilizar o options parâmetro para transmitir informações de estado para a função de chamada de retorno, se necessário.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Se o seu Suplemento do Office estiver a ser executado no Outlook na Web e no novo Outlook no Windows, o addItemAttachmentAsync método pode anexar itens a itens diferentes do item que está a editar. No entanto, isto não é suportado e não é recomendado.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

itemId

any

O identificador do Exchange do item a anexar. O comprimento máximo é de 100 caracteres.

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao adicionar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

Exemplos

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.

O método addItemAttachmentAsync anexa o item com o identificador do Exchange especificado ao item no formulário de composição. Se especificar uma função de chamada de retorno, o método é chamado com um parâmetro, asyncResult, que contém o identificador do anexo ou um código que indica qualquer erro que tenha ocorrido ao anexar o item. Pode utilizar o options parâmetro para transmitir informações de estado para a função de chamada de retorno, se necessário.

Posteriormente, você poderá usar o identificador com o método removeAttachmentAsync para remover o anexo na mesma sessão.

Se o seu Suplemento do Office estiver a ser executado no Outlook na Web e no novo Outlook no Windows, o addItemAttachmentAsync método pode anexar itens a itens diferentes do item que está a editar. No entanto, isto não é suportado e não é recomendado.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

itemId

any

O identificador do Exchange do item a anexar. O comprimento máximo é de 100 caracteres.

attachmentName

string

O nome do anexo que é mostrado enquanto o anexo está sendo carregado. O tamanho máximo é de 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => void

Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro do tipo Office.AsyncResult. Em caso de êxito, o identificador do anexo será fornecido na propriedade asyncResult.value. Se houver falha ao adicionar o anexo, o objeto asyncResult conterá um objeto Error que fornece uma descrição do erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• NumberOfAttachmentsExceeded : a mensagem ou compromisso tem demasiados anexos.

close()

Fecha o item atual que está sendo composto.

O comportamento do método close depende do estado atual do item que está sendo redigido. Se o item tiver alterações não guardadas, o cliente pede ao utilizador para guardar, eliminar ou fechar a ação.

No Outlook no Windows (clássico) e no Mac, o close método não tem qualquer efeito numa resposta no Painel de Leitura.

close(): void;

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Organizador de Compromissos

Importante: no Outlook na Web e no novo Outlook no Windows, se o item for um compromisso e tiver sido guardado anteriormente com saveAsynco , é pedido ao utilizador que guarde, elimine ou cancele mesmo que não tenham ocorrido alterações desde a última vez que o item foi guardado.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

disableClientSignatureAsync(options, callback)

Desativa a assinatura de cliente do Outlook.

No Outlook no Windows (clássico) e no Mac, esta API define a assinatura nas secções "Nova Mensagem" e "Respostas/Reencaminhamentos" para a conta de envio para "(nenhum)", desativando efetivamente a assinatura. No Outlook na Web e no novo Outlook no Windows, a API desativa a opção de assinatura para novos e-mails, respostas e reencaminhamentos. Se a assinatura estiver selecionada, esta chamada à API desativa-a.

disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Desativa a assinatura de cliente do Outlook.

No Outlook no Windows (clássico) e no Mac, esta API define a assinatura nas secções "Nova Mensagem" e "Respostas/Reencaminhamentos" para a conta de envio para "(nenhum)", desativando efetivamente a assinatura. No Outlook na Web e no novo Outlook no Windows, a API desativa a opção de assinatura para novos e-mails, respostas e reencaminhamentos. Se a assinatura estiver selecionada, esta chamada à API desativa-a.

disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

getAttachmentContentAsync(attachmentId, options, callback)

Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent objeto.

O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo que pretende obter.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• AttachmentTypeNotSupported : o tipo de anexo não é suportado. Os tipos não suportados incluem imagens incorporadas no Formato RTF ou tipos de anexos de itens diferentes dos itens de e-mail ou calendário (como um contacto ou item de tarefa).

• InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

getAttachmentContentAsync(attachmentId, callback)

Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent objeto.

O getAttachmentContentAsync método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo que pretende obter.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• AttachmentTypeNotSupported : o tipo de anexo não é suportado. Os tipos não suportados incluem imagens incorporadas no Formato RTF ou tipos de anexos de itens diferentes dos itens de e-mail ou calendário (como um contacto ou item de tarefa).

• InvalidAttachmentId : o identificador de anexo não existe.

getAttachmentsAsync(options, callback)

Obtém os anexos do item como uma matriz.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

getAttachmentsAsync(callback)

Obtém os anexos do item como uma matriz.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a chamada falhar, a asyncResult.error propriedade conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

getInitializationContextAsync(options, callback)

Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Com êxito, os dados de contexto de inicialização são fornecidos como uma cadeia (ou uma cadeia vazia se não houver contexto de inicialização) na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Com êxito, os dados de contexto de inicialização são fornecidos como uma cadeia (ou uma cadeia vazia se não houver contexto de inicialização) na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

getItemIdAsync(options, callback)

De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado.

Quando invocado, este método devolve o ID do item através da função de chamada de retorno.

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. O ID do item EWS do item é devolvido na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId.

• Se o seu suplemento chamar getItemIdAsync (por exemplo, para obter um ID de item para utilizar com o EWS ou a API REST), tenha em atenção que, quando o Outlook está em modo de cache, poderá demorar algum tempo até que o item seja sincronizado com o servidor. Até o item ser sincronizado, o ID do item não é reconhecido e a sua utilização devolve um erro.

Erros:

• ItemNotSaved : o ID não pode ser obtido até que o item seja guardado.

getItemIdAsync(callback)

De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado.

Quando invocado, este método devolve o ID do item através da função de chamada de retorno.

getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. O ID do item EWS do item é devolvido na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId.

• Se o seu suplemento chamar getItemIdAsync (por exemplo, para obter um ID de item para utilizar com o EWS ou a API REST), tenha em atenção que, quando o Outlook está em modo de cache, poderá demorar algum tempo até que o item seja sincronizado com o servidor. Até o item ser sincronizado, o ID do item não é reconhecido e a sua utilização devolve um erro.

Erros:

• ItemNotSaved : o ID não pode ser obtido até que o item seja guardado.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync((result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
        return;
    }

    console.log(result.value);
});

getSelectedDataAsync(coercionType, options, callback)

Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem.

Se não houver seleção, mas o cursor estiver no corpo ou assunto, o método devolve uma cadeia vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection.

Para aceder aos dados selecionados a partir da função de chamada de retorno, chame asyncResult.value.data. Para aceder à source propriedade de origem da seleção, chame asyncResult.value.sourceProperty, que será body ou subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parâmetros

coercionType

Office.CoercionType | string

Solicita um formato para os dados. Se Text, o método devolve o texto simples como uma cadeia, removendo todas as etiquetas HTML presentes. Se HTML, o método devolve o texto selecionado, quer seja texto simples ou HTML.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<any>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Os dados selecionados como uma cadeia com formato determinado por coercionType.

Comentários

[ Conjunto de API: Caixa de Correio 1.2 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

getSelectedDataAsync(coercionType, callback)

Retorna de forma assíncrona os dados selecionados do assunto ou do corpo de uma mensagem.

Se não houver seleção, mas o cursor estiver no corpo ou assunto, o método devolve uma cadeia vazia para os dados selecionados. Se um campo que não seja o corpo ou o assunto estiver selecionado, o método retorna o erro InvalidSelection.

Para aceder aos dados selecionados a partir da função de chamada de retorno, chame asyncResult.value.data. Para aceder à source propriedade de origem da seleção, chame asyncResult.value.sourceProperty, que será body ou subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

coercionType

Office.CoercionType | string

Solicita um formato para os dados. Se Text, o método devolve o texto simples como uma cadeia, removendo todas as etiquetas HTML presentes. Se HTML, o método devolve o texto selecionado, quer seja texto simples ou HTML.

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Os dados selecionados como uma cadeia com formato determinado por coercionType.

Comentários

[ Conjunto de API: Caixa de Correio 1.2 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

getSharedPropertiesAsync(options, callback)

Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada.

Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item partilhado.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 para suporte de pastas partilhadas, Caixa de Correio 1.13 para suporte de caixa de correio partilhada ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Nota: este método não é suportado no Outlook para iOS ou Android.

getSharedPropertiesAsync(callback)

Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada.

Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. A asyncResult.value propriedade fornece as propriedades do item partilhado.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 para suporte de pastas partilhadas, Caixa de Correio 1.13 para suporte de caixa de correio partilhada ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Nota: este método não é suportado no Outlook para iOS ou Android.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

isClientSignatureEnabledAsync(options, callback)

Obtém se a assinatura do cliente estiver ativada.

No Outlook no Windows (clássico) e no Mac, devolve true se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, devolve true se a assinatura está ativada para os tiposnewMail de composição , replyou forward. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou no Mac ou desativadas no Outlook na Web ou no novo Outlook no Windows, devolve false.

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Obtém se a assinatura do cliente estiver ativada.

No Outlook no Windows (clássico) e no Mac, devolve true se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, devolve true se a assinatura está ativada para os tiposnewMail de composição , replyou forward. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou no Mac ou desativadas no Outlook na Web ou no novo Outlook no Windows, devolve false.

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

loadCustomPropertiesAsync(callback, userContext)

Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.

As propriedades personalizadas são armazenadas como pares chave-valor numa base por aplicação, por item. Este método devolve um objeto CustomProperties na chamada de retorno, que fornece métodos para aceder às propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são encriptadas no item, pelo que não deve ser utilizado como armazenamento seguro.

As propriedades personalizadas são fornecidas como um objeto CustomProperties na propriedade asyncResult.value. Este objeto pode ser utilizado para obter, definir, guardar e remover propriedades personalizadas do item de correio.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

userContext

any

Opcional. Os desenvolvedores podem fornecer qualquer objeto que desejarem acessar na função de retorno de chamada. Esse objeto pode ser acessado pela propriedade asyncResult.asyncContext na função de retorno de chamada.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Para saber mais sobre as propriedades personalizadas, consulte Obter e definir metadados de suplementos para um suplemento do Outlook.

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Remove um anexo de uma mensagem ou de um compromisso.

O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.

removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo a remover. O comprimento máximo da cadeia de carateres é de attachmentId 200 carateres em Outlook na Web e no Windows (novo e clássico).

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a remoção do anexo falhar, a propriedade asyncResult.error conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante*: o removeAttachmentAsync método não remove anexos inline de um item de correio. Para remover um anexo inline, primeiro obtenha o corpo do item e, em seguida, remova quaisquer referências do anexo do respetivo conteúdo. Utilize as APIs Office.Body para obter e definir o corpo de um item.

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Remove um anexo de uma mensagem ou de um compromisso.

O método removeAttachmentAsync remove o anexo com o identificador especificado do item. Como prática recomendada, deve-se usar o identificador do anexo para remover um anexo somente se o mesmo aplicativo de email tiver adicionado esse anexo na mesma sessão. No Outlook na Web, em dispositivos móveis e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.

removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

attachmentId

string

O identificador do anexo a remover. O comprimento máximo da cadeia de carateres é de attachmentId 200 carateres em Outlook na Web e no Windows (novo e clássico).

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a remoção do anexo falhar, a propriedade asyncResult.error conterá um código de erro com o motivo da falha.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante*: o removeAttachmentAsync método não remove anexos inline de um item de correio. Para remover um anexo inline, primeiro obtenha o corpo do item e, em seguida, remova quaisquer referências do anexo do respetivo conteúdo. Utilize as APIs Office.Body para obter e definir o corpo de um item.

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.

removeHandlerAsync(eventType, options, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos suportados, veja a secção Eventos do modelo de objeto de item.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve revogar o manipulador.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

removeHandlerAsync(eventType, callback)

Remove um manipulador de eventos para um tipo de evento com suporte. Nota: os eventos só estão disponíveis com a implementação do painel de tarefas.

Para eventos suportados, veja a secção Eventos do modelo de objeto de item.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

eventType

Office.EventType | string

O evento que deve revogar o manipulador.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Organizador de Compromissos

Exemplos

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.InfobarClicked, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});

saveAsync(options, callback)

Salva um item de forma assíncrona.

Uma vez que os compromissos não têm nenhum estado de rascunho, se saveAsync for chamado para um compromisso no modo de composição, o item é guardado como um compromisso normal no calendário do utilizador. Para novos compromissos que ainda não tenham sido guardados, não é enviado nenhum convite. Para compromissos existentes, é enviada uma atualização aos participantes adicionados ou removidos.

saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. O ID de compromisso do EWS é devolvido na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• No Outlook na Web, o novo Outlook no Windows ou o Outlook clássico no Windows no modo online (modo não colocado em cache), o item é guardado no servidor. No Outlook no modo cache, o item é salvo no cache local.

• Ao trabalhar com conteúdo formatado em HTML, é importante ter em atenção que o cliente do Outlook pode modificar o conteúdo. Isto significa que as chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce até mesmo saveAsync podem não resultar no mesmo conteúdo.

• O identificador devolvido é o mesmo que o identificador de item dos Serviços Web exchange (EWS). O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId.

• Se o seu suplemento chamar saveAsync para obter um ID de item para utilizar com o EWS ou a API REST, tenha em atenção que, quando o Outlook está no modo de cache, poderá demorar algum tempo até que o item seja realmente sincronizado com o servidor. Até o item ser sincronizado, a utilização do ID do item devolverá um erro.

• No Outlook para Mac, apenas a Versão 16.35 (20030802) e posterior suporta a gravação de uma reunião. Caso contrário, o saveAsync método falha quando é chamado a partir de uma reunião no modo de composição. Para obter uma solução, consulte Não é possível guardar uma reunião como um rascunho no Outlook para Mac através da API do Office JS.

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/save.yaml

Office.context.mailbox.item.saveAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`saveAsync succeeded, itemId is ${result.value}`);
  }
  else {
    console.error(`saveAsync failed with message ${result.error.message}`);
  }
});

saveAsync(callback)

Salva um item de forma assíncrona.

Uma vez que os compromissos não têm nenhum estado de rascunho, se saveAsync for chamado para um compromisso no modo de composição, o item é guardado como um compromisso normal no calendário do utilizador. Para novos compromissos que ainda não tenham sido guardados, não é enviado nenhum convite. Para compromissos existentes, é enviada uma atualização aos participantes adicionados ou removidos.

saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. O ID de compromisso do EWS é devolvido na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Importante:

• No Outlook na Web, o novo Outlook no Windows ou o Outlook clássico no Windows no modo online (modo não colocado em cache), o item é guardado no servidor. No Outlook no modo cache, o item é salvo no cache local.

• Ao trabalhar com conteúdo formatado em HTML, é importante ter em atenção que o cliente do Outlook pode modificar o conteúdo. Isto significa que as chamadas subsequentes para métodos como Body.getAsync, Body.setAsynce até mesmo saveAsync podem não resultar no mesmo conteúdo.

• O identificador devolvido é o mesmo que o identificador de item dos Serviços Web exchange (EWS). O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId.

• Se o seu suplemento chamar saveAsync para obter um ID de item para utilizar com o EWS ou a API REST, tenha em atenção que, quando o Outlook está no modo de cache, poderá demorar algum tempo até que o item seja realmente sincronizado com o servidor. Até o item ser sincronizado, a utilização do ID do item devolverá um erro.

• No Outlook para Mac, apenas a Versão 16.35 (20030802) e posterior suporta a gravação de uma reunião. Caso contrário, o saveAsync método falha quando é chamado a partir de uma reunião no modo de composição. Para obter uma solução, consulte Não é possível guardar uma reunião como um rascunho no Outlook para Mac através da API do Office JS.

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem.

O setSelectedDataAsync método insere a cadeia especificada na localização do cursor no assunto ou corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no corpo ou no campo do assunto, é devolvido um erro. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

data

string

Os dados a serem inseridos. Os dados não devem exceder 1.000.000 de caracteres. Se forem passados mais de 1.000.000 de caracteres, ocorrerá uma exceção ArgumentOutOfRange.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno. coercionType : se for texto, o estilo atual é aplicado no Outlook na Web, no Windows (novo e clássico) e no Mac. Se o campo for um editor de HTML, apenas os dados de texto são inseridos, mesmo se os dados forem HTML. Se os dados forem HTML e o campo suportar HTML (o assunto não o faz), o estilo atual é aplicado no Outlook na Web e no novo Outlook no Windows. O estilo predefinido é aplicado no Outlook no Windows (clássico) e no Mac. Se o campo for um campo de texto, retorna um erro InvalidDataFormat. Se coercionType não estiver definido, o resultado depende do campo: se o campo for HTML, HTML será usado; se o campo for texto, texto sem formatação será usado.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.2 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.

Exemplos

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/set-selected-data.yaml

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Insere de forma assíncrona os dados no corpo ou no assunto de uma mensagem.

O setSelectedDataAsync método insere a cadeia especificada na localização do cursor no assunto ou corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor não estiver no corpo ou no campo do assunto, é devolvido um erro. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

data

string

Os dados a serem inseridos. Os dados não devem exceder 1.000.000 de caracteres. Se forem passados mais de 1.000.000 de caracteres, ocorrerá uma exceção ArgumentOutOfRange.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.2 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Organizador de Compromissos

Erros:

• InvalidAttachmentId : o identificador de anexo não existe.