Class Contacts

constructor

• new Contacts(client: SignifyClient): Contacts

  Contacts

  Parameters

  • client: SignifyClient

  Returns Contacts

client

add

• add(pre: string, info: ContactInfo): 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: string): Promise<void>

  Delete a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<void>

  Async

get

• get(pre: string): Promise<Contact>

  Get a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<Contact>

  A promise to the contact

  Async

list

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

  List contacts

  Parameters

  • Optionalgroup: string

    Optional group name to filter contacts
  • OptionalfilterField: string

    Optional field name to filter contacts
  • OptionalfilterValue: string

    Optional field value to filter contacts

  Returns Promise<Contact[]>

  A promise to the list of contacts

  Async

update

• update(pre: string, info: ContactInfo): 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