Click or drag to resize

ImageFromRemoteDrive Properties

The ImageFromRemoteDrive type exposes the following members.

Properties
 NameDescription
Public propertyErrorCodeFeedback This property will return value of the function error code. It shall return zero (0) if all operation succeed and a non-zero value if the operation fails.

The ImageFromRemoteDrivePropertyChange event will trigger with ErrorCodeFeedbackEventId.

Public propertyErrorDetailFeedback Property to reprot any errors that occur during image retrieval, decoding, or display. Note: More verbose is preferred. Examples: "Could not decode file because it exceeds device maximum width of 4096" is preferred to "Failed to decode image." 'Server at address "site.com" returned a 404 error when trying to retrieve file "file.png"' is preferred to "Failed to get image."

The ImageFromRemoteDrivePropertyChange event will trigger with ErrorDetailFeedbackEventId.

Public propertyErrorTextFeedback Property to indicate error when an operation fails on device.

The ImageFromRemoteDrivePropertyChange event will trigger with ErrorTextFeedbackEventId.

Public propertyParent The parent that a ImageFromRemoteDrive object was added to.
Public propertyRefreshImageDisabledFeedback Property to indicate if refreshing of image after RefreshRate timeout is disabled.

The ImageFromRemoteDrivePropertyChange event will trigger with RefreshImageDisabledEventId.

Public propertyRefreshImageEnabledFeedback Property to indicate if refreshing of image after RefreshRate timeout is enabled.

The ImageFromRemoteDrivePropertyChange event will trigger with RefreshImageEnabledEventId.

Public propertyRefreshRate Property to set/get refresh rate period in minutes at which the device should check for a new image. If the period expires and the device is unable to retrieve the image, it should retry three times, waiting 30 seconds before each try. Each attempt and retry shall be reported to the ErrorCodeFeedback field. After the three attempts, the device shall wait the period specified in refresh rate and then try again.
Public propertyRefreshRateFeedback Property to indicate refresh rate at which the image should be downloaded and displayed from remote server. Valid range is 1 to 65535 minutes. Default value is 60 minutes.

The ImageFromRemoteDrivePropertyChange event will trigger with RefreshRateFeedbackEventId.

Public propertyRemotePath Property to set/get a remote path of an image file. Only schemes HTTP and HTTPS should be supported. Ports embedded in the URI shall be supported. Queries shall be supported. Embedded usernames and passwords are not supported. If a username or username and password pair is entered into the field, the behavior is undefined and up to the HTTP client on the device. Any error should be reported to the ErrorCodeFeedback. Path limit is 200 characters using ASCII and 100 characters using unicode.
Public propertyRemotePathFeedback Property to indicate image path on remote server.

The ImageFromRemoteDrivePropertyChange event will trigger with RemotePathFeedbackEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
See Also