Class LearnHandler

Handler in charge of taking care of the Learn module as it is on the EMS. Provides the node tree as well as tracking functionality.

Inheritance

System.Object

BaseHandler

LearnHandler

Inherited Members

BaseHandler.GetReusableApiRequest<T>()

BaseHandler.GetHandlerStoragePath<T>()

BaseHandler.JSON_FOLDER_NAME

BaseHandler.GetHandlerJsonFolderPath<T>()

BaseHandler.GetApiJsonFileName<T>()

BaseHandler.GetApiJsonFileName<T>(UserProfile)

BaseHandler.GetApiJsonFileFullPath<T, K>(UserProfile)

BaseHandler.EncryptData(String)

BaseHandler.DecryptData(String)

BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>)

BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>, UserProfile)

BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>, String)

BaseHandler.SaveJsonData<K>(String, String)

BaseHandler.TryToFetchOfflineRequestContent<T, K>()

BaseHandler.TryToFetchOfflineRequestContent<T, K>(UserProfile)

BaseHandler.TryToFetchOfflineRequestContent<T, K>(String)

BaseHandler.LoadJsonTextInFile<K>(String)

BaseHandler.GetContentFromFileProcess(String, Action<Byte[]>)

BaseHandler.SaveContentToFileProcess(Byte[], String, Action<Boolean>)

BaseHandler.DeleteFileProcess(String, Action<Boolean>)

BaseHandler.CopyFileToDestinationProcess(String, String, Action<Boolean>)

BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)

BaseHandler.DownloadGenericFile(String, String, String, Boolean, Action<Byte[]>)

BaseHandler.HandleSimpleOfflineApiContentLoadingWithCallback<T, K>(Action<T>, Action<EmsError>, Action<Boolean>)

BaseHandler.HandleSimpleOnlineOnlyApiInternetCheck(Action<Boolean>, Action<EmsError>, Action<Boolean>)

Namespace: Appearition.Learn

Assembly: Appearition.SDK.dll

Syntax

public class LearnHandler : BaseHandler

Methods

GetLearnContent(Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetLearnContent(Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

GetLearnContent(List<LearnNode>, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a reusable list.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetLearnContent(List<LearnNode> reusableList, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<LearnNode>	reusableList	Reusable list of learn nodes.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

GetLearnContent(Int32, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a channel Id.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetLearnContent(int channelId, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

GetLearnContent(Int32, List<LearnNode>, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a reusable list.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetLearnContent(int channelId, List<LearnNode> reusableList, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<LearnNode>	reusableList	Reusable list of learn nodes.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

GetLearnContentProcess(Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetLearnContentProcess(Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

GetLearnContentProcess(List<LearnNode>, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a reusable list.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetLearnContentProcess(List<LearnNode> reusableList, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<LearnNode>	reusableList	Reusable list of learn nodes.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

GetLearnContentProcess(Int32, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a channel Id.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetLearnContentProcess(int channelId, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

GetLearnContentProcess(Int32, List<LearnNode>, Action<List<LearnNode>>, Action<EmsError>, Action<Boolean>)

Fetches the learn module's content. Optionally, can provide a reusable list.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetLearnContentProcess(int channelId, List<LearnNode> reusableList, Action<List<LearnNode>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<LearnNode>	reusableList	Reusable list of learn nodes.
System.Action<System.Collections.Generic.List<LearnNode>>	onSuccess	Contains the Learn Data as on the EMS, as a hierarchy node tree. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

SubmitLearnTracking(LearningSession, Action, Action<EmsError>, Action<Boolean>)

Submits a full learn session.

API Requirement: Session Token.

Declaration

public static void SubmitLearnTracking(LearningSession session, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
LearningSession	session	The learn session container executed by the user.
System.Action	onSuccess	Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

SubmitLearnTracking(Int32, LearningSession, Action, Action<EmsError>, Action<Boolean>)

Submits a full learn session. Optionally, can provide a channel Id.

API Requirement: Session Token.

Declaration

public static void SubmitLearnTracking(int channelId, LearningSession session, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
LearningSession	session	The learn session container executed by the user.
System.Action	onSuccess	Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

SubmitLearnTrackingProcess(LearningSession, Action, Action<EmsError>, Action<Boolean>)

Submits a full learn session.

API Requirement: Session Token.

Declaration

public static IEnumerator SubmitLearnTrackingProcess(LearningSession session, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
LearningSession	session	The learn session container executed by the user.
System.Action	onSuccess	Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

SubmitLearnTrackingProcess(Int32, LearningSession, Action, Action<EmsError>, Action<Boolean>)

Submits a full learn session. Optionally, can provide a channel Id.

API Requirement: Session Token.

Declaration

public static IEnumerator SubmitLearnTrackingProcess(int channelId, LearningSession session, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
LearningSession	session	The learn session container executed by the user.
System.Action	onSuccess	Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

Extension Methods

ObjectExtension.ToStream(Object)