Conjunto de requisitos de API para suplementos do Outlook versão 1.7

O subconjunto da API do suplemento do Outlook da API JavaScript do Office inclui objetos, métodos, propriedades e eventos que você pode usar em um suplemento do Outlook.

Observação

Esta documentação destina-se a um conjunto de requisitos que não seja o mais recente.

Novidades da versão 1.7

O conjunto de requisitos de caixa de correio 1.7 inclui todos os recursos do conjunto de requisitos 1.6. Ele adicionou os seguintes recursos.

  • Adicionada uma propriedade para obter ou definir o padrão de recorrência de um compromisso e obter o padrão de recorrência de mensagens que são solicitações de reunião.
  • Adicionada uma propriedade para obter a ID da série à qual uma instância de compromisso pertence.
  • Métodos adicionados para gerenciar as datas e horas de início e término de uma série de compromissos recorrentes.
  • Adicionada uma propriedade para obter o valor de organizador de um compromisso no modo de redação.
  • Adicionada uma propriedade para obter o remetente (Do valor) de uma mensagem no modo de redação.
  • Métodos adicionados para adicionar e remover manipuladores de eventos para eventos suportados em itens.
  • Eventos adicionados que ocorrem quando o padrão de recorrência, os destinatários ou o horário do compromisso são alterados.

Lista de APIs

A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de Correio 1.7. Para exibir a documentação de referência da API para todas as APIs compatíveis com o conjunto de requisitos de Caixa de correio 1.7 ou anterior, consulte APIs do Outlook.

