设定参数函式

  • setActorByMbox(name,mbox);
  • setActorByMboxSha1sum(name,mbox_sha1sum);
  • setActorByOpenid(name,openid);
  • setActorByAccount(name,homePage,accountName);
  • setVerb(id,display);
  • setDisplay(language1,value1,...,languageN,valueN);
  • setObject(id,definition);
  • setDefinition(name,description,type,extensions,interactionType,correctResponsesPattern,choices);
  • setName(language1,value1,...,languageN,valueN);
  • setDescription(language1,value1,...,languageN,valueN);
  • setExtensions(extension1,...,extensionN);
  • setCorrectResponsesPattern(pattern1,...,patternN);
  • setChoices(id1,description1,...,idN,descriptionN);
  • setResult(duration,extensions,response,score,success);
  • setScore(min,raw,max);
  • setContext(instructor,language,contextActivities,platform,extensions);
  • setInstructorByMbox(name,mbox);
  • setInstructorByMboxSha1sum(name,mbox_sha1sum);
  • setInstructorByOpenid(name,openid);
  • setInstructorByAccount(name,homePage,accountName);
  • setContextActivities(parent,group,category);
  • setParent(id1,definition1,...,idN,definitionN);
  • setCategory(id1,...,idN);
  • setAuthorityByMbox(name,mbox);
  • setAuthorityByMboxSha1sum(name,mbox_sha1sum);
  • setAuthorityByOpenid(name,openid);
  • setAuthorityByAccount(name,homePage,accountName);
  • setTimestamp();

函式说明

setActorByMbox()

  • 作用:使用 mbox 设定主词
  • 参数:
名称 型态 说明
name String 脚色全名
mbox mailto IRI 脚色之电子邮件
Example
var actor = visca.setActorByMbox("Crystal","mailto:crystal@visca.com");

setActorByMboxSha1sum()

  • 作用:使用 mbox_sha1sum 设定主词
  • 参数:
名称 型态 说明
name String 脚色全名
mbox_sha1sum mailto IRI 将 mailto IRI 进行 SHA1 hash
Example
var actor = visca.setActorByMboxSha1sum("Crystal","mailto:crystal@visca.com");
{
    "objectType": "Agent",
    "name": "Crystal",
    "mbox_sha1sum": "0e2b882ae30d010c80e93d2cbd134076d8e1fad3"
}

setActorByOpenid()

  • 作用:使用 openid 设定主词
  • 参数:
名称 型态 说明
name String 脚色全名
openid URI 一个唯一的 openID
Example
var actor = visca.setActorByOpenid("Crystal","http://crystal.openid.example.org/");

setActorByAccount()

  • 作用:使用 account 设定主词
  • 参数:
名称 型态 说明
name String 脚色全名
homePage IRL 此帐户之服务首页
accountName String 帐户的 ID
Example
var actor = visca.setActorByAccount("Crystal","https://auth.ischool.com.tw/","f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf");

setVerb()

  • 作用:设定动词
  • 参数:
名称 型态 说明
id URL 使用的动作
display Object 使用动作的多语言之表示
Example
var id = "https://w3id.org/xapi/acrossx/verbs/watched";
var display = visca.setDisplay("zh-TW","观看");
var verb = visca.setVerb(id,display);

setDisplay()

  • 作用:设定多语言之表示
  • 参数:
名称 型态 说明
language String 语言代码
value String 对应语言之表示
Example
var display = visca.setDisplay("zh-TW","跳过");
var display = visca.setDisplay("zh-TW","跳过","en-US","skipped");

setObject()

  • 作用:设定对象
  • 参数:
名称 型态 说明
id URL 连结
definition Object 元数据
Example
var id = "https://www.youtube.com/watch?v=sQcwRGTW5mw";
var name = visca.setName("zh-TW","Future Learning");
var description = visca.setDescription("zh-TW","【亲子天下】《翻转教育:未来教育 Future Learning》");
var type = "https://w3id.org/xapi/acrossx/activities/video";
var extensions = visca.setExtension("duration","PT12M47S");
var definition = visca.setDefinition(name,description,type,extensions,null,null,null);
var object = visca.setObject(id,definition);

setDefinition()

  • 作用:设定元数据 (Metadata)
  • 参数:
