core_message/notification_preference

Description:

  • Controls the preference for an individual notification type on the message preference page.

Source:
Copyright:
  • 2016 Ryan Wyllie
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Controls the preference for an individual notification type on the message preference page.

Methods

(inner) getEnabledPreferenceKey() → {string}

Description:

  • Get the unique key for the enabled preference.

Source:
Returns:
Type
string

(inner) getPreferenceKey() → {string}

Description:

  • Get the unique prefix key that identifies this user preference.

Source:
Returns:
Type
string

(inner) getProcessors() → {array}

Description:

  • Get the list of Processors available for this preference.

Source:
Returns:
Type
array

(inner) isLoading() → {Boolean}

Description:

  • Check if the preference is loading.

Source:
Returns:
Type
Boolean

(inner) save() → {object}

Description:

  • Persist the current state of the processors for this preference.

Source:
Returns:

jQuery promise

Type
object

(inner) startLoading()

Description:

  • Flag the preference as loading.

Source:

(inner) stopLoading()

Description:

  • Remove the loading flag for this preference.

Source: