Class XApiObject

Object of an xAPI statement. The object type here is always Activity.

Inheritance

Object

XApiObject

Namespace: i5.Toolkit.Core.ExperienceAPI

Assembly: cs.temp.dll.dll

Syntax

public class XApiObject

Constructors

XApiObject(String)

Declaration

public XApiObject(string objectID)

Parameters

Type	Name	Description
String	objectID

Fields

descriptionDisplay

Dictionary that holds the descriptions of the activity in various languages. Keys are language/region codes (e.g. en-us, es, ...). Values are the names of the object in that language. Optional/Dictionary can be empty.

Declaration

public Dictionary<string, string> descriptionDisplay

Field Value

Type	Description
Dictionary<String, String>

id

Id of the object. Required.

Declaration

public string id

Field Value

Type	Description
String

nameDisplay

Dictionary that holds the human readable/visual names of the Activity in various languages. Keys are language/region codes (e.g. en-us, es, ...). Values are the names of the object in that language. Optional/Dictionary can be empty.

Declaration

public Dictionary<string, string> nameDisplay

Field Value

Type	Description
Dictionary<String, String>

type

The defined type of an activity. MUST be an IRI. Optional.

Declaration

public string type

Field Value

Type	Description
String

Methods

AddDescription(String, String)

Add a display description for an object in the desired language

Declaration

public void AddDescription(string description, string languageCode = "en-us")

Parameters

Type	Name	Description
String	description
String	languageCode	Language/region codes such as 'en-us', 'en-uk', 'es'... Default value is 'en-us'.

AddName(String, String)

Add a display name for an object in the desired language.

Declaration

public void AddName(string name, string languageCode = "en-us")

Parameters

Type	Name	Description
String	name	The name of the object in the desired language.
String	languageCode	Language/region codes such as 'en-us', 'en-uk', 'es'... Default value is 'en-us'.