VxSdk::IVxDataObject Struct Reference

Represents a custom serialized data object submitted by a client and stored on the server. The data is completely opaque to the server and other types of clients. More...

#include <IVxDataObject.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	DeleteDataObject () const =0
	Deletes this data object from the VideoXpert system. More...
virtual VxResult::Value	GetData (char *data, int &size) const =0
	Gets the serialized data. More...
virtual VxResult::Value	GetOwner (IVxUser *&user) const =0
	Gets the IVxUser that owns this data object, if any. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
virtual VxResult::Value	SetData (char *data)=0
	Sets the serialized data value. More...

Public Attributes
char	clientType [64]
	The data object client identifier. More...
char	id [64]
	The unique identifier of the data object. More...
char	owner [64]
	If present, indicates that this resource is owned by a user (it is private); this is their username. If not present, indicates that this resource is not owned (it is public). If this data object has an owner, only the owner and users with appropriate permissions will be able to read it. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a custom serialized data object submitted by a client and stored on the server. The data is completely opaque to the server and other types of clients.

Definition at line 15 of file IVxDataObject.h.

Member Function Documentation

void VxSdk::IVxDataObject::Clear ( )

inlineprotected

Clears this instance.

Definition at line 72 of file IVxDataObject.h.

                     {
            VxZeroArray(this->clientType);
            VxZeroArray(this->id);
            VxZeroArray(this->owner);
        }

virtual VxResult::Value VxSdk::IVxDataObject::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxDataObject::DeleteDataObject ( ) const

pure virtual

Deletes this data object from the VideoXpert system.

Returns

The Result of deleting the data object.

virtual VxResult::Value VxSdk::IVxDataObject::GetData ( char *  data, int &  size  ) const

pure virtual

Gets the serialized data.

Parameters

data	The serialized data.
size	The size of data .

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataObject::GetOwner ( IVxUser *&  user ) const

pure virtual

Gets the IVxUser that owns this data object, if any.

Parameters

user	The IVxUser that owns this data object.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataObject::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxDataObject::SetData ( char *  data )

pure virtual

Sets the serialized data value.

Parameters

data	The serialized data.

Returns

The Result of setting the data.

Member Data Documentation

char VxSdk::IVxDataObject::clientType[64]

The data object client identifier.

Definition at line 56 of file IVxDataObject.h.

char VxSdk::IVxDataObject::id[64]

The unique identifier of the data object.

Definition at line 60 of file IVxDataObject.h.

char VxSdk::IVxDataObject::owner[64]

If present, indicates that this resource is owned by a user (it is private); this is their username. If not present, indicates that this resource is not owned (it is public). If this data object has an owner, only the owner and users with appropriate permissions will be able to read it.

Definition at line 66 of file IVxDataObject.h.

---

The documentation for this struct was generated from the following file:

• C:/Git/VXSDK_M3/VxSdk/Include/IVxDataObject.h