Contacts

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

Personne ou groupe pouvant être utilisé en tant que créateur ou contact.

{
  "kind": "mirror#contact",
  "source": string,
  "id": string,
  "displayName": string,
  "imageUrls": [
    string
  ],
  "type": string,
  "acceptTypes": [
    string
  ],
  "phoneNumber": string,
  "priority": unsigned integer,
  "acceptCommands": [
    {
      "type": string
    }
  ],
  "speakableName": string,
  "sharingFeatures": [
    string
  ]
}
Nom de propriété Valeur Description Remarques
acceptCommands[] list Liste des commandes vocales de menu qu'un contact peut gérer. Glass affiche un maximum de trois contacts pour chaque commande vocale du menu. S'il y en a plus, les trois contacts ayant le priority le plus élevé sont affichés pour cette commande particulière. accessible en écriture
acceptCommands[].type string Type d'opération auquel cette commande correspond. Valeurs autorisées :
  • TAKE_A_NOTE : partage un élément de la chronologie avec la transcription du discours de l'utilisateur à partir de la commande de menu vocal "Créer une note".
  • POST_AN_UPDATE : partage un élément de chronologie avec la transcription du discours de l'utilisateur à partir de la commande de menu vocal "Publier une mise à jour".
accessible en écriture
acceptTypes[] list Liste des types MIME acceptés par un contact. Le contact sera affiché à l'utilisateur si l'un de ses AcceptTypes correspond à l'un des types de pièces jointes de l'élément. Si aucune valeur acceptéesTypes n'est définie, le contact sera affiché pour tous les éléments. accessible en écriture
displayName string Nom à afficher pour ce contact. accessible en écriture
id string ID de ce contact. Il est généré par l'application et traité comme un jeton opaque. accessible en écriture
imageUrls[] list Ensemble d'URL d'images à afficher pour un contact. La plupart des contacts ont une seule image, mais un contact "de groupe" peut comprendre jusqu'à 8 URL d'image, et ils seront redimensionnés et recadrés dans une mosaïque sur le client. accessible en écriture
kind string Type de ressource. Il s'agit toujours de mirror#contact.
phoneNumber string Numéro de téléphone principal du contact. Il peut s'agir d'un numéro complet avec l'indicatif de pays et l'indicatif de zone, ou un numéro local. accessible en écriture
priority unsigned integer Priorité pour le contact afin de déterminer l'ordre d'affichage dans une liste de contacts. Les contacts de priorité supérieure s'affichent avant ceux de priorité inférieure. accessible en écriture
sharingFeatures[] list Liste des fonctionnalités de partage qu'un contact peut gérer. Valeurs autorisées :
  • ADD_CAPTION
source string ID de l'application qui a créé ce contact. Ce champ est renseigné par l'API
speakableName string Nom de ce contact tel qu'il doit être prononcé. Si le nom de ce contact doit être prononcé dans un menu de sélection d'ambiguïté, ce nom sera utilisé pour la prononciation attendue. Cette option est utile pour les noms de contact comportant des caractères non prononcés ou dont l'orthographe n'est pas phonétique dans les autres cas. accessible en écriture
type string Type de ce contact. Cela permet de trier les interfaces utilisateur. Valeurs autorisées:
  • INDIVIDUAL : représente une seule personne. Il s'agit de la valeur par défaut.
  • GROUP : représente plusieurs personnes.
accessible en écriture

Méthodes

supprimer
Supprime un contact.
obtenir
Récupère un seul contact par ID.
insérer
Insère un nouveau contact.
list
Récupère une liste de contacts pour l'utilisateur authentifié.
correctif
Met à jour un contact en place. Cette méthode est compatible avec la sémantique "patch".
mettre à jour
Met à jour un contact en place.