Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIInstallLocation Interface Reference

Interface representing a location where extensions, themes etc are installed. More...

import "nsIExtensionManager.idl";

Inheritance diagram for nsIInstallLocation:
Inheritance graph
[legend]
Collaboration diagram for nsIInstallLocation:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIFile getItemLocation (in AString id)
 Gets the directory that contains an item.
AString getIDForLocation (in nsIFile file)
 Retrieves the GUID for an item at the specified location.
nsIFile getItemFile (in AString id, in AString path)
 Gets a nsIFile object for a file within an item's directory structure.
boolean itemIsManagedIndependently (in AString id)
 Determines whether or not an item's resources are managed by the Extension System or by some other user or process.

Public Attributes

readonly attribute AString name
 The string identifier of this Install Location.
readonly attribute
nsIDirectoryEnumerator 
itemLocations
 An enumeration of nsIFiles for:
readonly attribute nsIFile location
 The file system location where items live.
readonly attribute boolean restricted
 Whether or not this Install Location is on an area of the file system that could be restricted on a restricted-access account, regardless of whether or not the location is restricted with the current user privileges.
readonly attribute boolean canAccess
 Whether or not the user can write to the Install Location with the current access privileges.
const unsigned long PRIORITY_APP_PROFILE = 0
 Constants representing priority of some default Install Locations.
const unsigned long PRIORITY_APP_SYSTEM_USER = 10
const unsigned long PRIORITY_XRE_SYSTEM_USER = 100
const unsigned long PRIORITY_APP_SYSTEM_GLOBAL = 1000
const unsigned long PRIORITY_XRE_SYSTEM_GLOBAL = 10000
readonly attribute long priority
 The priority level of this Install Location in loading.

Detailed Description

Interface representing a location where extensions, themes etc are installed.

Definition at line 56 of file nsIExtensionManager.idl.


Member Function Documentation

Retrieves the GUID for an item at the specified location.

Parameters:
fileThe location where an item might live.
Returns:
The ID for an item that might live at the location specified.

N.B. This function makes no promises about whether or not this path is actually maintained by this Install Location.

nsIFile nsIInstallLocation::getItemFile ( in AString  id,
in AString  path 
)

Gets a nsIFile object for a file within an item's directory structure.

Parameters:
idThe GUID of the item.
pathThe path to the file beneath an Extension's directory
Returns:
A file object at the requested location. The file does not necessarily have to exist.

Gets the directory that contains an item.

Parameters:
idThe GUID of the item.
Returns:
The location of the item.

Determines whether or not an item's resources are managed by the Extension System or by some other user or process.

For example, items linked to by text links are managed by the user, and items linked to from Registry Install Locations are usually managed by other applications or installers.

Parameters:
idThe GUID of the item.
Returns:
true if the item's resources are managed independently of the Extension System, false otherwise.

Member Data Documentation

Whether or not the user can write to the Install Location with the current access privileges.

This is different from restricted because it's not whether or not the location might be restricted, it's whether or not it actually is restricted right now.

Definition at line 95 of file nsIExtensionManager.idl.

An enumeration of nsIFiles for:

  • locations that contain items
  • potential dropped-in XPIs Note: This enumeration resolves Text Links to the directories they refer to.

Definition at line 70 of file nsIExtensionManager.idl.

The file system location where items live.

Items can be dropped in at this location. Can be null for Install Locations that don't have a file system presence. Note: This is a clone of the actual location which the caller can modify freely.

Definition at line 79 of file nsIExtensionManager.idl.

The string identifier of this Install Location.

Definition at line 61 of file nsIExtensionManager.idl.

The priority level of this Install Location in loading.

Definition at line 116 of file nsIExtensionManager.idl.

Constants representing priority of some default Install Locations.

XXXben - priority ranking of user-level items vs. global-level items here is debatable. Should app-system-global trump xre-system-user? You should not use the exact values here, you should offset from these values each time you create a new Install Location. Offsetting can be brittle but you should know what Install Locations are being defined for your own application.

Definition at line 107 of file nsIExtensionManager.idl.

Definition at line 110 of file nsIExtensionManager.idl.

Definition at line 108 of file nsIExtensionManager.idl.

Definition at line 111 of file nsIExtensionManager.idl.

Definition at line 109 of file nsIExtensionManager.idl.

Whether or not this Install Location is on an area of the file system that could be restricted on a restricted-access account, regardless of whether or not the location is restricted with the current user privileges.

Definition at line 87 of file nsIExtensionManager.idl.


The documentation for this interface was generated from the following file: