Modules Service
Last updated
Last updated
A module is a new window inside the Symphony client workspace, such as a chatroom or an instant message. Use the modules
service to create application-specific modules.
The following methods are available on the modules
service:
Show a new application module:
Hide an existing application module:
Change the title of an existing application module:
Note that this only changes the title of a specific module, not all titles of all modules created by the application.
Focus an existing application module:
Opens a link from your application in a new tab in the user's default browser. This method should be used to open links, rather than <a href="..." target="_blank">...</a>
.
Reloads the content of the module at the new URL.
The Client Extensions API is designed for single-page applications. Use this method with multi-page applications to load new content when users navigate to another page:
Parameter
Type
Description
id
String
A unique id for this module (must be unique across all modules of a given application)
Either title
or {title, icon}
String or Object
Either the title of the module as a string
or an object with the keys title
and icon
The value of title
is a string
The value of icon
is the url of a square SVG image (recommended), or the url of a square png/jpg image. Recommended size is 32x32.
serviceName
String
The name of a local service implemented by your application that will be invoked when a user action is performed relating to this module
iframe
String
The URL for the content of the module (must be an HTTPS URL)
options
Object
An object, which can contain:
canFloat
: if set to true, a menu item will be added to the More menu (found under the (…) on the module frame) that, when clicked, will pop the module out into its own browser window
parentModuleId
: if set to the ID of a module opened by an application, the specified module will not be closed when this module is shown
Parameter
Type
Description
id
String
The id of the module that should be hidden.
Parameters
Type
Description
id
String
The id of the module for which the title should be changed
Either title
or {title, icon}
String or Object
Either the title of the module as a string
or an object with the keys title
and icon
The value of title
is a string
The value of icon
is the url of a square SVG image (recommended), or the url of a square png/jpg image. Recommended size is 32x32.
Parameter
Type
Description
id
String
The id of the module to focus
Parameter
Type
Description
url
String
The URL to be opened
Parameter
Type
Description
id
String
The unique identifier for the module. A module with this id must already exist.
url
String
The URL of the new iframe to load in the module.