|
|
The FileProtocolPlugin type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
FileProtocolPlugin |
Default constructor.
|
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
|
|
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetFile |
Downloads a remote URI to a local path.
|
|
|
GetFileInfo |
Returns information about a URI.
|
|
|
GetFileToCache |
Downloads a remote URI to the protocols internal cache.
|
|
|
GetHashCode |
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
|
|
GetString |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
GetStringSafe |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
GetType |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
IsSelfEnabled |
Called once to determines if the plugin is enabled.
Only called if PluginRecord.SupportsIsSelfEnabled is true
(Inherited from Plugin.) |
|
|
MemberwiseClone |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
OnLoaded |
Called once immediately after the plugin has been loaded (created).
Plugins are loaded on demand so this may be some time after application startup.
Default implementation does nothing.
This is a good place to subscribe to API events.
(Inherited from Plugin.) |
|
|
OnUnloading |
Called once just before the plugin is unloaded. If the plugin implements
IDisposable, then
Dispose will be called immediately after the plugin is unloaded.
Plugins are typically unloaded at application shutdown or when the end user has disabled a plugin.
Default implementation does nothing.
This is a good place to unsubscribe from API events.
(Inherited from Plugin.) |
|
|
OpenFile |
Directly opens a URI.
|
|
|
PutFile |
Uploads a file to a remote URI.
|
|
|
ToString | (Inherited from Object.) |
|
|
TryGetDisplayName | |
|
|
TryGetString |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
TryGetVerboseDisplayName | |
|
|
TryResolveAbsolute | |
|
|
TryResolveRelative |
Properties
| Name | Description | |
|---|---|---|
|
DeveloperId |
The 4 character ADN developer code or a GUID. The combination of this and Name should make the plugin unique (Inherited from Plugin.) |
|
|
Id |
The full identifier for the plugin. This is formed as
Name.DeveloperId (Inherited from Plugin.) |
|
|
IsRemote |
Does this protocol access remote data?
|
|
|
Name |
The name of the Plugin. The combination of this and DeveloperId should make the plugin unique (Inherited from Plugin.) |
|
|
PluginRecord |
The PluginRecord that provides access to the attribute defined properties for this plugin. (Inherited from Plugin.) |
|
|
SupportedSchemes |
List of schemes that this protocol supports.
|
|
|
SupportsDirectOpen |
Does this protocol support direct opening of a file?
|
|
|
SupportsGetPut |
Does this protocol support the GetFile and PutFile methods?
|
|
|
SupportsOwnCache |
Does this protocol support it's own cache?
|