# Class: MatchedContactsWithMatchLevel

## Constructor

#### new MatchedContactsWithMatchLevel()

  Contains contacts that might be associated with the participant. Contacts are grouped into Exact Match Type 1, Exact Match Type 2 and Partial Match Type 1 based on the strength of matches between participant's address and contact's information.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

## Methods

#### getAllContacts() → {Array.<AvayaClientServices.Services.Contacts.Contact>}

  Returns all matching contacts for the participant.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

  ##### Returns:

  { Array.<AvayaClientServices.Services.Contacts.Contact> }

#### getExactType1Contacts() → {Array.<AvayaClientServices.Services.Contacts.Contact>}

  Returns contacts that have properties matching with the participant's address (the participant's address must be a phone number, dial string or feature access code for this function to return non-empty results).

  For example, if the participant's address is '+19088481111', this function will return all contacts from the user's contact list that have any property with the '+19088481111' value, or any string that will match '+19088481111' after removal of non-dialable characters from it ('+1 (908) 848-11-11', '+1 908 848 11 11').

  There are some minor matching rules that are omitted in this description and examples.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

  ##### See:

    - {AvayaClientServices.Services.Participant#getBestContactMatch}

  ##### Returns:

  { Array.<AvayaClientServices.Services.Contacts.Contact> }

#### getExactType2Contacts() → {Array.<AvayaClientServices.Services.Contacts.Contact>}

  Returns contacts that have properties similar to the participant's address.

  For example, if the participant's address is '+19088481111', this function will return all contacts from the user's contact list that have any property with the value that is URI and '+19088481111' can be extracted from it ('sip:+19088481111@avaya.com', 'xmpp:19088481111').

  There are some minor matching rules that are omitted in this description and examples.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

  ##### Returns:

  { Array.<AvayaClientServices.Services.Contacts.Contact> }

#### getPartialType1Contacts() → {Array.<AvayaClientServices.Services.Contacts.Contact>}

  Returns contacts that have properties partially matching with the participant's address.

  For example, if the participant's address is '+19088481111', this function will return all contacts from the user's contact list that have any property with a value that contains last 10 digits of the participant's address: '9088481111', '+79088481111', 'sip:9088481111@avaya.com'.

  There are some minor matching rules that are omitted in this description and examples.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

  ##### Returns:

  { Array.<AvayaClientServices.Services.Contacts.Contact> }

#### isEmpty() → {boolean}

  Returns true if there are matching contacts for the participant, or false otherwise.

  IMPORTANT: it's recommended to use the Participant.getBestContactMatch() function to get a contact associated with the participant. It encapsulates all required calls to the MatchedContactsWithMatchLevel class.

  ##### Returns:

  { boolean }