AICloudDocumentSuite Struct Reference

#include <AICloudDocument.h>

List of all members.

Public Attributes
AIAPI AIErr(*	SaveToCloud )(const ai::UnicodeString &cloudPath)
	Saves the currently open document to cloud.
AIAPI AIErr(*	SaveCurrentDocument )()
	Saves the currently open cloud document if it is dirty, to its existing location.
AIAPI AIErr(*	OpenCloudDocument )(const ai::UnicodeString &cloudAssetRef, AIDocumentHandle &outDocument)
	Opens a cloud document present at the specified path.
AIAPI AIErr(*	DeleteCloudDocument )(const ai::UnicodeString &cloudAssetRef)
	Deletes the cloud document present at the specified path.
AIAPI AIErr(*	GetCloudDocumentAssetRef )(ai::UnicodeString &cloudAssetRef)
	Gets the path to the currently open cloud document.
AIAPI AIErr(*	GetFirstNRecentCloudDocuments )(ai::uint32 numRecentDocuments, ai::AutoBuffer< ai::UnicodeString > &cloudAssetRefs, AICloudRecentsBookmarkHandle &queryBookmark)
	Gets the cloud paths to the n most recently saved cloud documents.
AIAPI AIErr(*	GetNextNRecentCloudDocuments )(ai::uint32 numRecentDocuments, ai::AutoBuffer< ai::UnicodeString > &cloudAssetRefs, AICloudRecentsBookmarkHandle queryBookmarkIn, AICloudRecentsBookmarkHandle &queryBookmarkOut)
	Gets the cloud paths to the next n recently saved cloud documents when the API GetFirstNRecentCloudDocuments has been called once.
AIAPI AIErr(*	DisposeRecentBookmarkHandle )(AICloudRecentsBookmarkHandle queryBookmark)
	Disposes the bookmark handle that was fetched from the call to GetCloudDocumentAssetRef or GetFirstNRecentCloudDocuments.

---

Member Data Documentation

AIAPI AIErr(* AICloudDocumentSuite::DeleteCloudDocument)(const ai::UnicodeString &cloudAssetRef)

Deletes the cloud document present at the specified path.

Parameters:

cloudAssetRef

The path of the cloud document to be deleted.

AIAPI AIErr(* AICloudDocumentSuite::DisposeRecentBookmarkHandle)(AICloudRecentsBookmarkHandle queryBookmark)

Disposes the bookmark handle that was fetched from the call to GetCloudDocumentAssetRef or GetFirstNRecentCloudDocuments.

Should be called when no more recent documents are to be fetched by the user.

Parameters:

queryBookmark

Reference to the data that was fetched from GetCloudDocumentAssetRef or GetFirstNRecentCloudDocuments and is to be disposed.

AIAPI AIErr(* AICloudDocumentSuite::GetCloudDocumentAssetRef)(ai::UnicodeString &cloudAssetRef)

Gets the path to the currently open cloud document.

Parameters:

cloudAssetRef

[out] The buffer in which to return the cloud path.

AIAPI AIErr(* AICloudDocumentSuite::GetFirstNRecentCloudDocuments)(ai::uint32 numRecentDocuments, ai::AutoBuffer< ai::UnicodeString > &cloudAssetRefs, AICloudRecentsBookmarkHandle &queryBookmark)

Gets the cloud paths to the n most recently saved cloud documents.

Parameters:

	numRecentDocuments	The number of recent documents for which the cloud path is to be fetched. Not more than 100 recent documents could be fetched at a time.
	cloudAssetRefs	[out] The list of the requested cloud paths.
	queryBookmark	[out] Reference to the data that is to be preserved and passed in the call to GetNextNRecentCloudDocuments.

AIAPI AIErr(* AICloudDocumentSuite::GetNextNRecentCloudDocuments)(ai::uint32 numRecentDocuments, ai::AutoBuffer< ai::UnicodeString > &cloudAssetRefs, AICloudRecentsBookmarkHandle queryBookmarkIn, AICloudRecentsBookmarkHandle &queryBookmarkOut)

Gets the cloud paths to the next n recently saved cloud documents when the API GetFirstNRecentCloudDocuments has been called once.

This API could be used in an iterative fashion to access the next n recent documents.

Parameters:

	numRecentDocuments	The number of recent documents for which the cloud path is to be fetched.
	cloudAssetRefs	[out] The list of the requested cloud paths. Not more than 100 recent documents could be fetched at a time.
	queryBookmarkIn	Reference to the data that was fetched from the call to GetFirstNRecentCloudDocuments or from the previous call to GetNextNRecentCloudDocuments.
	queryBookmarkOut	[out] Reference to the data that is to be preserved for the next call to GetNextNRecentCloudDocuments.

Example:

ai::AutoBuffer<ai::UnicodeString> recentDocRefs; AICloudRecentsBookmarkHandle reqHandleIn = nullptr, reqHandleOut = nullptr;

Here we are fetching 10 recent documents, but we can fetch any number less than 100 error = sAICloudDocument->GetFirstNRecentCloudDocuments(10, recentDocRefs, reqHandleOut);

Get next set of recent documents while(reqHandleOut) { reqHandleIn = reqHandleOut; error = sAICloudDocument->GetNextNRecentCloudDocuments(10, recentDocRefs, reqHandleIn, reqHandleOut); Always dispose the AICloudRecentsBookmarkHandle after it has been used sAICloudDocument->DisposeRecentBookmarkHandle(reqHandleIn);

Work with the recent document refs }

AIAPI AIErr(* AICloudDocumentSuite::OpenCloudDocument)(const ai::UnicodeString &cloudAssetRef, AIDocumentHandle &outDocument)

Opens a cloud document present at the specified path.

Parameters:

	cloudAssetRef	The path of the cloud document to be opened.
	outDocument	[out] A buffer in which to return the document reference.

AIAPI AIErr(* AICloudDocumentSuite::SaveCurrentDocument)()

Saves the currently open cloud document if it is dirty, to its existing location.

AIAPI AIErr(* AICloudDocumentSuite::SaveToCloud)(const ai::UnicodeString &cloudPath)

Saves the currently open document to cloud.

Parameters:

cloudPath

The relative path to save the document. Could simply be the name of the document.

---

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

• AICloudDocument.h