Document API

This interface provides a method to get a Document module's version.

DOMString getVersion();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Return Value :

• DOMString : Version of the Document module

Exceptions :

• WebAPIException
  • with the error type SecurityError if the application does not have the privilege to call this method
  • with the error type UnknownError in any other error case

Since : 6.5

Code Example :

var Version = null;

try {
  Version = webapis.document.getVersion();
} catch (e) {
  console.log("[getVersion] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null !== Version) {
  console.log("[getVersion] call syncFunction type: " + Version);
}

Prepare the Document for playing and setting the necessary values for the play operation.

void open(DocumentInfo docinfo, DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• docinfo : Document basic information
• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[open] success : " + val);
};

var onerror = function(error) {
  console.log("[open] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

var docinfo = {
  "docpath"    : "http://107.109.202.6:80/1.PDF",
  "rectX"      : 0,
  "rectY"      : 0,
  "rectWidth"  : 960,
  "rectHeight" : 540
};

try {
  webapis.document.open(docinfo, onsuccess, onerror);
} catch (e) {
  console.log("[open] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to close a playing Document.

void close(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[close] success : " + val);
};

var onerror = function(error) {
  console.log("[close] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.close(onsuccess, onerror);
} catch (e) {
  console.log("[close] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to play a Document.

void play(long slideTime, DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• slideTime : Time spent on a slide, in seconds
• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[play] success : " + val);
};

var onerror = function(error) {
  console.log("[play] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.play(5, onsuccess, onerror);
} catch (e) {
  console.log("[play] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to stop Document playback.

void stop(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[stop] success : " + val);
};

var onerror = function(error) {
  console.log("[stop] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.stop(onsuccess, onerror);
} catch (e) {
  console.log("[stop] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to move to the previous page of a Document.

void prevPage(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[prevPage] success : " + val);
};

var onerror = function(error) {
  console.log("[prevPage] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.prevPage(onsuccess, onerror);
} catch (e) {
  console.log("[prevPage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to move to the next page of a Document.

void nextPage(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[nextPage] success : " + val);
};

var onerror = function(error) {
  console.log("[nextPage] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.nextPage(onsuccess, onerror);
} catch (e) {
  console.log("[nextPage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to pause Document playback.

void pause(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[pause] success : " + val);
};

var onerror = function(error) {
  console.log("[pause] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.pause(onsuccess, onerror);
} catch (e) {
  console.log("[pause] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to resume Document playback.

void resume(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[resume] success : " + val);
};

var onerror = function(error) {
  console.log("[resume] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.resume(onsuccess, onerror);
} catch (e) {
  console.log("[resume] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method for vertical Document playback.

void setDocumentOrientation(DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[setDocumentOrientation] success : " + val);
};

var onerror = function(error) {
  console.log("[setDocumentOrientation] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.setDocumentOrientation(onsuccess, onerror);
} catch (e) {
  console.log("[setDocumentOrientation] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

This interface provides a method to go to a specified page.

void gotoPage(long page, DocumentSuccessCallback onsuccess, optional DocumentErrorCallback? onerror);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• page : Page to be moved to
• onsuccess : Callback method to be invoked when this method executes successfully
• onerror [optional][nullable] : Callback method to be invoked when an error occurs
  The error type is SecurityError if the application does not have the privilege to call this method.
  The error type is UnknownError in any other error case.

Exceptions :

• WebAPIException
  • with the error type TypeMismatchError

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[gotoPage] success : " + val);
};

var onerror = function(error) {
  console.log("[gotoPage] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.gotoPage(3, onsuccess, onerror);
} catch (e) {
  console.log("[gotoPage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Callback parameter

void onsuccess(Result data);

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• data : Status of the operation

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[gotoPage] success : " + val);
};

var onerror = function(error) {
  console.log("[gotoPage] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};

try {
  webapis.document.gotoPage(3, onsuccess, onerror);
} catch (e) {
  console.log("[gotoPage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Callback parameter.

void onerror(Error data);

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/documentplay

Parameters :

• data : Status of the operation

Since : 6.5

Code Example :

var onsuccess = function(val) {
  console.log("[gotoPage] success : " + val);
};
var onerror = function(error) {
  console.log("[gotoPage] code :" + error.code + " error name: " + error.name + "  message " + error.message);
};
try {
  webapis.document.gotoPage(3, onsuccess, onerror);
} catch (e) {
  console.log("[gotoPage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}