[This is preliminary documentation and subject to change.]
Returns a unique ID for this provider, no longer than 24 characters.
Namespace: MediaMallTechnologies.Plugin
Assembly: Util (in Util.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| ReadOnly Property ID As String |
| C# |
|---|
| string ID { get; } |
| C++ |
|---|
| property string ID abstract { String get(); } |
| J# |
|---|
| /** property */ public string get_ID(); |
| JScript |
|---|
| public function get ID() : String |
Property Value
The string ID for this root level plugin, no longer than 24 characters.
Remarks
The ID for a plugin should preferably be a combination of the unique domain namespace for the creator of the plugin and the human-readable name of the plugin, in all lower case and without spaces, and with a maximum of 24 characters. This ID must be prepended to all media and folder ID's, followed by a hyphen, and postpended with GUID's, as in pluginname-guid.
Note that since the suggested plugin ID's are human readable, there is always a risk of name clashes with other plugins, so be sure to choose an ID that you are confident is "unique", but no longer than 24 characters.
Example
A plugin named "My Plugin" created by "example.com" could have a root level ID of "example.myplugin", and all sub-items and sub-folders with ID's as "example.myplugin-GUID".