core_message/notification_processor_settings

Load the settings for a message processor.

Source:

message/amd/src/notification_processor_settings.js, line 16

Copyright:

2016 Ryan Wyllie

License:

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Methods

(inner) disableButtons()

Source:

message/amd/src/notification_processor_settings.js, line 161

Disable the buttons in the footer.

(inner) enableButtons()

Source:

message/amd/src/notification_processor_settings.js, line 171

Enable the buttons in the footer.

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

Source:

message/amd/src/notification_processor_settings.js, line 141

Retrieve the current context id, if any.

Returns:

The notification context id

Type: Number | null

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

Source:

message/amd/src/notification_processor_settings.js, line 102

Retrieve the current element, if any.

Returns:

The notification node element.

Type: object | null

(inner) getForm() → {object}

Source:

message/amd/src/notification_processor_settings.js, line 151

Get the form element from the modal.

Returns:

Type: object

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

Source:

message/amd/src/notification_processor_settings.js, line 122

Retrieve the current name, if any.

Returns:

The notification name.

Type: string | null

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

Source:

message/amd/src/notification_processor_settings.js, line 82

Retrieve the current userid, if any.

Returns:

The notification userid

Type: int | null

(inner) hide()

Source:

message/amd/src/notification_processor_settings.js, line 244

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

(inner) loadAllContent() → {object}

Source:

message/amd/src/notification_processor_settings.js, line 222

Load both the title and body content.

Returns:

promise

Type: object

(inner) loadBodyContent() → {object}

Source:

message/amd/src/notification_processor_settings.js, line 195

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

Returns:

A promise resolved with the fragment html and js from

Type: object

(inner) loadTitleContent() → {object}

Source:

message/amd/src/notification_processor_settings.js, line 181

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

Returns:

A promise resolved with the new title text.

Type: object

(inner) registerEventListeners()

Source:

message/amd/src/notification_processor_settings.js, line 293

Set up all of the event handling for the modal.

(inner) setContextId(id)

Source:

message/amd/src/notification_processor_settings.js, line 131

Set the context id to the given value.

Parameters:

Name	Type	Description
`id`	Number	The notification context id

(inner) setElement(element)

Source:

message/amd/src/notification_processor_settings.js, line 92

Set the object to the given value.

Parameters:

Name	Type	Description
`element`	object	The notification node element.

(inner) setName(name)

Source:

message/amd/src/notification_processor_settings.js, line 112

Set the name to the given value.

Parameters:

Name	Type	Description
`name`	string	The notification name.

(inner) setUserId(id)

Source:

message/amd/src/notification_processor_settings.js, line 72

Set the userid to the given value.

Parameters:

Name	Type	Description
`id`	int	The notification userid

(inner) show()

Source:

message/amd/src/notification_processor_settings.js, line 232

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.

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

Source:

message/amd/src/notification_processor_settings.js, line 257

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

Returns:

Type: Promise | boolean