Zimlet JavaScript API Reference - ZmSignatureCollection

Class ZmSignatureCollection


Extends ZmModel.

This class represents a signature collection.

Defined in: ZmSignatureCollection.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a signature collection.
Method Summary
Method Attributes Method Name and Description
 
add(signature)
Adds the signature.
 
getById(id)
Gets the signature by id.
 
getByName(name)
Gets the signature by name.
 
Gets the signatures.
 
Gets the count of signatures.
 
remove(signature)
Removes the signature.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmSignatureCollection()
Creates a signature collection.
Method Detail
add(signature)
Adds the signature.
Parameters:
{ZmSignature} signature
the signature to add

{ZmSignature} getById(id)
Gets the signature by id.
Parameters:
{String} id
the signature
Returns:
{ZmSignature} the signature

{ZmSignature} getByName(name)
Gets the signature by name.
Parameters:
{String} name
the signature
Returns:
{ZmSignature} the signature

{Array} getSignatures(sort)
Gets the signatures.
Parameters:
sort
Returns:
{Array} an array of ZmSignature objects

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

remove(signature)
Removes the signature.
Parameters:
{ZmSignature} signature
the signature to remove

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