Skip to content

Commit

Permalink
Added definition for SC.UserDefaultsDelegate
Browse files Browse the repository at this point in the history
  • Loading branch information
jameschao committed Jan 6, 2017
1 parent 33bda7c commit 45cc195
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions frameworks/foundation/delegates/user_defaults.js
@@ -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) {}

};

0 comments on commit 45cc195

Please sign in to comment.