Class orion.sites.SiteService
Interface for a service that manages site configurations.
Defined in: </shared/eclipse/e4/orion/I201306251555/plugins/org.eclipse.orion.client.ui/web/orion/sites/siteClient.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
convertToSelfHosting(site)
|
|
createSiteConfiguration(name, workspace, mappings, hostHint)
Creates a site configuration.
|
|
deleteSiteConfiguration(locationUrl)
Deletes a site configuration.
|
|
getMappingObject(site, fileLocation, virtualPath)
|
|
getMappingProposals(site)
|
|
Retrieves all site configurations defined by the logged-in user.
|
|
getURLOnSite(site, file)
|
|
isSelfHostingSite(site)
|
|
loadSiteConfiguration(locationUrl)
Loads an individual site configuration from the given location.
|
|
parseInternalForm(site, displayString)
|
|
toFileLocation(internalPath)
|
|
toInternalForm(fileLocation)
|
|
updateSiteConfiguration(locationUrl, updatedSiteConfig)
Edits an existing site configuration.
|
Method Detail
{orion.sites.SiteConfiguration}
convertToSelfHosting(site)
- Parameters:
- {orion.sites.SiteConfiguration} site
- Returns:
- {orion.sites.SiteConfiguration}
{orion.sites.SiteConfiguration}
createSiteConfiguration(name, workspace, mappings, hostHint)
Creates a site configuration.
- Returns:
- {orion.sites.SiteConfiguration} The created site configuration.
{void}
deleteSiteConfiguration(locationUrl)
Deletes a site configuration.
- Parameters:
- {String} locationUrl
- Location of the site configuration resource to be deleted.
- Returns:
- {void}
{Object}
getMappingObject(site, fileLocation, virtualPath)
- Parameters:
- {orion.sites.SiteConfiguration} site
- {String} fileLocation
- {String} virtualPath
- Returns:
- {Object}
{String[]}
getMappingProposals(site)
- Parameters:
- {orion.sites.SiteConfiguration} site
- Returns:
- {String[]}
{orion.sites.SiteConfiguration[]}
getSiteConfigurations()
Retrieves all site configurations defined by the logged-in user.
- Returns:
- {orion.sites.SiteConfiguration[]} The site configurations.
{String}
getURLOnSite(site, file)
- Parameters:
- {orion.sites.SiteConfiguration} site
- {Object} file
- Returns:
- {String}
{Boolean}
isSelfHostingSite(site)
- Parameters:
- {orion.sites.SiteConfiguration} site
- Returns:
- {Boolean}
{orion.sites.SiteConfiguration}
loadSiteConfiguration(locationUrl)
Loads an individual site configuration from the given location.
- Parameters:
- {String} locationUrl
- Location URL of a site configuration resource.
- Returns:
- {orion.sites.SiteConfiguration} The loaded site configuration.
{String}
parseInternalForm(site, displayString)
- Parameters:
- {orion.sites.SiteConfiguration} site
- {String} displayString
- Returns:
- {String}
{String}
toFileLocation(internalPath)
- Parameters:
- {String} internalPath
- Returns:
- {String}
{String}
toInternalForm(fileLocation)
- Parameters:
- {String} fileLocation
- Returns:
- {String}
{orion.sites.SiteConfiguration}
updateMappingsDisplayStrings(site)
- Parameters:
- {orion.sites.SiteConfiguration} site
- Returns:
- {orion.sites.SiteConfiguration}
{orion.sites.SiteConfiguration}
updateSiteConfiguration(locationUrl, updatedSiteConfig)
Edits an existing site configuration.
- Parameters:
- {String} locationUrl
- Location of the site configuration resource to be updated.
- {orion.sites.SiteConfiguration} updatedSiteConfig
- A representation of the updated site. Properties that are not changing may be omitted.
- Returns:
- {orion.sites.SiteConfiguration} The updated site configuration.