The StorageInformation type is used hold information about a file being uploaded to a storage container that can be passed between the UX and APIs.
Below are the properties and their purpose.
- MemoryStream MemoryStream
- Default Value: Empty memory stream.
- Intended Value: The data for the file.
- string FileName
- Default Value: null.
- Intended Value: The name of the file.
- string FileType
- Default Value: null.
- Intended Value: The file type of the current file.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the current user.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the users active session.
- Guid WorkspaceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the workspace the storage is defined in.
- Guid InstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the storage instance.
- string FileURL
- Default Value: Empty string.
- Intended Value: The URL to access and download the file once its been uploaded to storage.
- bool IfFilePublic
- Default Value: true.
- Intended Value: Determines if the is available publicly.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: Contains an error message if something during processing failed so it can properly be handled by the API or UX.
- string StorageDefinition
- Default Value: Empty Guid.
- Intended Value: The XML instance data of the storage instance.
- bool IsFileCompressed
- Default Value: false.
- Intended Value: Determines if the current file is compressed.
