taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

delete-contact.rst (713B)

      1 .. ts:op:: deleteContact
      2 
      3   Delete a contact from the wallet's contact list.
      4 
      5   **Request:**
      6 
      7     The request arguments are a `DeleteContactRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object.
     12 
     13   **Side effects:**
     14 
     15     Deletes the contact from the wallet's contact list and emits a
     16     ``contact-deleted`` notification.
     17 
     18   **Details:**
     19 
     20     Only the ``alias`` and ``aliasType`` fields of the given contact
     21     are used to identify the contact to delete; the remaining fields
     22     are ignored.  Deleting a contact that does not exist is not an
     23     error.
     24 
     25 .. ts:def:: DeleteContactRequest
     26 
     27   interface DeleteContactRequest {
     28     // The contact to delete.
     29     contact: ContactEntry;
     30   }