Class ActionCenterListener
ActionCenters listener.
Defined in: Utility.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Default constructor.
|
| Method Attributes | Method Name and Description |
|---|---|
|
destroy()
Unsubscribes from all channels on which this listener has been registered.
|
|
|
getAllSubordinates(contributionId, relationshipType, objectToCall, methodToCall, loadMonitor, miniMessage)
Gets contributions of all types, which are subordinate to the specified contribution with the
specified relationship type.
|
|
|
getContributionDelete(contributionId, objectToCall, methodToCall)
Subscribes to the channel to listen for the delete of the specified contribution.
|
|
|
getContributionPropertyDelete(contributionId, propertyName, objectToCall, methodToCall)
Subscribes to the channel of contribution property deletion for the specified contribution and the specified
property.
|
|
|
getContributionPropertyUpdates(contributionId, propertyName, objectToCall, methodToCall)
Subscribes to the channel of contribution property updates for the specified contribution and the specified
property.
|
|
|
getContributionUpdates(contributionId, objectToCall, methodToCall)
Subscribes to the channel of contribution updates for the specified contribution.
|
|
|
getSubordinates(contributionId, relationshipType, subordinateType, addObjectToCall, addMethodToCall, createOneIfNoneExists, removeObjectToCall, removeMethodToCall, loadMonitor, miniMessage, createOneMode)
Registers a callback function which will be invoked once for each contribution which matches the type and relationship to the superior contribution.
|
|
|
getThumbprints(contributionId, objectToCall, methodToCall)
Subscribes to the channel to listen for thumbprints on the specified contribution.
|
|
|
getUserUpdates(systemRoles, objectToCall, methodToCall, removeObjectToCall, removeMethodToCall)
Subscribes to listen for users in a given system role.
|
|
|
monitorRelationship(superiorId, relationshipType, subordinateId, addObjectToCall, addMethodToCall, removeObjectToCall, removeMethodToCall)
Monitors a relationship with the specified criteria.
|
|
|
Unsubscribes from the thumbprint channel.
|
Method Detail
destroy()
Unsubscribes from all channels on which this listener has been registered. This function should be called by
this ActionCenterListener's owning object destroy function.
- Returns:
- void
getAllSubordinates(contributionId, relationshipType, objectToCall, methodToCall, loadMonitor, miniMessage)
Gets contributions of all types, which are subordinate to the specified contribution with the
specified relationship type. Registers a callback function which will be invoked once for each contribution of any type and the provided relationship
to the superior contribution. The callback function will also be called for each contribution which is added that matches the type and relationship
to the superior contribution.
- Parameters:
- {String} contributionId
- The id of the superior contribution.
- {String} relationshipType
- The type of the relationship.
- {Object} objectToCall
- Callback object to invoke after addition of the relationship.
- {String} methodToCall
- Callback method to invoke after addition of the relationship.
- {AC.data.LoadMonitor} loadMonitor Optional
- Load monitor to monitor the initial loading of a tree.
- {Boolean} miniMessage Optional
- Exclude properties, dates, and locked by information from the callback message. This is useful for contribution counters. Default value is false.
- Returns:
- void
getContributionDelete(contributionId, objectToCall, methodToCall)
Subscribes to the channel to listen for the delete of the specified contribution.
- Parameters:
- {String} contributionId
- The id of the contribution.
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- Returns:
- void
getContributionPropertyDelete(contributionId, propertyName, objectToCall, methodToCall)
Subscribes to the channel of contribution property deletion for the specified contribution and the specified
property.
- Parameters:
- {String} contributionId
- The id of the contribution.
- {String} propertyName
- the name of the property
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- Returns:
- void
getContributionPropertyUpdates(contributionId, propertyName, objectToCall, methodToCall)
Subscribes to the channel of contribution property updates for the specified contribution and the specified
property.
- Parameters:
- {String} contributionId
- The id of the contribution.
- {String} propertyName
- the name of the property
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- Returns:
- void
getContributionUpdates(contributionId, objectToCall, methodToCall)
Subscribes to the channel of contribution updates for the specified contribution.
- Parameters:
- {String} contributionId
- The id of the contribution.
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- Returns:
- void
getSubordinates(contributionId, relationshipType, subordinateType, addObjectToCall, addMethodToCall, createOneIfNoneExists, removeObjectToCall, removeMethodToCall, loadMonitor, miniMessage, createOneMode)
Registers a callback function which will be invoked once for each contribution which matches the type and relationship to the superior contribution. The
callback function will also be called for each contribution which is added that matches the type and relationship to the superior contribution. If a remove
object and method is provided, a callback to that function will be invoked whenever a contribution matching the type and relationship to the superior contribution
is deleted.
- Parameters:
- {String} contributionId
- The id of the superior contribution.
- {String} relationshipType
- The type of the relationship.
- {String} subordinateType
- The type of the subordinate contribution.
- {Object} addObjectToCall
- Callback object to invoke after addition of the relationship.
- {String} addMethodToCall
- Callback method to invoke after addition of the relationship.
- {Boolean} createOneIfNoneExists Optional
- Boolean flag to indicate whether to create a subordinate contribution if none has been found.
- {Object} removeObjectToCall Optional
- Callback object to invoke after removal of the relationship.
- {String} removeMethodToCall Optional
- Callback method to invoke after removal of the relationship.
- {AC.data.LoadMonitor} loadMonitor Optional
- Load monitor to monitor the initial loading of a tree.
- {Boolean} miniMessage Optional
- Exclude properties, dates, and locked by information from the callback message. This is useful for contribution counters. Default value is false.
- {String} createOneMode Optional
- If this is 'project', then setting createOneIfNoneExists to true will create a subordinate project.
- Returns:
- void
getThumbprints(contributionId, objectToCall, methodToCall)
Subscribes to the channel to listen for thumbprints on the specified contribution.
- Parameters:
- {String} contributionId
- The id of the contribution.
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- Returns:
- void
getUserUpdates(systemRoles, objectToCall, methodToCall, removeObjectToCall, removeMethodToCall)
Subscribes to listen for users in a given system role.
- Parameters:
- {String[]} systemRoles
- The array of system roles.
- {Object} objectToCall
- Callback object to invoke for each update to the contribution.
- {String} methodToCall
- Callback method to invoke for each update to the contribution.
- removeObjectToCall
- removeMethodToCall
- Returns:
- void
monitorRelationship(superiorId, relationshipType, subordinateId, addObjectToCall, addMethodToCall, removeObjectToCall, removeMethodToCall)
Monitors a relationship with the specified criteria.
- Parameters:
- {String} superiorId
- The id of the superior contribution.
- {String} relationshipType
- The type of the relationship.
- {String} subordinateId
- The subordinate id.
- {Object} addObjectToCall
- Callback object to invoke after addition of the relationship.
- {String} addMethodToCall
- Callback method to invoke after addition of the relationship.
- {Object} removeObjectToCall Optional
- Callback object to invoke after removal of the relationship.
- {String} removeMethodToCall Optional
- Callback method to invoke after removal of the relationship.
- Returns:
- void
unsubscribeThumbprints()
Unsubscribes from the thumbprint channel.
- Returns:
- void