l.r.b.t.TeamMailingListConfigurationView(MailingListTeamBaseView) : class documentation

Part of lp.registry.browser.team View In Hierarchy

A view for creating and configuring a team's mailing list.

Allows creating a request for a list, cancelling the request, setting the welcome message, deactivating, and reactivating the list.

Method __init__ Set feedback messages for users who want to edit the mailing list.
Method save_action Sets the welcome message for a mailing list.
Method cancel_list_creation_validator Validator for the cancel_list_creation action.
Method cancel_list_creation Cancels a pending mailing list registration.
Method create_list_creation_validator Validator for the create_list_creation action.
Method create_list_creation Creates a new mailing list.
Method deactivate_list_validator Adds an error if someone tries to deactivate a non-active list.
Method deactivate_list Deactivates a mailing list.
Method reactivate_list_validator Adds an error if a non-deactivated list is reactivated.
Method reactivate_list Undocumented
Method purge_list_validator Adds an error if the list is not safe to purge.
Method purge_list Undocumented
Method list_is_usable_but_not_contact_method The list could be the contact method for its team, but isn't.
Method mailing_list_status_message A status message describing the state of the mailing list.
Method initial_values The initial value of welcome_message comes from the database.
Method list_application_can_be_cancelled Can this team's mailing list request be cancelled?
Method list_can_be_created Can a mailing list be created for this team?
Method list_can_be_deactivated Is this team's list in a state where it can be deactivated?
Method list_can_be_reactivated Is this team's list in a state where it can be reactivated?
Method list_can_be_purged Is this team's list in a state where it can be purged?

Inherited from MailingListTeamBaseView:

Method getListInState Return this team's mailing list if it's in one of the given states.
Method list_is_usable Checks whether or not the list is usable; ie. accepting messages.
Method mailinglist_address The address for this team's mailing list.
Method _getList Try to find a mailing list for this team.

Inherited from LaunchpadFormView (via MailingListTeamBaseView):

Method initialize Undocumented
Method render Return the body of the response.
Method extendFields Allow subclasses to extend the form fields.
Method setUpFields Undocumented
Method setUpWidgets Set up the widgets using the view's form fields and the context.
Method help_links Dictionary mapping field names to help links.
Method adapters Provide custom adapters for use when setting up the widgets.
Method action_url Set the default action URL for the form.
Method has_available_actions Does the view have any available actions that will render?
Method addError Add a form wide error.
Method getFieldError Get the error associated with a particular field.
Method setFieldError Set the error associated with a particular field.
Static Method validate_none Do not do any validation.
Method validate_widgets Validate the named form widgets.
Method error_count Undocumented
Method ajax_failure_handler Called by the form if validate() finds any errors.
Method validate Validate the form.
Method validate_cancel Noop validation in case we cancel.
Method focusedElementScript Helper function to construct the script element content.
Method isSingleLineLayout Undocumented
Method isMultiLineLayout Undocumented
Method isCheckBoxLayout Undocumented
Method showOptionalMarker Should the (Optional) marker be shown?
Method _processNotifications Add any notification messages to the response headers.
Method _abort Abort the form edit.
Method _validate Check all widgets and perform any custom validation.
def __init__(self, context, request):
Set feedback messages for users who want to edit the mailing list.

There are a number of reasons why your changes to the mailing list might not take effect immediately. First, the mailing list may not actually be set as the team contact address. Second, the mailing list may be in a transitional state: from MODIFIED to UPDATING to ACTIVE can take a while.

@action('Save', 'save')
def save_action(self, action, data):
Sets the welcome message for a mailing list.
def cancel_list_creation_validator(self, action, data):
Validator for the cancel_list_creation action.

Adds an error if someone tries to cancel a request that's already been approved or declined. This can only happen through bypassing the UI.

@action('Cancel Application', 'cancel_list_creation', cancel_list_creation_validator)
def cancel_list_creation(self, action, data):
Cancels a pending mailing list registration.
def create_list_creation_validator(self, action, data):
Validator for the create_list_creation action.

Adds an error if someone tries to create a mailing list for a team that already has one. This can only happen through bypassing the UI.

@action('Create new Mailing List', 'create_list_creation', create_list_creation_validator)
def create_list_creation(self, action, data):
Creates a new mailing list.
def deactivate_list_validator(self, action, data):
Adds an error if someone tries to deactivate a non-active list.

This can only happen through bypassing the UI.

@action('Deactivate this Mailing List', 'deactivate_list', deactivate_list_validator)
def deactivate_list(self, action, data):
Deactivates a mailing list.
def reactivate_list_validator(self, action, data):
Adds an error if a non-deactivated list is reactivated.

This can only happen through bypassing the UI.

@action('Reactivate this Mailing List', 'reactivate_list', reactivate_list_validator)
def reactivate_list(self, action, data):
Undocumented
def purge_list_validator(self, action, data):
Adds an error if the list is not safe to purge.

This can only happen through bypassing the UI.

@action('Purge this Mailing List', 'purge_list', purge_list_validator)
def purge_list(self, action, data):
Undocumented
@property
def list_is_usable_but_not_contact_method(self):
The list could be the contact method for its team, but isn't.

The list exists and is usable, but isn't set as the contact method.

@property
def mailing_list_status_message(self):
A status message describing the state of the mailing list.

This status message helps a user be aware of behind-the-scenes processes that would otherwise manifest only as mysterious failures and inconsistencies.

@property
def initial_values(self):
The initial value of welcome_message comes from the database.
ReturnsA dictionary containing the current welcome message.
@property
def list_application_can_be_cancelled(self):
Can this team's mailing list request be cancelled?

It can only be cancelled if its state is REGISTERED.

@property
def list_can_be_created(self):
Can a mailing list be created for this team?

It can only be requested if there's no mailing list associated with this team, or the mailing list has been purged.

@property
def list_can_be_deactivated(self):
Is this team's list in a state where it can be deactivated?

The list must exist and be in the ACTIVE state.

@property
def list_can_be_reactivated(self):
Is this team's list in a state where it can be reactivated?

The list must exist and be in the INACTIVE state.

@property
def list_can_be_purged(self):
Is this team's list in a state where it can be purged?

The list must exist and be in one of the REGISTERED, DECLINED, FAILED, or INACTIVE states. Further, the user doing the purging, must be an owner, Launchpad administrator or mailing list expert.

API Documentation for Launchpad, generated by pydoctor at 2019-11-13 00:00:10.