Foxit PDF SDK  9.1
FSPDFViewCtrl(async) Category Reference

Instance Methods

(void) - clearAllCacheFile
 Clear all files cached by SDK. More...
 
(void) - clearCacheFile:
 Clear the cache file. More...
 
(void) - openDocAtURL:password:completion:
 Open PDF document from a specified URL. This function is deprecated, it will be removed in future. More...
 
(void) - openDocFromURL:password:cacheOption:httpRequestProperties:completion:
 Open PDF document from a specified URL. More...
 

Method Documentation

◆ clearAllCacheFile

- (void) clearAllCacheFile

Clear all files cached by SDK.

Extends class FSPDFViewCtrl.

◆ clearCacheFile:

- (void) clearCacheFile: (NSString *)  url

Clear the cache file.

Parameters
urlIt should be a remote path.

Extends class FSPDFViewCtrl.

◆ openDocAtURL:password:completion:

- (void) openDocAtURL: (NSURL *)  url
password: (NSString *)  password
completion: (void(^)(FSErrorCode error))  completion 

Open PDF document from a specified URL. This function is deprecated, it will be removed in future.

Parameters
[in]urlPDF URL.
[in]passwordThe password string, used to load the PDF document content. It can be either user password or owner password. Set it to nil if the password is unknown.
[in]completionThe callback will be called when current document object becomes available or the view control fail to open the document.

Note that it will create a temporary file as cache for downloading the PDF file. The cache will be removed after closing the document.

Extends class FSPDFViewCtrl.

◆ openDocFromURL:password:cacheOption:httpRequestProperties:completion:

- (void) openDocFromURL: (NSURL *)  url
password: (NSString *)  password
cacheOption: (nullable CacheFileOption *)  cacheOption
httpRequestProperties: (nullable HttpRequestProperties *)  properties
completion: (void(^)(FSErrorCode error))  completion 

Open PDF document from a specified URL.

Parameters
[in]urlPDF URL.
[in]passwordThe password string, used to load the PDF document content. It can be either user password or owner password. Set it to nil if the password is unknown.
[in]cacheOptionThe cache option. Please refer to FSCacheFileOption.
[in]completionThe callback will be called when current document object becomes available or the view control fail to open the document.

Note that it will create a temporary file as cache for downloading the PDF file. The cache will be removed after the document closed.

Extends class FSPDFViewCtrl.