net.i2p.app

Interface NavService

All Known Implementing Classes:

NavHelper

public interface NavService

Service to put links on the console. Here so webapps can use it without dependency on console.

Method Summary

Modifier and Type	Method and Description
void	registerApp(String appName, String displayName, String path, String tooltip, String iconpath) To register a new client application so that it shows up on the router console's nav bar, it should be registered with this singleton.
void	unregisterApp(String name)

Method Detail

registerApp

void registerApp(String appName,
                 String displayName,
                 String path,
                 String tooltip,
                 String iconpath)

To register a new client application so that it shows up on the router console's nav bar, it should be registered with this singleton.

Parameters:

appName - standard name for the app (plugin)

displayName - translated name the app will be called in the link warning, this is the display name aka ConsoleLinkName, not the plugin name

path - full path pointing to the application's root (e.g. /i2ptunnel/index.jsp), non-null

tooltip - HTML escaped text or null

iconpath - path-only URL starting with /, HTML escaped, or null

unregisterApp

void unregisterApp(String name)

Parameters:

name - standard name for the app