sbILibraryUtils Interface Reference

Set of library utilities. More...

import"sbILibraryUtils.idl";

Inheritance diagram for sbILibraryUtils:
[legend]
Collaboration diagram for sbILibraryUtils:
[legend]

Public Member Functions

nsIURI getContentURI (in nsIURI aURI)
 Return a library content URI for the URI specified by aURI. A library content URI is a specially formatted URI for use within Songbird libraries and is formatted to facilitate searching for equivalent URI's (e.g., "file:" URI's are all lower case on Windows). URI's provided to createMediaItem and related methods must be library content URI's. More...
 
nsIURI getFileContentURI (in nsIFile aFile)
 Return a library content URI for the file specified by aFile. Special processing is required to convert an nsIFile to a library content URI (see bug 6227). getFileContentURI must be used instead of nsIIOService.newFileURI for generating library content URI's. More...
 
nsIFile getCanonicalPath (in nsIFile aFile)
 Return the path in a way that is as canonical as possible for the filesystem it resides on; this may include things such as normalizing the case of the file name on case-insensitive filesystems. The result should not be used for comparision (use getFileContentURI for that instead). More...
 

Detailed Description

Set of library utilities.

Definition at line 41 of file sbILibraryUtils.idl.

Member Function Documentation

nsIFile sbILibraryUtils::getCanonicalPath ( in nsIFile  aFile)

Return the path in a way that is as canonical as possible for the filesystem it resides on; this may include things such as normalizing the case of the file name on case-insensitive filesystems. The result should not be used for comparision (use getFileContentURI for that instead).

Parameters
aFileFile for which to normalize the path.
Returns
Normalized path.
nsIURI sbILibraryUtils::getContentURI ( in nsIURI  aURI)

Return a library content URI for the URI specified by aURI. A library content URI is a specially formatted URI for use within Songbird libraries and is formatted to facilitate searching for equivalent URI's (e.g., "file:" URI's are all lower case on Windows). URI's provided to createMediaItem and related methods must be library content URI's.

Parameters
aURIURI for which to get content URI.
Returns
Library content URI.
nsIURI sbILibraryUtils::getFileContentURI ( in nsIFile  aFile)

Return a library content URI for the file specified by aFile. Special processing is required to convert an nsIFile to a library content URI (see bug 6227). getFileContentURI must be used instead of nsIIOService.newFileURI for generating library content URI's.

Parameters
aFileFile for which to get content URI.
Returns
Library content URI.

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