Zimlet JavaScript API Reference - ZmAutocompleteMatch

Class ZmAutocompleteMatch


This class represents an auto-complete result, with fields for the caller to look at, and fields to help with further matching.

Defined in: ZmAutocomplete.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAutocompleteMatch(match, options, isContact, str)
Creates an auto-complete match.
Method Summary
Method Attributes Method Name and Description
 
matches(str)
Matches the given string to this auto-complete result.
 
setContactGroupMembers(groupId, callback)
Sets the email & fullAddress properties of a contact group
 
Returns a string representation of the object.
Class Detail
ZmAutocompleteMatch(match, options, isContact, str)
Creates an auto-complete match.
Parameters:
{Object} match
the JSON match object or a ZmContact object
{Object} options
the matching options
{Boolean} isContact
if true, provided match is a ZmContact
str
Method Detail
{Boolean} matches(str)
Matches the given string to this auto-complete result.
Parameters:
{String} str
the string
Returns:
{Boolean} true if the given string matches this result

setContactGroupMembers(groupId, callback)
Sets the email & fullAddress properties of a contact group
Parameters:
groupId
{String} contact group id to lookup from cache
callback
{AjxCallback} callback to be run

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:38 GMT-0400 (EDT)