Erreurs courantes dans Microsoft Graph 4

En plus de troisième article de la série, cet article couvre d’autres études de cas liées aux tâches à effectuer. Pour ce cas d’utilisation, j’ai utilisé le SDK Java MS Graph 5.42.0. Si vous n’avez pas lu les parties 1 et 2 de cette série, les voici :

Partie 1: « Erreurs courantes dans les intégrations Microsoft Graph et comment les résoudre (Partie 1) »

Partie 2: « Erreurs courantes dans les intégrations Microsoft Graph et comment les résoudre (Partie 2) »

Lire les tâches avec un fuseau horaire spécifique

Microsoft Graph Todo Task est un outil puissant permettant aux développeurs d’intégrer le logiciel de gestion de tâches Microsoft To Do dans leurs applications. Il leur permet de créer, mettre à jour et récupérer des tâches à l’aide de l’API Microsoft Graph. L’une des considérations essentielles lorsque vous travaillez avec des outils de gestion des tâches, comme Microsoft To Do, est de s’assurer qu’ils fonctionnent dans le bon fuseau horaire.

Le fuseau horaire joue un rôle crucial dans les outils de gestion des tâches car ils s’appuient sur des délais et des rappels pour garder les utilisateurs sur la bonne voie. Si un utilisateur crée une tâche et définit une échéance ou un rappel, il doit être affiché avec précision en fonction du fuseau horaire de l’utilisateur. Les développeurs travaillant avec la tâche Microsoft Graph Todo doivent s’assurer que leurs applications gèrent correctement les fuseaux horaires pour éviter toute confusion et s’assurer que les tâches sont affichées avec précision.

L’API Microsoft Graph fournit des fonctionnalités intégrées pour la gestion des fuseaux horaires. Lors de la création ou de la mise à jour de tâches, les développeurs peuvent définir les informations de fuseau horaire pour la tâche. L’API prend en charge le format de fuseau horaire standard (par exemple, « America/Los_Angeles ») et le format de fuseau horaire Windows (par exemple, « Pacific Standard Time »).

Les développeurs peuvent également utiliser l’API Microsoft Graph pour récupérer les informations de fuseau horaire de l’utilisateur. Cela peut être utile lors de l’affichage des tâches et des rappels dans le bon fuseau horaire. Par défaut, l’API renvoie le fuseau horaire de l’utilisateur au format de fuseau horaire IANA (par exemple, « America/Los_Angeles »). Cependant, les développeurs peuvent également demander le fuseau horaire de l’utilisateur au format de fuseau horaire Windows.

Lors de la récupération de tâches à l’aide de l’API Microsoft Graph, les développeurs peuvent également spécifier le fuseau horaire dans lequel ils souhaitent récupérer les tâches. Cela peut être utile lors de l’affichage des tâches aux utilisateurs dans différents fuseaux horaires. Par défaut, l’API renvoie les tâches dans le fuseau horaire de l’utilisateur. Cependant, les développeurs peuvent également spécifier un fuseau horaire différent en utilisant le « Préférer” en-tête dans la requête API.

Par exemple, en Java :

LinkedList<Option> requestOptions = new LinkedList<>();
requestOptions.add(new HeaderOption("Prefer", "outlook.timezone=" + "\"" + timeZone + "\""));

Outre les ajustements d’en-tête, voyons comment créer une tâche ToDo avec un fuseau horaire spécifique :

String timeZone = "Pacific Standard Time"; //replace with the desired timezone
String apiEndpoint = "https://graph.microsoft.com/v1.0/me/tasks";
String json = "{\n" +
                "  \"subject\": \"Complete Task\",\n" +
                "  \"body\": {\n" +
                "    \"contentType\": \"Text\",\n" +
                "    \"content\": \"This is a task with specific time zone\"\n" +
                "  },\n" +
                "  \"dueDateTime\": {\n" +
                "    \"dateTime\": \"2021-12-01T14:30:00\",\n" +
                "    \"timeZone\": \""+timeZone+"\"\n" +
                "  }\n" +
                "}";
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(apiEndpoint))
            .header("Authorization", "Bearer " + accessToken)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(json))
            .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Dans le code ci-dessus, remplacez la valeur de timeZone variable avec le fuseau horaire souhaité. Remplacez également les propriétés subject et body de l’objet tâche par vos propres valeurs. Le dueDateTime propriété de l’objet tâche contient un dateTime et timeZone propriété. Met le dateTime propriété à la date et à l’heure d’échéance souhaitées au format ISO. Met le timeZone propriété au fuseau horaire souhaité.

