Class eclipse.sites.SiteService
Defines and implements a service that provides access to the server API for managing site
configurations.
Defined in: </shared/eclipse/e4/orion/I201105191253/plugins/org.eclipse.orion.client.core/static/js/sites/siteService.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
eclipse.sites.SiteService(serviceRegistry)
Constructs a new SiteService.
|
| Method Attributes | Method Name and Description |
|---|---|
|
createSiteConfiguration(name, workspace, mappings, hostHint)
Creates a site configuration.
|
|
|
deleteSiteConfiguration(locationUrl)
Deletes a site configuration.
|
|
|
Retrieves all site configurations defined by the logged-in user.
|
|
|
loadSiteConfiguration(Location)
Loads an individual site configuration from the given location.
|
|
| <inner> |
SiteService(serviceRegistry)
|
|
updateSiteConfiguration(locationUrl, updatedSiteConfig)
Edits an existing site configuration.
|
Class Detail
eclipse.sites.SiteService(serviceRegistry)
Constructs a new SiteService.
- Parameters:
- {eclipse.ServiceRegistry} serviceRegistry
- The service registry to register ourself with.
- Requires:
- auth.js
Method Detail
{dojo.Deferred}
createSiteConfiguration(name, workspace, mappings, hostHint)
Creates a site configuration.
- Returns:
- {dojo.Deferred} A deferred for the result. Will be resolved with the created eclipse.sites.SiteConfiguration on success.
{dojo.Deferred}
deleteSiteConfiguration(locationUrl)
Deletes a site configuration.
- Parameters:
- {String} locationUrl
- Location of the site configuration resource to be deleted.
- Returns:
- {dojo.Deferred} A deferred for the result. Will be resolved with no argument on success.
{dojo.Deferred}
getSiteConfigurations()
Retrieves all site configurations defined by the logged-in user.
- Returns:
- {dojo.Deferred} A deferred for the result. Will be resolved with the argument Array on success, where each element of the array is a eclipse.sites.SiteConfiguration.
{dojo.Deferred}
loadSiteConfiguration(Location)
Loads an individual site configuration from the given location.
- Parameters:
- {String} Location
- URL of a site configuration resource.
- Returns:
- {dojo.Deferred} A deferred for the result. Will be resolved with the loaded eclipse.sites.SiteConfiguration on success.
<inner>
SiteService(serviceRegistry)
- Parameters:
- serviceRegistry
{dojo.Deferred}
updateSiteConfiguration(locationUrl, updatedSiteConfig)
Edits an existing site configuration.
- Parameters:
- {String} locationUrl
- Location of the site configuration resource to be updated.
- {eclipse.sites.SiteConfiguration} updatedSiteConfig
- A representation of the updated site. Properties that are not changing may be omitted.
- Returns:
- {dojo.Deferred} A deferred for the result. Will be resolved with the updated eclipse.sites.SiteConfiguration on success.