The Export class represents an exported data set that is archived within the system. More...

#include <Export.h>

Public Types
enum	Formats { Formats::Unknown, Formats::MkvZip }
	Values that represent the format of exported data. More...

enum	States { States::Unknown, States::Exporting, States::Failed, States::Pending, States::Successful }
	Values that represent status of an export. More...

Public Member Functions
	Export (VxSdk::IVxExport *vxExport)
	Constructor. More...

virtual	~Export ()
	Destructor. More...

	!Export ()
	Finaliser. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::Collections::Generic::List< ExportClip^ >^	_GetClips ()

User^	_GetOwner ()

Package Attributes
VxSdk::IVxExport *	_export

Properties
System::DateTime	Completed `[get]`
	Gets the date and time at which the triggered export completed the export operation. More...

System::String^	DataUri `[get]`
	Gets the URI to the exported data. It will only be present if the exported data is completed and available for download. More...

System::Collections::Generic::List< ExportClip^ >^	ExportClips `[get]`
	Gets the clips associated with this export. More...

int	FileSizeKb `[get]`
	Gets the file size of the exported data in kilobytes (kB). More...

Formats	Format `[get]`
	Gets the format of the export data. More...

System::String^	Id `[get]`
	Gets the unique export identifier. More...

System::DateTime	Initiated `[get]`
	Gets the date and time at which the Export was requested. More...

bool	IsProtected `[get]`
	Gets a value indicating whether the export data is signed and encrypted. More...

System::String^	Name `[get]`
	Gets the friendly name of the export. More...

User^	Owner `[get]`
	Gets the user that has created this export, if any. More...

System::String^	OwnerName `[get]`
	Gets the name of the user that has created this export, if any. More...

float	PercentComplete `[get]`
	Gets a value from 0 to 100. This specifies how close the export is to completion. 0 indicates that the export has not been triggered; 100 indicates that the export is complete. More...

int	SecondsRemaining `[get]`
	Gets the estimated time remaining, in seconds, until the export is 100 percent complete. If the export is complete this value will be 0. More...

States	Status `[get]`
	Gets the current status of the export. More...

Detailed Description

The Export class represents an exported data set that is archived within the system.

Definition at line 15 of file Export.h.

Member Enumeration Documentation

enum CPPCli::Export::Formats

strong

Values that represent the format of exported data.

Enumerator
Unknown	An error or unknown value was returned.
MkvZip	MKV file(s) contained withing a zip file.

Definition at line 21 of file Export.h.

enum CPPCli::Export::States

strong

Values that represent status of an export.

Enumerator
Unknown	An error or unknown value was returned.
Exporting	The export is in progress.
Failed	The export has failed.
Pending	The export is queued to start.
Successful	The export has completed successfully.

Definition at line 32 of file Export.h.

                           {
             Unknown,
 
             Exporting,
 
             Failed,
 
             Pending,
 
             Successful
         };

Constructor & Destructor Documentation

CPPCli::Export::Export ( VxSdk::IVxExport * vxExport )

Constructor.

Parameters

vxExport The vx export.

Definition at line 8 of file Export.cpp.

                                              {
     _export = vxExport;
 }

virtual CPPCli::Export::~Export ( )

inlinevirtual

Destructor.

Definition at line 58 of file Export.h.

                           {
             this->!Export();
         }

CPPCli::Export::!Export ( )

Finaliser.

Definition at line 12 of file Export.cpp.

                       {
     _export->Delete();
     _export = nullptr;
 }

Member Function Documentation

List< CPPCli::ExportClip^ > CPPCli::Export::_GetClips ( )

package

Definition at line 21 of file Export.cpp.

                                                  {
     // Create a list of managed export objects
     List<CPPCli::ExportClip^>^ mlist = gcnew List<CPPCli::ExportClip^>();
     // Add each clip in the export to the list
     for (int i = 0; i < _export->exportClipSize; i++)
         mlist->Add(gcnew CPPCli::ExportClip(_export->exportClips[i]));
 
     return mlist;
 }

CPPCli::User CPPCli::Export::_GetOwner ( )

package

Definition at line 31 of file Export.cpp.

                                     {
     // Get the user that owns this export
     VxSdk::IVxUser* user = nullptr;
     VxSdk::VxResult::Value result = _export->GetOwner(user);
 
     // Return the user if GetOwner was successful
     if (result == VxSdk::VxResult::kOK)
         return gcnew CPPCli::User(user);
 
     return nullptr;
 }

CPPCli::Results::Value CPPCli::Export::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 17 of file Export.cpp.

                                          {
     return (CPPCli::Results::Value)_export->Refresh();
 }

Member Data Documentation

VxSdk::IVxExport* CPPCli::Export::_export

package

Definition at line 204 of file Export.h.

Property Documentation

System:: DateTime CPPCli::Export::Completed

get

Gets the date and time at which the triggered export completed the export operation.

A default DateTime if it fails, else the DateTime when the export completed.

Definition at line 77 of file Export.h.

System:: String^ CPPCli::Export::DataUri

get

Gets the URI to the exported data. It will only be present if the exported data is completed and available for download.

The data URI.

Definition at line 87 of file Export.h.

System:: Collections:: Generic:: List< ExportClip^>^ CPPCli::Export::ExportClips

get

Gets the clips associated with this export.

The List of clips contained in the export.

Definition at line 96 of file Export.h.

int CPPCli::Export::FileSizeKb

get

Gets the file size of the exported data in kilobytes (kB).

The file size.

Definition at line 105 of file Export.h.

Formats CPPCli::Export::Format

get

Gets the format of the export data.

The export Format.

Definition at line 114 of file Export.h.

System:: String^ CPPCli::Export::Id

get

Gets the unique export identifier.

The unique identifier.

Definition at line 123 of file Export.h.

System:: DateTime CPPCli::Export::Initiated

get

Gets the date and time at which the Export was requested.

The DateTime when the export was initiated.

Definition at line 132 of file Export.h.

bool CPPCli::Export::IsProtected

get

Gets a value indicating whether the export data is signed and encrypted.

true if this export is protected, false if not.

Definition at line 141 of file Export.h.

System:: String^ CPPCli::Export::Name

get

Gets the friendly name of the export.

The friendly name.

Definition at line 150 of file Export.h.

User^ CPPCli::Export::Owner

get

Gets the user that has created this export, if any.

The user that owns this export.

Definition at line 159 of file Export.h.

System:: String^ CPPCli::Export::OwnerName

get

Gets the name of the user that has created this export, if any.

The owner name.

Definition at line 168 of file Export.h.

float CPPCli::Export::PercentComplete

get

Gets a value from 0 to 100. This specifies how close the export is to completion. 0 indicates that the export has not been triggered; 100 indicates that the export is complete.

The percent complete.

Definition at line 179 of file Export.h.

int CPPCli::Export::SecondsRemaining

get

Gets the estimated time remaining, in seconds, until the export is 100 percent complete. If the export is complete this value will be 0.

Public Types

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation