core_message/notification_processor_settings

Description:

  • Load the settings for a message processor.

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

Load the settings for a message processor.

Methods

(inner) disableButtons()

Description:

  • Disable the buttons in the footer.

Source:

(inner) enableButtons()

Description:

  • Enable the buttons in the footer.

Source:

(inner) getContextId() → {Number|null}

Description:

  • Retrieve the current context id, if any.

Source:
Returns:

The notification context id

Type
Number | null

(inner) getElement() → {object|null}

Description:

  • Retrieve the current element, if any.

Source:
Returns:

The notification node element.

Type
object | null

(inner) getForm() → {object}

Description:

  • Get the form element from the modal.

Source:
Returns:
Type
object

(inner) getName() → {string|null}

Description:

  • Retrieve the current name, if any.

Source:
Returns:

The notification name.

Type
string | null

(inner) getUserId() → {int|null}

Description:

  • Retrieve the current userid, if any.

Source:
Returns:

The notification userid

Type
int | null

(inner) hide()

Description:

  • Clear the notification from the modal when it's closed so that it is loaded fresh next time it's displayed.

Source:

(inner) loadAllContent() → {object}

Description:

  • Load both the title and body content.

Source:
Returns:

promise

Type
object

(inner) loadBodyContent() → {object}

Description:

  • Load the body for the modal to the appropriate value depending on message outputs.

Source:
Returns:

A promise resolved with the fragment html and js from

Type
object

(inner) loadTitleContent() → {object}

Description:

  • Load the title for the modal to the appropriate value depending on message outputs.

Source:
Returns:

A promise resolved with the new title text.

Type
object

(inner) registerEventListeners()

Description:

  • Set up all of the event handling for the modal.

Source:

(inner) setContextId(id)

Description:

  • Set the context id to the given value.

Source:
Parameters:
Name Type Description
id Number

The notification context id

(inner) setElement(element)

Description:

  • Set the object to the given value.

Source:
Parameters:
Name Type Description
element object

The notification node element.

(inner) setName(name)

Description:

  • Set the name to the given value.

Source:
Parameters:
Name Type Description
name string

The notification name.

(inner) setUserId(id)

Description:

  • Set the userid to the given value.

Source:
Parameters:
Name Type Description
id int

The notification userid

(inner) show()

Description:

  • Load the modal content before showing it. This is to allow us to re-use the same modal for creating and editing different message outputs within the page.

Source:

(inner) updateConfiguredStatus() → {Promise|boolean}

Description:

  • Checks if the processor has been configured. If so then remove the unconfigured status from the interface.

Source:
Returns:
Type
Promise | boolean