Class Contacts

constructor

• new Contacts(client): Contacts

• Contacts

  Parameters

  • client: SignifyClient

  Returns Contacts

client

add

• add(pre, info): Promise<Contact>

• Add a contact

  Parameters

  • pre: string

    Prefix of the contact

  • info: ContactInfo

    Information about the contact

  Returns Promise<Contact>

  A promise to the result of the addition

  Async

delete

• delete(pre): Promise<void>

• Delete a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<void>

  Async

get

• get(pre): Promise<Contact>

• Get a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<Contact>

  A promise to the contact

  Async

list

• list(group?, filterField?, filterValue?): Promise<Contact[]>

• List contacts

  Parameters

  • Optional group: string

    Optional group name to filter contacts

  • Optional filterField: string

    Optional field name to filter contacts

  • Optional filterValue: string

    Optional field value to filter contacts

  Returns Promise<Contact[]>

  A promise to the list of contacts

  Async

update

• update(pre, info): Promise<Contact>

• Update a contact

  Parameters

  • pre: string

    Prefix of the contact

  • info: ContactInfo

    Updated information about the contact

  Returns Promise<Contact>

  A promise to the result of the update

  Async