API: AICloudDocument.h Source File

00001 /*************************************************************************
00002  *
00003  * ADOBE CONFIDENTIAL
00004  *
00005  * Copyright 2020 Adobe
00006  *
00007  * All Rights Reserved.
00008  *
00009  * NOTICE: Adobe permits you to use, modify, and distribute this file in
00010  * accordance with the terms of the Adobe license agreement accompanying
00011  * it. If you have received this file from a source other than Adobe,
00012  * then your use, modification, or distribution of it requires the prior
00013  * written permission of Adobe.
00014  *
00015  **************************************************************************/
00016 
00017 #pragma once
00018 
00019 #include "IAIAutoBuffer.h"
00020 #include "IAIUnicodeString.h"
00021 
00022 #include "AIHeaderBegin.h"
00023 
00024 #define kAICloudDocumentSuite                  "AI Cloud Document Suite"
00025 #define kAICloudDocumentSuiteVersion           AIAPI_VERSION(1)
00026 #define kAICloudDocumentVersion                kAICloudDocumentSuiteVersion
00027 
00028 
00029 typedef struct _t_AICloudRecentsBookmark* AICloudRecentsBookmarkHandle;
00030 
00031 
00032 struct AICloudDocumentSuite
00033 {
00038     AIAPI AIErr (*SaveToCloud) ( const ai::UnicodeString& cloudPath );
00039     
00041     AIAPI AIErr (*SaveCurrentDocument) ();
00042     
00047     AIAPI AIErr (*OpenCloudDocument) ( const ai::UnicodeString& cloudAssetRef, AIDocumentHandle& outDocument );
00048     
00052     AIAPI AIErr (*DeleteCloudDocument) ( const ai::UnicodeString& cloudAssetRef );
00053     
00057     AIAPI AIErr (*GetCloudDocumentAssetRef) ( ai::UnicodeString& cloudAssetRef );
00058     
00065     AIAPI AIErr (*GetFirstNRecentCloudDocuments) ( ai::uint32 numRecentDocuments, ai::AutoBuffer<ai::UnicodeString>& cloudAssetRefs, AICloudRecentsBookmarkHandle& queryBookmark );
00066     
00095     AIAPI AIErr (*GetNextNRecentCloudDocuments) ( ai::uint32 numRecentDocuments, ai::AutoBuffer<ai::UnicodeString>& cloudAssetRefs, AICloudRecentsBookmarkHandle queryBookmarkIn, AICloudRecentsBookmarkHandle& queryBookmarkOut );
00096     
00102     AIAPI AIErr (*DisposeRecentBookmarkHandle) (AICloudRecentsBookmarkHandle queryBookmark);
00103 
00104 };
00105 
00106 #include "AIHeaderEnd.h"