Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added definition for SC.UserDefaultsDelegate
- Loading branch information
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
// ========================================================================== | ||
// Project: SproutCore - JavaScript Application Framework | ||
// Copyright: ©2017 Turnitin. All rights reserved. | ||
// License: Licensed under MIT license (see license.js) | ||
// ========================================================================== | ||
|
||
/** | ||
@namespace | ||
This defines the UserDefaultsDelegate, used to be notified when a default | ||
is required or an error occurs. | ||
@since SproutCore 1.11.2 | ||
*/ | ||
SC.UserDefaultsDelegate = /** @scope SC.UserDefaultsDelegate */{ | ||
|
||
/** | ||
Called when a value is needed for a user default. | ||
@param {SC.UserDefaults} userDefaults | ||
@param {String} keyName | ||
@param {String} userKeyName | ||
@returns {Object} default for then given key | ||
*/ | ||
userDefaultsNeedsDefault: function(userDefaults, keyName, userKeyName) {}, | ||
|
||
/** | ||
Called when a default's value is changed. | ||
@param {SC.UserDefaults} userDefaults | ||
@param {String} keyName | ||
@param {Object} value | ||
@param {String} userKeyName | ||
@returns {void} | ||
*/ | ||
userDefaultsDidChange: function(userDefaults, keyName, value, userKeyName) {}, | ||
|
||
/** | ||
Called when an error occurs. | ||
@param {SC.UserDefaults} userDefaults | ||
@param {String} keyName | ||
@param {Object} value | ||
@param {String} userKeyName | ||
@param {SC.Error} error | ||
@returns {void} | ||
*/ | ||
userDefaultsDidError: function(userDefaults, keyName, value, userKeyName, error) {} | ||
|
||
}; |