An interface for a sandbox library created by the website. More...
import"sbIRemoteLibrary.idl";
Public Member Functions | |
| void | connectToSiteLibrary (in AUTF8String aDomain, in AUTF8String aPath) |
| Connects the remote library to a library from the internal data model. More... | |
 Public Member Functions inherited from sbIRemoteLibrary | |
| sbIMediaItem | createMediaItem (in AString aURL) |
| Create a media item from a URL. More... | |
| sbIRemoteMediaList | createSimpleMediaList (in AString aName, [optional] in AString aSiteID) |
| Create a simple media list. More... | |
| void | createMediaListFromURL (in AString aName, in AString aURL, [optional] in sbICreateMediaListCallback aCallback, [optional] in AString aSiteID) |
| Create a media list from an exising playlist file. More... | |
| void | connectToDefaultLibrary (in AString aLibName) |
| Connect the remote library to the main or web library. More... | |
| sbIRemoteMediaList | getMediaListBySiteID (in AString aSiteID) |
| Get the media list with the given siteID. More... | |
Public Attributes | |
| readonly attribute AString | filename |
| The filename of the library file Set only in debug builds. More... | |
| Public Attributes inherited from sbIRemoteLibrary | |
| attribute boolean | scanMediaOnCreation |
| Control whether or not media is scanned when created. More... | |
| readonly attribute nsISimpleEnumerator | playlists |
| readonly attribute nsIVariant | mostPlayedArtists |
An interface for a sandbox library created by the website.
This interface is used by the player to connect a library to a specific library for a website. The library serves as an area a website can use to create the media items and lists needed to populate web playlists and to transfer into the user's main library. The restrictions on the site library are lighter allowing a website to do more with the limited scope of the site library.
Definition at line 439 of file sbIRemoteLibrary.idl.
| void sbIRemoteSiteLibrary::connectToSiteLibrary | ( | in AUTF8String | aDomain, |
| in AUTF8String | aPath | ||
| ) |
Connects the remote library to a library from the internal data model.
This method is used to create or load the data model library for a specific site's library. The strings passed in follow the format for cookies, in that the domain and path must meet the requirements for RFC 2109. In the case of a bad match, the method fails and no library is hooked up. Any further attempt to access the library will fail.
| aDomain | - The domain, or subdomain for the site library. The requesting website must be on this domain. A site on foo.bar.com may pass in bar.com, but not the other way around. |
| aPath | - The path or subpath for the site library. The requesting site must be on this patch. A site at foo.com/my/path/index.html can pass in '/my/path/', '/my', '/', or ''. In the case of the '/' a root level library is created, accessibel by ALL paths in the domain. In the case of '' the deepest path is used, which would match 'my/path/'. The leading slash MUST be there, except when not passing any path (''). Currently the trailing slash is important, while this will succeed with or without the slash you will get different libraries as a result. This will be fixed – bug 4176 |
| readonly attribute AString sbIRemoteSiteLibrary::filename |
The filename of the library file Set only in debug builds.
Definition at line 445 of file sbIRemoteLibrary.idl.
