InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
HTTPAssetLinkResourceStateUpdater Class Reference

#include <HTTPAssetLinkResourceStateUpdater.h>

Inheritance diagram for HTTPAssetLinkResourceStateUpdater:
CPMUnknown< ILinkResourceStateUpdater >ILinkResourceStateUpdaterIPMUnknownCusHttpLnkLinkResourceStateUpdater

Public Types

typedef CPMUnknown
< ILinkResourceStateUpdater > 		inherited
 

Public Member Functions

 HTTPAssetLinkResourceStateUpdater (IPMUnknown *boss)
 
ErrorCode UpdateResourceStateSync (const UIDRef &resourceRef, bool bNotify)
 
ErrorCode UpdateResourceStateAsync (const UIDRef &resourceRef)
 
void CancelUpdateResourceState (const UIDRef &resourceRef)
 
void WaitForUpdateResourceStateCompletion (const UIDRef &resourceRef)
 
ErrorCode ResolveResource (const UIDRef &resourceRef, const URI &relativeURI, bool bIgnoreStamp)
 
- Public Member Functions inherited from CPMUnknown< ILinkResourceStateUpdater >
IPMUnknown * QueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknown & operator= (const CPMUnknown &)=delete
 

Static Public Member Functions

static void HandleFetchingAssetMetadata (UID resourceUID, HTTPLinkSubsystemTypes::UpdateLinkResourceStateClientData updateLinkResourceStateData, IHTTPLinkResourceServerAPIWrapper::AssetStatusWithMetadataPtr assetStatusWithMetadataPtr)
 

Protected Member Functions

virtual ErrorCode UpdateLinkResourceState (const UIDRef &resourceRef, bool bNotify, bool async)
 
- Protected Member Functions inherited from CPMUnknown< ILinkResourceStateUpdater >
 CPMUnknown (IPMUnknown *boss)
 

Static Protected Member Functions

static WideString CreateResourceStamp (const URI &uri, const IHTTPLinkResourceServerAPIWrapper::AssetStatusWithMetadataPtr &assetMetaData)
 

Additional Inherited Members

- Protected Attributes inherited from CPMUnknown< ILinkResourceStateUpdater >
HelperInterface fHelperInterface
 

Detailed Description

Experimental header - will be modified/documented in future.

Member Function Documentation

void HTTPAssetLinkResourceStateUpdater::CancelUpdateResourceState (const UIDRef & resourceRef)
inlinevirtual

Cancels an asynchronous link resource state update.

Parameters
resourceRef[IN] UIDRef of the link resource to cancel the asynchronous state update for.

Implements ILinkResourceStateUpdater.

ErrorCode HTTPAssetLinkResourceStateUpdater::ResolveResource (const UIDRef & resourceRef,
const URI & relativeURI,
bool bIgnoreStamp 
)
virtual

Synchronous API to automatically find the resource (without user interaction) at new location if it is missing. of the link resource if it is missing.

Parameters
resourceRef[IN] UIDRef of the link resource to resolve.
relativeURI[IN] Relative location of where to start the search. \ For example, this is often the location of the document, and depending upon the protocol of the link may not be utilized.
bIgnoreStamp[IN] Denotes whether to ignore the resource's stamp when looking for potential matches.
Returns
kSuccess if the link resource is successfully resolved, else an error code.

Implements ILinkResourceStateUpdater.

ErrorCode HTTPAssetLinkResourceStateUpdater::UpdateResourceStateAsync (const UIDRef & resourceRef)
virtual

Called to update the state of a link resource synchronously.

Parameters
resourceRef[IN] UIDRef of the link resource to update.
Returns
kSuccess if the state update request was successfully queued, else an error code.

Implements ILinkResourceStateUpdater.

ErrorCode HTTPAssetLinkResourceStateUpdater::UpdateResourceStateSync (const UIDRef & resourceRef,
bool bNotify 
)
virtual

Called to update the state of a link resource synchronously.

Parameters
resourceRef[IN] UIDRef of the link resource to update.
bNotify[IN] Denotes whether to notify when the resource's state is updated.
Returns
kSuccess if the link resource's state is successfully updated, else an error code.

Implements ILinkResourceStateUpdater.

void HTTPAssetLinkResourceStateUpdater::WaitForUpdateResourceStateCompletion (const UIDRef & resourceRef)
inlinevirtual

Wait for the asynchronous link resource state update request to get completed.

Parameters
resourceRef[IN] UIDRef of the link resource whose asynchronous request needs to be completed.

Implements ILinkResourceStateUpdater.