Partager via

Ensemble de conditions requises de l’API du complément Outlook 1.7

Le sous-ensemble d’API de complément Outlook de l’API JavaScript Office inclut des objets, des méthodes, des propriétés et des événements que vous pouvez utiliser dans un complément Outlook.

Remarque

Dans cette documentation, l’ensemble de conditions requises présenté est différent de l’ensemble de conditions requises de la version précédente.

Nouveautés de la version 1.7

L’ensemble de conditions requises de la boîte aux lettres 1.7 inclut toutes les fonctionnalités de l’ensemble de conditions requises 1.6. Les fonctionnalités suivantes ont été ajoutées.

  • Ajout d’une propriété pour obtenir ou définir le modèle de périodicité d’un rendez-vous et obtenir le modèle de périodicité des messages qui sont des demandes de réunion.
  • Ajout d’une propriété pour obtenir l’ID de la série à laquelle appartient un rendez-vous instance.
  • Ajout de méthodes pour gérer les dates et heures de début et de fin d’une série de rendez-vous périodiques.
  • Ajout d’une propriété pour obtenir la valeur d’organisateur d’un rendez-vous en mode composition.
  • Ajout d’une propriété pour obtenir l’expéditeur (de la valeur) d’un message en mode composition.
  • Ajout de méthodes pour ajouter et supprimer des gestionnaires d’événements pour les événements pris en charge sur les éléments.
  • Ajout d’événements qui se produisent lorsque le modèle de périodicité, les destinataires ou l’heure de rendez-vous est modifié.

Liste des API

Le tableau suivant répertorie les API introduites dans l’ensemble de conditions requises de boîte aux lettres 1.7. Pour afficher la documentation de référence sur les API pour toutes les API prises en charge par l’ensemble de conditions requises de boîte aux lettres 1.7 ou antérieur, consultez API Outlook.