Classe Campos Descrição
AppointmentCompose addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
organizer Obtém o organizador da reunião especificada.
recorrência Obtém ou define o padrão de recorrência de um compromisso.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
removeHandlerAsync(eventType: Office.EventType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
seriesId Obtém a ID da série à qual uma instância pertence.
AppointmentRead addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
recorrência Obtém o padrão de recorrência de um compromisso.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
removeHandlerAsync(eventType: Office.EventType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
seriesId Obtém a ID da série à qual uma instância pertence.
AppointmentTimeChangedEventArgs end Obtém a data e hora de término do compromisso.
start Obtém a data e a hora de início do compromisso.
tipo Obtém o tipo do evento.
De getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Obtém o valor "de" de uma mensagem.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Obtém o valor "de" de uma mensagem.
MessageCompose addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
from Obtém o endereço de email do remetente de uma mensagem.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
removeHandlerAsync(eventType: Office.EventType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
seriesId Obtém a ID da série à qual uma instância pertence.
MessageRead addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona um manipulador de eventos a um evento com suporte.
recorrência Obtém o padrão de recorrência de um compromisso.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
removeHandlerAsync(eventType: Office.EventType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Remove um manipulador de eventos para um tipo de evento com suporte.
seriesId Obtém a ID da série à qual uma instância pertence.
Days Day Dia da semana.
Sexta-feira Sexta-feira
Seg Segunda-feira
Sáb Sábado
Sol Domingo
Qui Quinta-feira
Ter Terça-feira
Qua Quarta-feira
Dia da semana Dia da semana (exclui dias de fim de semana): 'Seg', 'Ter', 'Qua', 'Qui' e 'Sex'.
Dia de fim de semana Dia de fim de semana: 'Sáb' e 'Dom'.
Month Abr Abril
Agosto Agosto
Dez Dezembro
Fev Fevereiro
Jan Janeiro
Jul Julho
Jun Junho
Mar Março
Maio Maio
Novembro Novembro
Out Outubro
Setembro Setembro
RecorrênciaTimeZone AUSCentralStandardTime Australia Central Standard Time
AUSEasternStandardTime Horário de Standard AUS Eastern
AfghanistanStandardTime Afeganistão Standard Time
AlaskanStandardTime Alaskan Standard Time
AleutianStandardTime Aleutian Standard Time
AltaiStandardTime Altai Standard Time
ArabStandardTime Horário Standard árabe
ArabianStandardTime Horário Standard Árabe
ArabicStandardTime Arabic Standard Time
ArgentinaStandardTime Horário Standard Argentina
AstrakhanStandardTime Hora Standard de Astrakhan
AtlanticStandardTime Hora Standard do Atlântico
AusCentralW_StandardTime Australia Central West Standard Time
AzerbaijãoStandardTime Horário Standard Azerbaijão
AçoresStandardTime Hora Standard dos Açores
BahiaStandardTime Hora Standard da Bahia
BangladeshStandardTime Hora Standard de Bangladesh
BelarusStandardTime Horário Standard da Bielorrússia
BougainvilleStandardTime Hora Standard de Bougainville
CanadaCentralStandardTime Hora Padrão Central (Standard) do Canadá Central
Cabo VerdeStandardTime Hora Standard Cabo Verde
CaucasusStandardTime Hora Standard do Cáucaso
CenAustraliaStandardTime Hora Standard da Austrália Central
CentralAmericaStandardTime Hora Standard da América Central
CentralAsiaStandardTime Horário de Standard Ásia Central
CentralBrazilianStandardTime Hora Standard Brasil Central
CentralEuropeStandardTime Hora Standard da Europa Central
CentralEuropeanStandardTime Hora Standard da Europa Central
CentralPacificStandardTime Horário Standard do Pacífico Central
CentralStandardTime Hora Central Standard
CentralStandardTime_Mexico Hora Standard Central (México)
ChathamIslandsStandardTime Hora Standard das Ilhas Chatham
ChinaStandardTime Hora Standard da China
CubaStandardTime Cuba Standard Time
DatelineStandardTime Data Standard Hora
E_AfricaStandardTime Horário Standard África Oriental
E_AustraliaStandardTime Horário Standard Austrália Oriental
E_EuropeStandardTime Horário Standard Europa Oriental
E_SouthAmericaStandardTime Hora Standard do Leste da América do Sul
EasterIslandStandardTime Hora Standard Ilha da Páscoa
EasternStandardTime Hora Standard do leste
EasternStandardTime_Mexico Hora de Standard do Leste (México)
EgyptStandardTime Hora Standard do Egito
Horário Padrão de Ekaterimburgo Horário Standard de Ekaterimburgo
FLEStandardTime FLE Standard Time
FijiStandardTime Hora Standard de Fiji
GMTStandardTime GMT Standard Time
GTBStandardTime Hora Standard GTB
GeorgianStandardTime Hora Standard Georgiana
GreenlandStandardTime Hora Standard da Groenlândia
GreenwichStandardTime Hora Standard de Greenwich
HaitiStandardTime Haiti Standard Time
HawaiianStandardTime Hora Standard Havaiana
IndiaStandardTime Hora Standard da Índia
IranStandardTime Hora Standard Irã
IsraelStandardTime Horário Standard de Israel
JordanStandardTime Hora Standard da Jordânia
KaliningradoStandardTime Hora Standard de Kaliningrado
KamchatkaStandardTime Hora Standard de Kamchatka
KoreaStandardTime Hora Standard da Coreia
LibyaStandardTime Horário Standard da Líbia
LineIslandsStandardTime Hora Standard das Ilhas da Linha
LordHoweStandardTime Hora Standard de Lord Howe
MagadanStandardTime Hora Standard de Magadã
MagallanesStandardTime Hora Standard de Magalhães
MarquesasStandardTime Hora Standard das Marquesas
MaurícioStandardTime Hora Standard Maurício
MidAtlanticStandardTime Mid-Atlantic Standard Horário
MiddleEastStandardTime Horário Standard Oriente Médio
MontevideoStandardTime Hora Standard de Montevidéu
MoroccoStandardTime Horário Standard do Marrocos
MountainStandardTime Hora Standard Montanhas
MountainStandardTime_Mexico Hora Standard Montanhas (México)
MyanmarStandardTime Horário Standard de Myanmar
N_CentralAsiaStandardTime Centro-Norte da Ásia Standard Time
NamibiaStandardTime Horário Standard da Namíbia
NepalStandardTime Horário Standard do Nepal
NewZealandStandardTime Horário de Standard da Nova Zelândia
NewfoundlandStandardTime Newfoundland Standard Time
NorfolkStandardTime Hora Standard de Norfolk
NorthAsiaEastStandardTime Horário Standard Leste do Norte da Ásia
NorthAsiaStandardTime Horário de Standard do Norte da Ásia
NorthKoreaStandardTime Hora Standard da Coreia do Norte
OmskStandardTime Hora Standard de Omsk
PacificSAStandardTime Horário Standard - Pacífico
PacificStandardTime Hora Standard do Pacífico
PacificStandardTimeMexico Hora Standard do Pacífico (México)
PakistanStandardTime Horário Standard Paquistão
ParaguayStandardTime Hora Standard do Paraguai
RomanceStandardTime Horário Standard Românica
RussiaTimeZone10 Fuso Horário da Rússia 10
RussiaTimeZone11 Fuso Horário da Rússia 11
RussiaTimeZone3 Fuso Horário da Rússia 3
RussianStandardTime Horário Standard russo
SAEasternStandardTime Horário de Standard do leste da África do Sul
SAPacificStandardTime Hora Standard de Bogotá
SAWesternStandardTime Horário de Standard de Caracas
SEAsiaStandardTime Horário de Standard do Sudeste Asiático
SaintPierreStandardTime Hora Standard de São Pedro
SakhalinStandardTime Sakhalin Standard Time
SamoaStandardTime Hora Standard de Samoa
SaratovStandardTime Hora Standard de Saratov
SingaporeStandardTime Horário Standard de Singapura
SouthAfricaStandardTime Hora Standard da África do Sul
SriLankaStandardTime Horário Standard Sri Lanka
SudanStandardTime Hora Standard Sudão
SyriaStandardTime Horário Standard Síria
Horário Padrão de Taipé Horário Standard de Taipé
TasmâniaStandardTime Hora Standard da Tasmânia
TocantinsStandardTime Hora Standard de Tocantins
TokyoStandardTime Horário Standard de Tóquio
TomskStandardTime Hora Standard de Tomsk
TongaStandardTime Hora Standard de Tonga
TransbaikalStandardTime Horário Standard Transbaikal
TurkeyStandardTime Hora Standard da Turquia
TurksAndCaicosStandardTime Hora Standard de Turcos e Caicos
USEasternStandardTime Estados Unidos Horário Standard do Leste
USMountainStandardTime Estados Unidos Mountain Standard Time
UTC UTC
UTCMINUS02 UTC (Tempo Universal Coordenado) - 2 horas
UTCMINUS08 UTC (Tempo Universal Coordenado) - 8 horas
UTCMINUS09 UTC (Tempo Universal Coordenado) - 9 horas
UTCMINUS11 UTC (Tempo Universal Coordenado) - 11 horas
UTCPLUS12 UTC (Tempo Universal Coordenado) + 12 horas
UTCPLUS13 UTC (Tempo Universal Coordenado) + 13 horas
UlaanbaatarStandardTime Horário Standard Ulan Bator
VenezuelaStandardTime Horário Standard Venezuela
VladivostokStandardTime Vladivostok Standard Time
W_AustraliaStandardTime Horário Standard da Austrália Ocidental
W_CentralAfricaStandardTime Hora Standard da África Centro-Oeste
W_EuropeStandardTime Hora Standard do Oeste da Europa
W_MongoliaStandardTime Hora Standard da Mongólia Ocidental
WestAsiaStandardTime Horário de Standard do Oeste da Ásia
WestBankStandardTime West Bank Standard Time
WestPacificStandardTime Hora Standard do Pacífico Oeste
YakutskStandardTime Horário Standard de Yakutsk
RecurrenceType Diariamente Diariamente.
Mensal Mensalmente.
Dia da semana Dia da semana.
Semanalmente Semanalmente.
Anualmente Anualmente.
WeekNumber Primeiro Primeira semana do mês.
Quarto Quarta semana do mês.
Último Última semana do mês.
Segundo Segunda semana do mês.
Terceira Terceira semana do mês.
Organizador getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Obtém o valor do organizador de um compromisso como um objeto EmailAddressDetails
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Obtém o valor do organizador de um compromisso como um objeto EmailAddressDetails
RecipientsChangedEventArgs changedRecipientFields Obtém um objeto que indica o estado de alteração dos campos destinatários.
tipo Obtém o tipo do evento.
RecipientsChangedFields bcc Obtém se os destinatários no campo Cco foram alterados.
cc Obtém se os destinatários no campo cc foram alterados.
optionalAttendees Obtém se os participantes opcionais foram alterados.
requiredAttendees Obtém se os participantes necessários foram alterados.
resources Obtém se os recursos foram alterados.
to Obtém se os destinatários no campo para foram alterados.
Recurrence getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) Retorna o objeto de recorrência atual de uma série de compromissos.
getAsync(opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<Recurrence>) => void) Retorna o objeto de recorrência atual de uma série de compromissos.
recurrenceProperties Obtém ou define as propriedades da série de compromissos recorrentes.
recurrenceTimeZone Obtém ou define as propriedades da série de compromissos recorrentes.
recurrenceType Obtém ou define o tipo da série de compromissos recorrentes.
seriesTime O objeto SeriesTime permite que você gerencie as datas de início e término da série de compromissos recorrentes e
setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o padrão de recorrência de uma série de compromissos.
setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o padrão de recorrência de uma série de compromissos.
RecurrenceChangedEventArgs recorrência Obtém o objeto de recorrência atualizado.
tipo Obtém o tipo do evento.
RecurrenceProperties dayOfMonth Representa o dia do mês.
dayOfWeek Representa o dia da semana ou o tipo de dia, por exemplo, dia de fim de semana vs dia da semana.
dias Representa o conjunto de dias para essa recorrência.
firstDayOfWeek Representa o primeiro dia da semana escolhido; caso contrário, o padrão será o valor nas configurações do usuário atual.
intervalo Representa o período entre instâncias da mesma série recorrente.
Mês Representa o mês.
número da semana Representa o número da semana no mês selecionado, por exemplo, 'primeiro' para a primeira semana do mês.
RecorrênciaTimeZone name Representa o nome do fuso horário de recorrência.
de deslocamento Valor inteiro que representa a diferença em minutos entre o fuso horário local e o UTC na data em que a série de reuniões começou.
SeriesTime getDuration() Obtém a duração em minutos de uma instância normal em uma série de compromissos recorrentes.
getEndDate() Obtém a data de término de um padrão de recorrência no seguinte
getEndTime() Obtém a hora de término de um compromisso normal ou uma instância de solicitação de reunião de um padrão de recorrência em qualquer fuso horário em que o usuário ou
getStartDate() Obtém a data de início de um padrão de recorrência no seguinte
getStartTime() Obtém a hora de início de uma instância de compromisso normal de um padrão de recorrência em qualquer fuso horário que o usuário/suplemento definiu o
setDuration(minutes: number) Define a duração de todos os compromissos em um padrão de recorrência.
setEndDate(date: string) Define a data de término de uma série de compromissos recorrentes.
setEndDate(ano: número, mês: número, dia: número) Define a data de término de uma série de compromissos recorrentes.
setStartDate(date:string) Define a data de início de uma série de compromissos recorrentes.
setStartDate(year:number, month:number, day:number) Define a data de início de uma série de compromissos recorrentes.
setStartTime(horas: número, minutos: número) Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário em que o padrão de recorrência estiver definido
setStartTime(time: string) Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário em que o padrão de recorrência estiver definido

Eventos

A tabela a seguir lista os eventos introduzidos no conjunto de requisitos 1.7. Para obter uma lista de todos os eventos com suporte que podem ser manipulados usando os addHandlerAsync métodos and removeHandlerAsync , confira Office.EventType.

Evento Descrição Objeto
AppointmentTimeChanged A data ou hora do compromisso ou série selecionada foi alterada. Item
RecipientsChanged A lista de destinatários do item selecionado ou o local do compromisso foi alterada. Item
RecurrenceChanged O padrão de recorrência da série de reuniões selecionadas foi alterado. Item

Confira também

  • Última atualização em