Methods

Name Type Description
$link.blog() String

The relative link to the blog in the current space, or #notfound if the space could not be found or blog posts are not enabled, or null if the user does not have the necessary permissions.

$link.page(pageTitle) String

The link (relative if possible) to the page with the specified title in the same space, or #notfound if the page could not be found, or null if the current user does not have view permissions.

Parameter Type Description
pageTitle String The title of the page.
$link.page(spaceKey, pageTitle) String

The link (relative if possible) to the page with the specified title, or #notfound if the page could not be found, or null if the current user does not have view permissions.

Parameter Type Description
spaceKey String The key of the space where the page is located.
pageTitle String The title of the page.
$link.space(spaceKey) String

The link (relative if possible) to the home page of the specified space, or #notfound if the space could not be found or does not have a home page, or null if the current user does not have view permissions.

Parameter Type Description
spaceKey String The key of the space to link to.
$link.to Link

This helper object. Allows syntactic enhancements like $link.to.page("My Page") instead of $link.page("My Page").