Verwalten von Kontakten

Mit der JavaScipt-API des Simplifier Mobile Client können Sie Ihre Kontakte in Ihren Geschäftsanwendungen verwalten. Es gibt Methoden zum Erstellen, Lesen, Löschen und Bearbeiten von Kontakten.

Lesen von Kontakten

Es gibt zwei Möglichkeiten, Kontakte zu lesen. Die erste Möglichkeit besteht darin, alle vorhandenen Kontakte anzufordern. Die zweite Möglichkeit besteht darin, einen einzelnen Kontakt aus einer Kontaktliste auszuwählen.

Anfordern einer Kontaktliste

Um eine Kontaktliste anzufordern, können Sie die Funktion window.Contacts.find verwenden, die einen Success-Callback, einen Error-Callback und ein Option-Objekt benötigt, das beschreibt, welche Kontaktfelder gefüllt werden sollen. Der Erfolgsparameter ist ein Array von Kontakten ohne die durch das Option-Objekt gefilterten Felder.

window.ContactsX.find(fnSuccess, fnError, oContactOptions)

Beispiel:

window.ContactsX.find(
  function (aContacts) {
  console.log(aContacts);
  },
  function (oError) {
  console.error(oError);
  },
  {
  fields: {
  displayName:true, //default: true
  firstName:true, //default: true
  middleName:true, //default: true
  familyName:true, //default: true
  phoneNumbers:true,
  emails:false,
  addresses:false
  }
  }
);

Auswählen eines einzelnen Kontakts

Die Verwendung der Funktion window.ContactsX.pick startet eine Kontaktauswahl, um einen einzelnen Kontakt auszuwählen. Die Funktionen erfordern einen Success-Callback und einen Error-Callback. Der Erfolgsparameter hat den Datentyp Contact und enthält alle Felder.

window.ContactsX.pick(fnSuccess, fnError)

Beispiel:

window.ContactsX.pick(
  function (oSuccess) {
  console.log(oSuccess);
  },
  function (oError) {
  console.error(oError);
  }
);

Erstellen und Bearbeiten eines Kontakts

Die Methode window.ContactsX.save ermöglicht das Erstellen und Bearbeiten von Kontakten. Diese Methode erfordert ein Contact-Objekt, einen Success-Callback und einen Error-Callback als Parameter. Der Success-Callback empfängt das gespeicherte Contact-Objekt.

window.ContactsX.save(oContact, fnError, oContactOptions)

Erstellen eines neuen Kontakts

Um einen neuen Kontakt zu erstellen, darf das Kontaktobjekt das Feld id nicht enthalten.

Beispiel:

window.ContactsX.save(
  {
  firstName: "John",
  familyName: "Doe",
  phoneNumbers: [{
  type: "mobile",
  value: "112"
  }]
  },
  function (oContact) {
  console.log(oContact);
  },  
  function (oError) {
  console.error(oError);
  }
);

Bearbeiten eines vorhandenen Kontakts

Das Aktualisieren eines Kontakts funktioniert genauso wie das Erstellen eines Kontakts. Wichtig ist hier, das ID-Feld und alle anderen Felder des Kontakts einzubeziehen.

Beispiel:

window.ContactsX.save(
  {
  id: "877-568-ABC",
  firstName: "John",
  familyName: "Doe",
  phoneNumbers: [{
  type: "mobile",
  value: "110112"
  }]
  },
  function (oContact) {
  console.log(oContact);
  },  
  function (oError) {
  console.error(oError);
  }
);

Löschen eines Kontakts

Die Methode window.ContactsX.delete ermöglicht das Löschen eines Kontakts. Diese Methode erfordert eine ID eines vorhandenen Kontakts, einen Success-Callback und einen Error-Callback als Parameter.

window.ContactsX.delete(sContactId, fnSuccess, fnError)

Beispiel:

window.ContactsX.delete(
  "877-568-ABC",
  function (oContact) {
  console.log(oContact);
  },  
  function (oError) {
  console.error(oError);
  }
);

Objekte

Kontakt

id (String) – eine eindeutige Kennung
displayName (String) – Wird nur unter Android unterstützt
firstName (String)
middleName (String)
familyName (String)
phoneNumbers (ContactPhoneNumber[])
emails (ContactEmail[])
addresses (ContactAddress[])

ContactPhoneNumber

id (String) – eine eindeutige Kennung
type (String) – Art der Telefonnummer (z. B. “mobile”, “home”)
value (String)

ContactEmail

id (String) – eine eindeutige Kennung
type (String) – Art der E-Mail-Adresse (z. B. “work”, “home”)
value (String)

ContactAddress

id (String) – eine eindeutige Kennung
type (String) – Art der Adresse (z. B. “work”, “home”)
street (String)
locality (String)
region (String)
postalCode (String)
country (String)

Fehler

code (Integer)
message (String)

Fehlercodes

Das Feld code des Error-Objekts kann den folgenden Wert haben, den Sie in window.ContactX.ErrorCodes finden

1 – UnsupportedAction
2 – WrongJsonObject
3 – PermissionDenied
4 – CanceledAction
5 – NotFound
10 – UnknownError