名称 型态 说明
name Object 活动名称
description Object 活动描述
type URL 活动类型
extensions Object 活动的额外资讯
interactionType String 问题类型
correctResponsesPattern Array of Strings 正确答案
choices Array of Objects 选项
Example
var name = visca.setName("zh-TW","1");
var description = visca.setDescription("zh-TW","哪一个人最帅?");
var type = "http://adlnet.gov/expapi/activities/cmi.interaction";
var interactionType = "choice";
var correctResponsesPattern = visca.setCorrectResponsesPattern("king");
var id1 = "king";
var king = visca.setDescription("zh-TW","金城武");
var id2 = "ming";
var ming = visca.setDescription("zh-TW","明金城");
var choices = visca.setChoices(id1,king,id2,ming);
var definition = visca.setDefinition(name,description,type,extensions,interactionType,correctResponsesPattern,choices);

setName()

  • 作用:设定名称
  • 参数:
名称 型态 说明
language String 语言代码
value String 对应语言之名称
Example
var name = visca.setName("zh-TW","《老人与海》");

setDescription()

  • 作用:设定描述
  • 参数:
名称 型态 说明
language String 语言代码
value String 对应语言之描述
Example
var description = visca.setDescription("zh-TW","作者是海明威");

setExtension()

  • 作用:设定额外资讯
  • 参数:
名称 型态 说明
key String 额外资讯的类别
value String/Activity Object/URL/Integer/ISO 8601 String/Array of String 额外资讯内容
Example
var bloomsLevel = visca.setExtension("blooms-level","Applying");
var page = visca.setExtension("page",8);
var browserInfo = visca.setExtension("browser-info");

setExtensions()

  • 作用:设定多项额外资讯
  • 参数:
名称 型态 说明
extension Object setExtension 单项设定的额外资讯 JSON 物件
Example
var alignment = visca.setExtension("alignment",["社4-4-2-4","语1-1-2-2"]);
var duration = visca.setExtension("duration","PT12M47S");
var extensions = visca.setExtensions(alignment,duration);

setCorrectResponsesPattern()

  • 作用:设定正确答案
  • 参数:
名称 型态 说明
pattern String 正确答案
Example
var correctResponsesPattern = visca.setCorrectResponsesPattern("king");

setChoices()

  • 作用:设定选项
  • 参数:
名称 型态 说明
id String 选项id
description Object 选项内容描述
Example
var id1 = "king";
var king = visca.setDescription("zh-TW","金城武");
var id2 = "ming";
var ming = visca.setDescription("zh-TW","明金城");
var choices = visca.setChoices(id1,king,id2,ming);

setResult()

  • 作用:设定结果
  • 参数:
名称 型态 说明
duration ISO 8601 String 活动花费时间
extensions Object 额外资讯
response String 回答内容/笔记内容
score Object 分数
success Boolean 答对与否
Example
var duration = "PT20S";
var extensions = null;
var response = "king";
var score = visca.setScore(0,10,10);
var success = true;
var result = visca.setResult(duration,extensions,response,score,success);

setScore()

  • 作用:设定分数
  • 参数:
名称 型态 说明
min Decimal number less than max 最低分
raw Decimal number between min and max 得分
max Decimal number greater than min 最高分
Example
var score = visca.setScore(0,10,10);

setContext()

  • 作用:设定情境
  • 参数:
名称 型态 说明
instructor Agent Object 如果教学者不是动作者时,请填写教学者
language String 此情境中使用之语言
contextActivities Object 学习活动情境之各类型资讯
platform String 使用平台
extensions Object 额外资讯
Example
var instructor = visca.setInstructorByMbox("Crystal","mailto:crystal@visca.com");
var language = "zh-TW";
var contextActivities = visca.setContextActivities();
var context = visca.setContext(instructor);

setInstructorByMbox()

  • 作用:使用 mbox 设定教学者
  • 参数:
名称 型态 说明
name String 全名
mbox mailto IRI 电子邮件
Example
var instructor = visca.setInstructorByMbox("Crystal","mailto:crystal@visca.com");

setInstructorByMboxSha1sum()

  • 作用:使用 mbox_sha1sum 设定教学者
  • 参数:
