E book Learing Service - AILTC/viscaWrapper GitHub Wiki

  • Instructor O assigned Actor K to read Book X (Chapter C). wasAssignedEBook(actor,objectID,authority);

  • Actor K read page N / section S / chapter C*. readEBookPage(actor,objectID,totalPages,page,reDuration);

  • Actor K bookmarked page N / section S / chapter C*. bookmarkedEBookPage(actor,objectID,page);

  • Actor K searched in Book X. searchedEBookString(actor,objectID,page,reResponse);

  • Actor K highlighted in Book X page N / section S / chapter C*. highlightedEBookParagraph(actor,objectID,page,reResponse);

  • Actor K took notes in Book X page N / section S / chapter C*. tookEBookNotes(actor,objectID,page,reDuration,reResponse);

  • Actor K looked up reference W in Book X page N / section S / chapter C* (internal or external link associated with an anchor text string). referencedEBookLink(actor,objectID,page,anchorText);

  • Actor K watched Video V in Book X page N / section S / chapter C*. watchedEBookVideo(actor,objectID,duration,start,end,parentID,page);

  • Actor K skipped while watching Video V in Book X page N / section S / chapter C*. skippedEBookVideo(actor,objectID,duration,start,end,parentID,page);

Functions

wasAssignedEBook()

  • Description: Instructor O assigned Actor K to read Book X (Chapter C).
  • Parameters:
Name Type Description
actor Agent Object The person who was assingned to read e-book.
objectID URL The link to the e-book.
authority Agent Object Teacher
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var authority = visca.setAuthorityByMbox("Teacher","[email protected]");

visca.wasAssignedEBook(actor,objectID,authority);

readEBookPage()

  • Description: Actor K read page N / section S / chapter C*.
  • Parameters：
Name Type Description
actor Agent Object The person who read a page of e-book.
objectID URL The link to the e-book.
totalPages Integer The total pages of e-book.
page Integer The page number that the activity occured.
reDuration ISO 8601 String The time that actor spend on reading.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var totalPages = 100;
var page = 1;
var reDuration = "PT8M20S";

visca.readEBookPage(actor,objectID,totalPages,page,reDuration);

bookmarkedEBookPage()

  • Description：Actor K bookmarked page N / section S / chapter C*.
  • Parameters：
Name Type Description
actor Agent Object The person who bookmarked on a page of e-book.
objectID URL The link to the e-book.
page Integer The page number that the activity occured.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var page = 2;

visca.bookmarkedEBookPage(actor,objectID,page);

searchedEBookString()

  • Description: Actor K searched in Book X.
  • Parameters:
Name Type Description
actor Agent Object The person who searched a string in e-book.
objectID URL The link to the e-book.
page Integer The page number that the activity occured.
reResponse String The string that actor searched.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var page = 3;
var reResponse = "Hemingway's birthplace";

visca.searchedEBookString(actor,objectID,page,reResponse);

highlightedEBookParagraph()

  • Description: Actor K highlighted in Book X page N / section S / chapter C*.
  • Parameters:
Name Type Description
actor Agent Object The person who highlighted a paragraph on a page of e-book.
objectID URL The link to the e-book.
page Integer The page number that the activity occured.
reResponse String The string that actor highlighted.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var page = 4;
var reResponse = "old people";

visca.highlightedEBookParagraph(actor,objectID,page,reResponse);

tookEBookNotes()

  • Description: Actor K took notes in Book X page N / section S / chapter C*.
  • Parameters:
Name Type Description
actor Agent Object The person who took notes on a page of e-book.
objectID URL The link to the e-book.
page Integer The page number that the activity occured.
reDuration ISO 8601 String The time that the actor spend on taking notes .
reResponse String The content of notes.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var page = 5;
var reDuration = "PT5M";
var reResponse = "old people";

visca.tookEBookNotes(actor,objectID,page,reDuration,reResponse);

referenceEBookLink()

  • Description: Actor K looked up reference W in Book X page N / section S / chapter C* (internal or external link associated with an anchor text string).
  • Parameters:
Name Type Description
actor Agent Object The person who referenced a link on a page of e-book.
objectID URL The link to the e-book.
page Integer The page number that the activity occured.
anchorText String The text of the link.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/book/id/1";
var page = 6;
var anchorText = "VisCa出版社";

visca.referenceEBookLink(actor,objectID,page,anchorText);

watchedEBookVideo()

  • Description: Actor K watched Video V in Book X page N / section S / chapter C*.
  • Parameters:
Name Type Description
actor Agent Object The person who watched a video on a page of e-book.
objectID URL The link to the video.
duration ISO 8601 String The length of the video.
start ISO 8601 String The time that the actor start watching video.
end ISO 8601 String The time that the actor end watching video.
parentID URL The link to the e-book.
page Integer The page number that the activity occured.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/video/id/1";
var duration = "PT6M30S";
var start = "PT2M30S";
var end = "PT3M";
var parentID = "http://visca.com/book/id/1";
var page = 7;

visca.watchedEBookVideo(actor,objectID,duration,start,end,parentID,page);

skippedEBookVideo()

  • Description: Actor K skipped while watching Video V in Book X page N / section S / chapter C*.
  • Parameters:
Name Type Description
actor Agent Object The person who skipped a video on a page of e-book.
objectID URL The link to the video.
duration ISO 8601 String The length of the video.
start ISO 8601 String The time that the actor start skipping video.
end ISO 8601 String The time that the actor end skipping video.
parentID URL The link to the e-book.
page Integer The page number that the activity occured.
Example
var actor = visca.setActorByMbox("Crystal","[email protected]");
var objectID = "http://visca.com/video/id/1";
var duration = "PT6M30S";
var start = "PT30S";
var end = "PT2M30S";
var parentID = "http://visca.com/book/id/1";
var page = 7;

visca.skippedEBookVideo(actor,objectID,duration,start,end,parentID,page);
⚠️ **GitHub.com Fallback** ⚠️