Zimlet JavaScript API Reference - ZmContactsHelper

Class ZmContactsHelper


Miscellaneous contacts-related utility functions. So far, mostly things that ZmContactPicker and ZmGroupView both need to perform a contacts search and display results in a list view.

Defined in: ZmContactsHelper.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Default constructor for helper class.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmContactsHelper.search(params)
Performs a contact search (in either personal contacts or in the GAL) and populates the source list view with the results.
Class Detail
ZmContactsHelper()
Default constructor for helper class.
Author: Conrad Damon.
Method Detail
<static> ZmContactsHelper.search(params)
Performs a contact search (in either personal contacts or in the GAL) and populates the source list view with the results.
Parameters:
{Hash} params
a hash of parameters
{Object} params.obj
the object that is doing the search
{String} params.query
the query string to search on
{String} params.queryHint
the query hint (i.e. searching shared folders)
{Boolean} params.ascending
if true, sort in ascending order
{int} params.lastId
the ID of last item displayed (for pagination)
{String} params.lastSortVal
the value of sort field for above item
{AjxCallback} params.respCallback
the callback to call once response comes back from server
{AjxCallback} params.errorCallback
the callback to call if error returned from server
{String} params.accountName
the account to make search request on behalf of
{Array} params.conds
the conds to restrict the search by (array of {attr:"", op:"", value:""} hashes)

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