Le fuseau horaire est une considération cruciale lorsque vous travaillez avec des outils de gestion de tâches comme Microsoft To Do. Les développeurs travaillant avec la tâche Microsoft Graph Todo doivent s’assurer que leurs applications gèrent correctement les fuseaux horaires pour éviter toute confusion et s’assurer que les tâches sont affichées avec précision. L’API Microsoft Graph fournit des fonctionnalités intégrées pour gérer les fuseaux horaires et prend en charge l’heure d’été, ce qui permet aux développeurs de créer facilement des applications qui fonctionnent avec des tâches dans différents fuseaux horaires.

Lire la propriété Changekey des tâches ToDo

Sur la base d’un problème documenté sur Github de novembre 2020, il manque des propriétés dans le Microsoft.Graph.todoTask type de ressource par rapport au Microsoft.OutlookServices.Task taper.

Certaines de ces propriétés sont absolument nécessaires à la logique métier et jouent un rôle clé, selon les commentaires du numéro :

À l’heure actuelle, toutes les propriétés demandées ne sont pas disponibles pour une utilisation dans Microsoft Graph v1.0. Dans la version actuelle du MS Graph Java SDK 5.42.0les propriétés suivantes sont incluses dans le modèle de données par défaut :

Dans ce cas d’utilisation, je vais montrer comment lire le changeKey à partir des tâches ToDo via les API MS Graph et le SDK Java.

Le changeKey fait partie de la ETag qui vient avec la tâche ToDo. Pour récupérer le ETag valeur pour une tâche ToDo via Microsoft Graph, vous pouvez utiliser la GET méthode sur la tasks point de terminaison, ainsi que l’ID de la tâche.

Voici un exemple d’URL pour récupérer le ETag valeur pour une tâche spécifique :

https://graph.microsoft.com/v1.0/me/tasks/{task_id}?$select=etag

Remplacer {task_id} avec l’ID de la tâche que vous souhaitez récupérer ETag la valeur pour. Le $select=etag paramètre de requête garantira que seul le ETag valeur est renvoyée dans la réponse.

Comment lire le changeKey de la tâche ToDo via le SDK Java MS Graph ?

Le SDK contient la classe Java AdditionalDataManager. La classe contient des propriétés supplémentaires qui ne font pas partie du schéma de l’objet par défaut, selon la documentation Microsoft. On peut tout lire JSON éléments fournis par la réponse de l’API et qui ne sont pas inclus dans le modèle de données par défaut. Jetons un coup d’œil à l’exemple suivant :

public static final String ODATA_ETAG = "@odata.etag";
public static final String PREFIX = "W/\"";
public static final String SUFFIX = "\"";

String eTag = todoTask.additionalDataManager().get(ODATA_ETAG).getAsString();
String changeKey = convertETagToChangeKey(eTag);

private String convertETagToChangeKey(String eTag) {
        String changekey = "";
        if (Objects.nonNull(eTag) && eTag.startsWith(PREFIX)) {
            String noPrefixSubString = eTag.substring(PREFIX.length());
            if (noPrefixSubString.endsWith(SUFFIX)) {
                return noPrefixSubString.substring(0, noPrefixSubString.length() - 1);
            }
        }
        return changekey;
}

Dans cet exemple, nous utilisons la clé @odata.etag pour lire la valeur de ETag et supprimer le préfixe et le suffixe du ETag pour obtenir la valeur de changeKey.

Conclusion

À ce stade, vous devriez avoir une meilleure compréhension des erreurs d’intégration courantes qui peuvent être observées dans les intégrations Microsoft Graph et comment les résoudre. J’espère que cet article a été instructif et utile. N’hésitez pas à commenter ci-dessous et à partager cet article !