API Reference
WikiBook.isLocked()
Parameters: none
Returns:
an integer:
'1' if the book is locked
'0' if the book is not locked
Remarks:
isLocked() is used to determine the encryption status of a book. There is an important distinction between the lock-state
and encrypt-state.
An encrypted book always returns '1' for a call to isLocked().
An encrypted book may or may not return '1' for a call to isEncrypted()
- if the user has not yet entered a password to view the book, isEncrypted() will return '1'
- once the user has entered the correct password to view the book, 'isEncrypted() will return '0'.