Classe Champs Description
AppointmentCompose addHandlerAsync(eventType : Office.EventType | string, handler : any, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
addHandlerAsync(eventType : Office.EventType | string, handler : any, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
organizer Obtient l’organisateur de la réunion spécifiée.
Récurrence Obtient ou définit le modèle de périodicité d’un rendez-vous.
removeHandlerAsync(eventType : Office.EventType | string, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
removeHandlerAsync(eventType : Office.EventType | string, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
seriesId Obtient l’ID de la série à laquelle appartient un instance.
AppointmentRead addHandlerAsync(eventType : Office.EventType | string, handler : any, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
addHandlerAsync(eventType : Office.EventType | string, handler : any, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
Récurrence Obtient le modèle de périodicité d’un rendez-vous.
removeHandlerAsync(eventType : Office.EventType | string, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
removeHandlerAsync(eventType : Office.EventType | string, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
seriesId Obtient l’ID de la série à laquelle appartient un instance.
AppointmentTimeChangedEventArgs end Obtient la date et l’heure de fin du rendez-vous.
start Obtient la date et l’heure de début du rendez-vous.
type Obtient le type de l’événement.
From getAsync(callback ?: (asyncResult : Office.AsyncResult<EmailAddressDetails>) => void) Obtient la valeur d’un message.
getAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<EmailAddressDetails>) => void) Obtient la valeur d’un message.
MessageCompose addHandlerAsync(eventType : Office.EventType | string, handler : any, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
addHandlerAsync(eventType : Office.EventType | string, handler : any, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
from Obtient l’adresse de messagerie de l’expéditeur d’un message.
removeHandlerAsync(eventType : Office.EventType | string, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
removeHandlerAsync(eventType : Office.EventType | string, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
seriesId Obtient l’ID de la série à laquelle appartient un instance.
MessageRead addHandlerAsync(eventType : Office.EventType | string, handler : any, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
addHandlerAsync(eventType : Office.EventType | string, handler : any, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) ajoute un gestionnaire d’événements pour un événement pris en charge.
Récurrence Obtient le modèle de périodicité d’un rendez-vous.
removeHandlerAsync(eventType : Office.EventType | string, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
removeHandlerAsync(eventType : Office.EventType | string, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Supprime les gestionnaires d’événements pour un type d’événement pris en charge.
seriesId Obtient l’ID de la série à laquelle appartient un instance.
Jours Jour Jour de la semaine.
Ven Vendredi
Lun Lundi
Sam Samedi
Soleil Dimanche
Jeu Jeudi
Mar Mardi
Mer Mercredi
Jour de la semaine Jour de semaine (à l’exclusion des jours de week-end) : « Mon », « Mar », « Wed », « Thu » et « Ven ».
Week-endDay Jour du week-end : « Sat » et « Dim ».
Month Avr Avril
Août Août
Dec Décembre
Fév Février
Jan Janvier
Juil Juillet
Juin Juin
Mars Mars
Mai Mai
Novembre Novembre
Oct Octobre
Septembre Septembre
RecurrenceTimeZone AUSCentralStandardTime Australie Centre Standard Heure
AUSEasternStandardTime Heure de Standard Est de l’AUS
AfghanistanStandardTime Afghanistan Standard Time
AlaskanStandardTime Heure Standard de l’Alaska
AleutianStandardTime Temps Standard aléoutien
AltaiStandardTime Altai Standard Time
ArabStandardTime Temps Standard arabe
ArabianStandardTime Heure Standard arabe
ArabicStandardTime Heure Standard arabe
ArgentinaStandardTime Argentine Standard Heure
AstrakhanStandardTime Astrakhan Standard Time
AtlanticStandardTime Atlantique Standard Time
AusCentralW_StandardTime Australie Centre-Ouest Standard Time
AzerbaïdjanStandardTime Azerbaïdjan Standard Heure
AçoresStandardTime Temps Standard des Açores
BahiaStandardTime Standard l’heure de l Standard e
BangladeshStandardTime Bangladesh Standard Time
BelarusStandardTime Heure Standard bélarusse
BougainvilleStandardTime Bougainville Standard Heure
CanadaCentralStandardTime Heure de Standard Centre du Canada
CapeVerdeStandardTime Cap-Vert Standard Temps
CaucasusStandardTime Heure de Standard du Caucase
CenAustraliaStandardTime Australie Centre Standard Heure
CentralAmericaStandardTime Heure Standard d’Amérique centrale
CentralAsiaStandardTime Asie Centrale Standard Temps
CentralBrazilianStandardTime Heure de Standard du Brésil centre
CentralEuropeStandardTime Heure Standard Europe Centrale
CentralEuropeanStandardTime Heure Standard d’Europe centrale
CentralPacificStandardTime Heure de Standard Du Pacifique Centre
CentralStandardTime Heure Standard centrale
CentralStandardTime_Mexico Heure du Standard central (Mexique)
ChathamIslandsStandardTime Îles Chatham Standard Time
ChinaStandardTime Heure Standard Chine
CubaStandardTime Cuba Standard Time
DatelineStandardTime Dateline Standard Time
E_AfricaStandardTime Temps Standard Afrique de l’Est
E_AustraliaStandardTime Australie Est Standard Heure
E_EuropeStandardTime Europe Est Standard Heure
E_SouthAmericaStandardTime Amérique du Sud est Standard Heure
EasterIslandStandardTime Île de Pâques Standard Heure
EasternStandardTime Heure Standard de l’Est
EasternStandardTime_Mexico Heure Standard de l’Est (Mexique)
EgyptStandardTime Egypte Standard Time
EkaterinburgStandardTime Ekaterinbourg Standard Temps
FLEStandardTime Heure Standard FLE
FidjiStandardTime Fidji Standard Heure
GMTStandardTime Heure de Standard GMT
GTBStandardTime Heure de Standard GTB
GeorgianStandardTime Heure Standard géorgienne
GroenlandStandardTime Heure Standard du Groenland
GreenwichStandardTime Heure de Greenwich Standard
HaitiStandardTime Haïti Standard Time
HawaiianStandardTime Heure Standard hawaïenne
IndiaStandardTime Inde Standard Time
IranStandardTime Iran Standard Time
IsraelStandardTime Israël Standard Time
JordanStandardTime Jordanie Standard Heure
KaliningradStandardTime Kaliningrad Standard Heure
KamchatkaStandardTime Temps Standard Kamchatka
KoreaStandardTime Heure Standard corée
LibyeStandardTime Temps Standard Libye
LineIslandsStandardTime Line Islands Standard Time
LordHoweStandardTime Lord Howe Standard Time
MagadanStandardTime Magadan Standard Time
MagallanesStandardTime Magallanes Standard Time
MarquesasStandardTime Marquesas Standard Time
MauriceStandardTime Maurice Standard Time
MidAtlanticStandardTime heure Mid-Atlantic Standard
MiddleEastStandardTime Temps Standard Moyen-Orient
MontevideoStandardTime Montevideo Standard Time
MarocStandardTime Heure Standard maroc
MountainStandardTime Temps Standard montagne
MountainStandardTime_Mexico Mountain Standard Time (Mexique)
MyanmarStandardTime Myanmar Standard Time
N_CentralAsiaStandardTime Asie Centre Nord Standard Temps
NamibieStandardTime Heure Standard namibie
NepalStandardTime Népal Standard Heure
NewZealandStandardTime Nouvelle-Zélande Standard Time
NewfoundlandStandardTime Heure Standard de Terre-Neuve
NorfolkStandardTime Norfolk Standard Time
NorthAsiaEastStandardTime Asie Nord-Est Standard Heure
NorthAsiaStandardTime Asie du Nord Standard Temps
NorthKoreaStandardTime Corée du Nord Standard Heure
OmskStandardTime Heure Standard Omsk
PacificSAStandardTime Heure de Standard sa du Pacifique
PacificStandardTime Heure Standard du Pacifique
PacificStandardTimeMexico Heure Standard du Pacifique (Mexique)
PakistanStandardTime Pakistan Standard Time
ParaguayStandardTime Paraguay Standard Time
RomanceStandardTime Romance Standard Time
RussiaTimeZone10 Zone horaire Russie 10
RussiaTimeZone11 Fuseau horaire Russie 11
RussiaTimeZone3 Fuseau horaire Russie 3
RussianStandardTime Heure Standard russe
SAEasternStandardTime Heure de Standard Est sa
SAPacificStandardTime Heure de Standard pacifique sa
SAWesternStandardTime Heure de Standard ouest sa
SEAsiaStandardTime Asie Sud-Est Standard Temps
SaintPierreStandardTime Saint-Pierre Standard Temps
SakhalinStandardTime Heure Standard sakhaline
SamoaStandardTime Samoa Standard Time
SaratovStandardTime Saratov Standard Heure
SingapourStandardTime Heure Standard de Singapour
SouthAfricaStandardTime Afrique du Sud Standard Heure
SriLankaStandardTime Sri Lanka Standard l’heure
SoudanStandardTime Soudan Standard Temps
SyriaStandardTime Temps Standard Syrie
TaipeiStandardTime Heure Standard Taipei
TasmanieStandardTime Tasmanie Standard l’heure
TocantinsStandardTime Tocantins Standard Time
TokyoStandardTime Heure Standard de Tokyo
TomskStandardTime Tomsk Standard Time
TongaStandardTime Heure Standard Tonga
TransbaikalStandardTime Transbaikal Standard Time
TurkeyStandardTime Heure Standard turquie
TurksAndCaicosStandardTime Turks and Caicos Standard Time
USEasternStandardTime États-Unis l’Heure Standard de l’Est
USMountainStandardTime États-Unis Mountain Standard Time
UTC Temps universel coordonné (UTC)
UTCMINUS02 Temps universel coordonné (UTC) - 2 heures
UTCMINUS08 Temps universel coordonné (UTC) - 8 heures
UTCMINUS09 Temps universel coordonné (UTC) - 9 heures
UTCMINUS11 Temps universel coordonné (UTC) - 11 heures
UTCPLUS12 Temps universel coordonné (UTC) + 12 heures
UTCPLUS13 Temps universel coordonné (UTC) + 13 heures
UlaanbaatarStandardTime Oulan-Bator Standard
VenezuelaStandardTime Venezuela Standard Time
VladivostokStandardTime Vladivostok Standard Time
W_AustraliaStandardTime Australie Ouest Standard Heure
W_CentralAfricaStandardTime Heure de Standard d’Afrique centrale de l’Ouest
W_EuropeStandardTime Europe Ouest Standard Temps
W_MongoliaStandardTime Mongolie occidentale Standard Temps
WestAsiaStandardTime Asie Ouest Standard Temps
WestBankStandardTime West Bank Standard Time
WestPacificStandardTime Heure de Standard Pacifique Ouest
YakutskStandardTime Heure Standard Yakutsk
RecurrenceType Journalière Quotidien.
Mensuelle Mensuel.
Jour de la semaine Semaine.
En semaines Hebdomadaire.
Tous les ans Annuel.
WeekNumber Premier Première semaine du mois.
Quatrième Quatrième semaine du mois.
Nom Dernière semaine du mois.
Seconde Deuxième semaine du mois.
Troisième Troisième semaine du mois.
Organizer getAsync(callback ?: (asyncResult : Office.AsyncResult<EmailAddressDetails>) => void) Obtient la valeur d’organisateur d’un rendez-vous en tant qu’objet EmailAddressDetails
getAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<EmailAddressDetails>) => void) Obtient la valeur d’organisateur d’un rendez-vous en tant qu’objet EmailAddressDetails
RecipientsChangedEventArgs changedRecipientFields Obtient un objet qui indique l’état de modification des champs destinataires.
type Obtient le type de l’événement.
RecipientsChangedFields bcc Obtient si les destinataires du champ cci ont été modifiés.
cc Obtient si les destinataires du champ cc ont été modifiés.
optionalAttendees Obtient si les participants facultatifs ont été modifiés.
requiredAttendees Obtient si les participants requis ont été modifiés.
resources Obtient si les ressources ont été modifiées.
to Obtient si les destinataires du champ to ont été modifiés.
Périodicité getAsync(callback ?: (asyncResult : Office.AsyncResult<Recurrence>) => void) Retourne l’objet de périodicité actuel d’une série de rendez-vous.
getAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<Recurrence>) => void) Retourne l’objet de périodicité actuel d’une série de rendez-vous.
recurrenceProperties Obtient ou définit les propriétés de la série de rendez-vous périodiques.
recurrenceTimeZone Obtient ou définit les propriétés de la série de rendez-vous périodiques.
recurrenceType Obtient ou définit le type de la série de rendez-vous périodiques.
seriesTime L’objet SeriesTime vous permet de gérer les dates de début et de fin de la série de rendez-vous périodiques et
setAsync(recurrencePattern : Recurrence, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Définit le modèle de périodicité d’une série de rendez-vous.
setAsync(recurrencePattern : Recurrence, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) Définit le modèle de périodicité d’une série de rendez-vous.
RecurrenceChangedEventArgs Récurrence Obtient l’objet de périodicité mis à jour.
type Obtient le type de l’événement.
RecurrenceProperties dayOfMonth Représente le jour du mois.
Dayofweek Représente le jour de la semaine ou le type de jour, par exemple, le jour du week-end ou le jour de la semaine.
Jours Représente l’ensemble de jours pour cette périodicité.
firstDayOfWeek Représente le premier jour de la semaine que vous avez choisi, sinon la valeur par défaut est la valeur dans les paramètres de l’utilisateur actuel.
interval Représente la période entre les instances de la même série périodique.
Mois Représente le mois.
numéro de semaine Représente le nombre de la semaine dans le mois sélectionné, par exemple, « première » pour la première semaine du mois.
RecurrenceTimeZone name Représente le nom du fuseau horaire de périodicité.
Compenser Valeur entière représentant la différence en minutes entre le fuseau horaire local et l’heure UTC à la date de début de la série de réunions.
SeriesTime getDuration() Obtient la durée en minutes d’un instance habituel dans une série de rendez-vous périodiques.
getEndDate() Obtient la date de fin d’un modèle de périodicité dans les éléments suivants
getEndTime() Obtient l’heure de fin d’une demande de rendez-vous ou de réunion habituelle instance d’un modèle de périodicité dans le fuseau horaire que l’utilisateur ou
getStartDate() Obtient la date de début d’un modèle de périodicité dans les éléments suivants
getStartTime() Obtient l’heure de début d’un rendez-vous habituel instance d’un modèle de périodicité dans le fuseau horaire défini par l’utilisateur/complément
setDuration(minutes : number) Définit la durée de tous les rendez-vous dans un modèle de périodicité.
setEndDate(date : string) Définit la date de fin d’une série de rendez-vous périodiques.
setEndDate(year : number, month : number, day : number) Définit la date de fin d’une série de rendez-vous périodiques.
setStartDate(date :string) Définit la date de début d’une série de rendez-vous périodiques.
setStartDate(year :number, month :number, day :number) Définit la date de début d’une série de rendez-vous périodiques.
setStartTime(hours : number, minutes : number) Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité
setStartTime(time : string) Définit l’heure de début de toutes les instances d’une série de rendez-vous périodiques dans le fuseau horaire défini par le modèle de périodicité

Événements

Le tableau suivant répertorie les événements introduits dans l’ensemble de conditions requises 1.7. Pour obtenir la liste de tous les événements pris en charge qui peuvent être gérés à l’aide des addHandlerAsync méthodes et removeHandlerAsync , voir Office.EventType.

Événement Description Objet
AppointmentTimeChanged La date ou l’heure du rendez-vous ou de la série sélectionnée a été modifiée. Option
RecipientsChanged La liste des destinataires de l’élément ou de l’emplacement de rendez-vous sélectionné a été modifiée. Option
Périodicité modifiée Le modèle de périodicité de la série de réunions sélectionnée a été modifié. Option

Voir aussi

  • Last updated on