eq( )


Refines a query to match items whose specified property value equals the specified value.

The eq() function refines a ContactsQueryBuilder to only match items where the value of the specified property equals the specified value.

It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.

Matching strings with eq() is case sensitive in most instances, so "text" is not equal to "Text". One exception is email fields, which are case insensitive when matching with eq().

If the value of the propertyName property is an Array, eq() includes items in which any of the elements of the Array match the specified value.

Method Declaration
Copy
Method Parameters
propertyNamestringRequired

The property whose value will be compared with value. Supported properties:

  • "_id"
  • "_createdDate"
  • "_updatedDate"
  • "lastActivity.activityDate"
  • "primaryInfo.email"
  • "primaryInfo.phone"
  • "info.name.first"
  • "info.name.last"
  • "info.emails.email"
  • "info.phones.phone"
  • "info.addresses.street"
  • "info.addresses.city"
  • "info.addresses.subdivision"
  • "info.addresses.country"
  • "info.company"
  • "info.jobTitle"
  • "info.birthdate"
  • "info.locale"

valueanyRequired

The value to match against.

Returns
Was this helpful?
Yes
No