l.s.o.b.OAuthAuthorizeTokenView(LaunchpadFormView, JSONTokenMixin) : class documentation

Part of lp.services.oauth.browser View In Hierarchy

Where users authorize consumers to access Launchpad on their behalf.
Method visible_actions Restrict the actions to a subset to be presented to the client.
Method visible_desktop_integration_actions Return all visible actions for DESKTOP_INTEGRATION.
Method unauthorized_action Returns just the action for the UNAUTHORIZED permission level.
Method initialize Undocumented
Method render Return the body of the response.
Method storeTokenContext Store the context given by the consumer in this view.
Method reviewToken Undocumented

Inherited from LaunchpadFormView:

Method __init__ Undocumented
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 initial_values Override this in your subclass if you want any widgets to have
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.

Inherited from JSONTokenMixin:

Method getJSONRepresentation Return a JSON representation of the authorization policy.
@property
def visible_actions(self):
Restrict the actions to a subset to be presented to the client.

Not all client programs can function with all levels of access. For instance, a client that needs to modify the dataset won't work correctly if the end-user only gives it read access. By setting the 'allow_permission' query variable the client program can get Launchpad to show the end-user an acceptable subset of OAuthPermission.

The user always has the option to deny the client access altogether, so it makes sense for the client to ask for the least access possible.

If the client sends nonsensical values for allow_permissions, the end-user will be given a choice among all the permissions used by normal applications.

@property
def visible_desktop_integration_actions(self):
Return all visible actions for DESKTOP_INTEGRATION.
@property
def unauthorized_action(self):
Returns just the action for the UNAUTHORIZED permission level.
def initialize(self):
Undocumented
def render(self):
Return the body of the response.

By default, this method will execute the template attribute to render the content. But if an action handler was executed and it returned a value other than None, that value will be used as the rendered content.

See LaunchpadView.render() for other information.

def storeTokenContext(self):
Store the context given by the consumer in this view.
def reviewToken(self, permission, duration):
Undocumented
API Documentation for Launchpad, generated by pydoctor at 2019-07-19 00:00:17.