名称 型态 说明
name String 全名
mbox_sha1sum mailto IRI 将 mailto IRI 进行 SHA1 hash
Example
var instructor = visca.setInstructorByMboxSha1sum("Crystal","mailto:crystal@visca.com");
{
    "objectType": "Agent",
    "name": "Crystal",
    "mbox_sha1sum": "0e2b882ae30d010c80e93d2cbd134076d8e1fad3"
}

setInstructorByOpenid()

  • 作用:使用 openid 设定教学者
  • 参数:
名称 型态 说明
name String 全名
openid URI 一个唯一的 openID
Example
var instructor = visca.setInstructorByOpenid("Crystal","http://crystal.openid.example.org/");

setInstructorByAccount()

  • 作用:使用 account 设定教学者
  • 参数:
名称 型态 说明
name String 全名
homePage IRI 此帐户之服务首页
accountName String 帐户的 ID
Example
var instructor = visca.setInstructorByAccount("Crystal","https://auth.ischool.com.tw/","f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf");

setContextActivities()

  • 作用:设定学习活动情境之各类型资讯
  • 参数:
名称 型态 说明
parent Object 所属的母活动
group
category Object Profile ID Activity
Example
var id = "http://www.visca.com/plan/id/1";
var name = visca.setName("zh-TW","我的学习计划");
var type = "https://w3id.org/xapi/acrossx/activities/learning-plan";
var definition = visca.setDefinition(name,null,type,null,null,null,null);
var parent = visca.setParent(id,definition);
var category = visca.setCategory("https://w3id.org/xapi/acrossx/profile/video");
var contextActivities = visca.setContextActivities(parent,null,category);

setParent()

  • 作用:设定所属的母活动
  • 参数:
名称 型态 说明
id URL 一个唯一的 Activity ID
definition Object 母活动之元数据
Example
var id = "https://www.youtube.com/watch?v=sQcwRGTW5mw";
var name = visca.setName("zh-TW","Future Learning");
var type = "https://w3id.org/xapi/acrossx/activities/video";
var extensions = visca.setExtension("duration","PT12M47S");
var definition = visca.setDefinition(name,null,type,extensions,null,null,null);
var parent = visca.setParent(id,definition);

setCategory()

  • 作用:设定 Profile ID Activity
  • 参数:
名称 型态 说明
id URL Profile ID Activity
Example
var category = visca.setCategory("https://w3id.org/xapi/acrossx/profile/video");
var category = visca.setCategory("https://w3id.org/xapi/acrossx/profile/practice","https://w3id.org/xapi/acrossx/profile/ebook");

setAuthorityByMbox()

  • 作用:使用 mbox 设定拥有者
  • 参数:
名称 型态 说明
name String 全名
mbox mailto IRI 电子邮件
Example
var authority = visca.setAuthorityByMbox("Teacher","mailto:teacher@visca.com");

setAuthorityByMboxSha1sum()

  • 作用:使用 mbox_sha1sum 设定拥有者
  • 参数:
名称 型态 说明
name String 全名
mbox_sha1sum mailto IRI 将 mailto IRI 进行 SHA1 hash
Example
var authority = visca.setAuthorityByMboxSha1sum("Teacher","mailto:teacher@visca.com");
{
    "objectType": "Agent",
    "name": "Teacher",
    "mbox_sha1sum": "e81c473d8eb3d276bd7d696adfe9c8275b3969ae"
}

setAuthorityByOpenid()

  • 作用:使用 openid 设定拥有者
  • 参数:
名称 型态 说明
name String 全名
openid URI 一个唯一的 openID
Example
var authority = visca.setAuthorityByOpenid("Teacher","http://teacher.openid.example.org/");

setAuthorityByAccount()

  • 作用:使用 account 设定拥有者
  • 参数:
Example
var authority = visca.setAuthorityByAccount("Teacher","http://www.example.com","13936749");
名称 型态 说明
name String 全名
homePage IRI 此帐户之服务首页
accountName String 帐户的 ID

setTimestamp()

  • 作用:设定时间戳记
  • 参数:无
  • 回传值:格式为 [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss.sss]Z 的 ISO String
Example
var timestamp = visca.setTimestamp();

results matching ""

    No results matching ""