Links

Links

class hyperadmin.links.Link(url, endpoint, method='GET', prompt=None, description=None, form=None, form_class=None, form_kwargs=None, on_submit=None, errors=None, link_factor=None, include_form_params_in_url=False, mimetype=None, descriptors=None, template_name='link.html', cu_headers=None, cr_headers=None, **cl_headers)

A link in the broad hypermedia sense

api_request

resource

state

site

rel

classes

get_base_url()

clone_into_links()

get_absolute_url()

The url for this link

mimetype_is_audio()

mimetype_is_image()

mimetype_is_video()

get_link_factor()

Returns a two character representation of the link factor.

• LI - Idempotent
• LN - Non-Idempotent
• LT - Templated link
• LO - Outbound link
• LI - Embedded link

is_simple_link

Returns True if this link is simply to be followed

method

The HTTP method of the link

class_attr()

get_form_kwargs(**form_kwargs)

get_form(**form_kwargs)

form

Returns the active form for the link. Returns None if there is no form.

errors

Returns the validation errors belonging to the form

submit(**kwargs)

Returns a link representing the result of the action taken. The resource_item of the link may represent the updated/created object or in the case of a collection resource item you get access to the filter items

follow()

Follows the link to the endpoint in a subrequest Returns a link representing the endpoint response

clone(**kwargs)

get_context_data(**kwargs)

get_template_names()

expand_template_names(suffixes)

get_context_instance()

render(**kwargs)

LinkCollection

class hyperadmin.links.LinkCollection(endpoint)

link_prototypes

add_link(link_name, **kwargs)

Adds the specified link from the resource. This will only add the link if it exists and the person is allowed to view it.

LinkPrototype

class hyperadmin.links.LinkPrototype(endpoint, name, link_kwargs={})

Incapsulates logic related to a link. This class is responsible for:

• creating link
• handling link submission
• controlling link visibility

resource

state

common_state

api_request

show_link(**kwargs)

Checks the state and returns False if the link is not active.

Return type:boolean

get_link_description()

get_form_class()

get_form_kwargs(**kwargs)

Return type:dict

get_link_kwargs(**kwargs)

Return type:dict

get_link_class()

get_link(**link_kwargs)

Creates and returns the link

Return type:Link

handle_submission(link, submit_kwargs)

Called when the link is submitted. Returns a link representing the response.

Return type:Link

on_success(item=None)

Returns a link for a successful submission

Return type:Link

get_url(**kwargs)

get_url_name()