Zimlet JavaScript API Reference - ZmIdentityCollection

Class ZmIdentityCollection


Extends ZmModel.

This class represents the identity collection

Defined in: ZmIdentityCollection.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates the identity collection.
Method Summary
Method Attributes Method Name and Description
 
add(identity)
Adds the identity to the collection.
 
getById(id)
Gets the identity by id.
 
getByName(name)
Gets the identity by name.
 
Gets the identities.
 
Gets the count of identities.
 
remove(identity)
Removes the identity from the collection.
 
try to find the persona to use from the rules defined in the accounts settings.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmIdentityCollection()
Creates the identity collection.
Method Detail
add(identity)
Adds the identity to the collection.
Parameters:
{ZmIdentity} identity
the identity

{ZmIdentity} getById(id)
Gets the identity by id.
Parameters:
{String} id
the identity id
Returns:
{ZmIdentity} the identity

{ZmIdentity} getByName(name)
Gets the identity by name.
Parameters:
{String} name
the identity name
Returns:
{ZmIdentity} the identity

{Array} getIdentities(sort)
Gets the identities.
Parameters:
{Object} sort
(not used)
Returns:
{Array} an array of {ZmIdentity} objects

{int} getSize()
Gets the count of identities.
Returns:
{int} the size

remove(identity)
Removes the identity from the collection.
Parameters:
{ZmIdentity} identity
the identity

{*} selectIdentityFromFolder(folderId)
try to find the persona to use from the rules defined in the accounts settings. Recurse to parent so to apply rules to sub-folders too.
Parameters:
folderId
Returns:
{*}

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