de.geeksfactory.opacclient.apis

Interface EbookServiceApi

public interface EbookServiceApi

If an OpacApi implementation also implements this interface, the library can be used to download ebooks directly inside the app. This is currently NOT implemented or used in the open source version and is more like a bridge between the "Community Edition" and the "Plus Edition" of the App.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EbookServiceApi.BookingResult The result of a booking(DetailledItem, Account, int, String) call.

Method Summary

Modifier and Type	Method and Description
AccountData	account(Account account) Proxy for the OpacApi.account(Account) feature, adding ebook entries.
EbookServiceApi.BookingResult	booking(DetailledItem item, Account account, int useraction, java.lang.String selection) Book an electronical item identified by booking_info to the users account. booking_info is what you returned in your DetailledItem object in your getResult hook.
java.lang.String	downloadItem(Account account, java.lang.String item_id) Download the item identified by item_id.
boolean	isEbook(DetailledItem item) Is this a supported downloadable ebook?

Method Detail

account

AccountData account(Account account)
             throws java.io.IOException,
                    org.json.JSONException,
                    OpacApi.OpacErrorException

Proxy for the OpacApi.account(Account) feature, adding ebook entries.

Throws:

java.io.IOException

org.json.JSONException

OpacApi.OpacErrorException

booking

EbookServiceApi.BookingResult booking(DetailledItem item,
                                      Account account,
                                      int useraction,
                                      java.lang.String selection)
                               throws java.io.IOException,
                                      OpacApi.OpacErrorException

Book an electronical item identified by booking_info to the users account. booking_info is what you returned in your DetailledItem object in your getResult hook.

Throws:

java.io.IOException

OpacApi.OpacErrorException

isEbook

boolean isEbook(DetailledItem item)

Is this a supported downloadable ebook? May not do network requests.

downloadItem

java.lang.String downloadItem(Account account,
                              java.lang.String item_id)

Download the item identified by item_id. Returns an URL where the item can be downloaded from.