InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICloudDocsPublicUtils.h
1 /*************************************************************************
2  * Copyright [2023] Adobe
3  * All Rights Reserved.
4  * NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms of the Adobe license agreement accompanying it.
5 **************************************************************************/
6 
7 #ifndef ICloudDocsPublicUtils_h
8 #define ICloudDocsPublicUtils_h
9 
10 #include "IPMUnknown.h"
11 #include "CloudDocsID.h"
12 #include "URI.h"
13 #include "WideString.h"
14 /*
15  ICloudDocsPublicUtils
16  A class which cloud specific APIs used by ConditionalTextUIFacade project.
17 */
18 
19 /* For internal use only */
21 {
22 public:
23  enum { kDefaultIID = IID_ICLOUDDOCSPUBLICUTILS };
24  /* For internal use only -
25  Loads condition for CDP in case of a cloud document
26  @param loadConditionTagSets IN only when CDP is launched, If kTrue then sets the 'CDPLaunchedFor' as kLoadConditionalTextWithTag, else as kLoadConditionalText.
27  */
28  enum SamInitStatus{
29  kNotifcationCalled, //in case of cookie workflow,
30  kSamInitUnknown,
31  kSamInitSuccess,
32  kSamInitFailed,
33  kSamDoNoInit,
34  k0GBAccount
35 
36  };
37  virtual void LoadConditionsForCloudDoc(const bool16 loadConditionTagSets) const = 0;
38  /* For internal use only -
39  Loads cross reference formats from a cloud file
40  */
41  virtual void LoadXrefFromCloudDocs() = 0;
42 
43  /* Checks if the cloud document is enabled or not.
44  @return kTrue if enabled and kFalse otherwise.
45  */
46  virtual bool16 isCloudFeatureEnabled() = 0;
47 
48  /* Checks if the provided uri corresponds to an Adobe cloud asset.
49  @param uri - the uri that needs to be checked.
50  @return kTrue if it is a cloud asset and kFalse otherwise.
51  */
52  virtual bool16 IsAdobeCloudScheme(const URI &uri) const = 0;
53 
54  /* Returns the scheme of Adobe cloud assets
55  @return The Adobe cloud assets scheme.
56  */
57  virtual WideString GetAdobeCloudAssetScheme() const = 0;
58 };
59 
60 #endif /* ICloudDocsPublicUtils_h */