Class ChannelHandler

Handles Channel related API requests, which include handling channel settings, as well as MediaType management.

Inheritance

System.Object

BaseHandler

ChannelHandler

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.ChannelManagement

Assembly: Appearition.SDK.dll

Syntax

public sealed class ChannelHandler : BaseHandler

Methods

GetAllChannels(Action<List<Channel>>, Action<EmsError>, Action<Boolean>)

Fetches all the channels' information present on the selected tenant.

API Requirement: Anonymous Token.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Channel>>	onSuccess	Contains the channel ApiData of all the channels in this tenant. 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.

GetAllChannels(List<Channel>, Action<List<Channel>>, Action<EmsError>, Action<Boolean>)

Fetches all the channels' information present on the selected tenant. Variation allowing an existing list to populate.

API Requirement: Anonymous Token.

Declaration

public static void GetAllChannels(List<Channel> reusableChannelList, Action<List<Channel>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<Channel>	reusableChannelList	Reusable channel list.
System.Action<System.Collections.Generic.List<Channel>>	onSuccess	Contains the channel ApiData of all the channels in this tenant. 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.

GetAllChannelsProcess(Action<List<Channel>>, Action<EmsError>, Action<Boolean>)

Fetches all the channels' information present on the selected tenant.

API Requirement: Anonymous Token.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Channel>>	onSuccess	Contains the channel ApiData of all the channels in this tenant. 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

GetAllChannelsProcess(List<Channel>, Action<List<Channel>>, Action<EmsError>, Action<Boolean>)

Fetches all the channels' information present on the selected tenant. Variation allowing an existing list to populate.

API Requirement: Anonymous Token.

Declaration

public static IEnumerator GetAllChannelsProcess(List<Channel> reusableChannelList, Action<List<Channel>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Collections.Generic.List<Channel>	reusableChannelList	Reusable channel list.
System.Action<System.Collections.Generic.List<Channel>>	onSuccess	Contains the channel ApiData of all the channels in this tenant. 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

GetChannelSettings(Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel selected in the current user.

API Requirement: Session Token.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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.

GetChannelSettings(Int32, Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel of given id.

API Requirement: Session Token.

Declaration

public static void GetChannelSettings(int channelId, Action<List<Setting>> 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<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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.

GetChannelSettings(Int32, List<Setting>, Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel of given id. A reusable list can be provided for the sake of optimizing performance.

API Requirement: Session Token.

Declaration

public static void GetChannelSettings(int channelId, List<Setting> reusableList = null, Action<List<Setting>> 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<Setting>	reusableList	A reusable channel settings list.
System.Action<System.Collections.Generic.List<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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.

GetChannelSettingsProcess(Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel selected in the current user.

API Requirement: Session Token.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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

GetChannelSettingsProcess(Int32, Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel of given id.

API Requirement: Session Token.

Declaration

public static IEnumerator GetChannelSettingsProcess(int channelId, Action<List<Setting>> 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<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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

GetChannelSettingsProcess(Int32, List<Setting>, Action<List<Setting>>, Action<EmsError>, Action<Boolean>)

Get the channel settings of the channel of given id. A reusable list can be provided for the sake of optimizing performance.

API Requirement: Session Token.

Declaration

public static IEnumerator GetChannelSettingsProcess(int channelId, List<Setting> reusableList, Action<List<Setting>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<Setting>	reusableList	A reusable channel settings list.
System.Action<System.Collections.Generic.List<Setting>>	onSuccess	Contains the channel settings of the selected channel. 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

GetMediaTypesFromEms(Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel chosen by the current user.

API Requirement: Session Token. Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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.

GetMediaTypesFromEms(Int32, Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel of a given id.

API Requirement: Session Token. Offline capability.

Declaration

public static void GetMediaTypesFromEms(int channelId, Action<List<MediaType>> 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<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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.

GetMediaTypesFromEms(Int32, List<MediaType>, Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel of a given id. A reusable list can be provided for the sake of optimizing performance.

API Requirement: Session Token. Offline capability.

Declaration

public static void GetMediaTypesFromEms(int channelId, List<MediaType> reusableMediaTypeList, Action<List<MediaType>> 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<MediaType>	reusableMediaTypeList	A reusable MediaType list.
System.Action<System.Collections.Generic.List<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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.

GetMediaTypesFromEmsProcess(Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel chosen by the current user.

API Requirement: Session Token. Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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

GetMediaTypesFromEmsProcess(Int32, Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel of a given id.

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetMediaTypesFromEmsProcess(int channelId, Action<List<MediaType>> 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<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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

GetMediaTypesFromEmsProcess(Int32, List<MediaType>, Action<List<MediaType>>, Action<EmsError>, Action<Boolean>)

Fetch the MediaTypes from the channel of a given id. A reusable list can be provided for the sake of optimizing performance.

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetMediaTypesFromEmsProcess(int channelId, List<MediaType> reusableMediaTypeList, Action<List<MediaType>> 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<MediaType>	reusableMediaTypeList	A reusable MediaType list.
System.Action<System.Collections.Generic.List<MediaType>>	onSuccess	Contains the the MediaTypes linked to the selected channel. 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

GetSingleChannelSettings(Action<Channel>, Action<EmsError>, Action<Boolean>)

Fetches the channel's information using the Channel Id stored in the Current User.

API Requirement: Session Token.

Declaration

public static void GetSingleChannelSettings(Action<Channel> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<Channel>	onSuccess	Contains the channel ApiData of the selected channel. 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.

GetSingleChannelSettings(Int32, Action<Channel>, Action<EmsError>, Action<Boolean>)

Fetches the channel's information using a given Id.

API Requirement: Session Token.

Declaration

public static void GetSingleChannelSettings(int channelId, Action<Channel> 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<Channel>	onSuccess	Contains the channel ApiData of the selected channel. 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.

GetSingleChannelSettingsProcess(Action<Channel>, Action<EmsError>, Action<Boolean>)

Fetches the channel's information using the Channel Id stored in the Current User.

API Requirement: Session Token.

Declaration

public static IEnumerator GetSingleChannelSettingsProcess(Action<Channel> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<Channel>	onSuccess	Contains the channel ApiData of the selected channel. 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

GetSingleChannelSettingsProcess(Int32, Action<Channel>, Action<EmsError>, Action<Boolean>)

Fetches the channel's information using a given Id.

API Requirement: Session Token.

Declaration

public static IEnumerator GetSingleChannelSettingsProcess(int channelId, Action<Channel> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<Channel>	onSuccess	Contains the channel ApiData of the selected channel. 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

UpdateChannelSettings(List<Setting>, Action, Action<EmsError>, Action<Boolean>)

Updates the settings of the channel currently selected by the current user.

API Requirement: Session Token.

Declaration

public static void UpdateChannelSettings(List<Setting> newSettings, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<Setting>	newSettings	Should contains the settings to apply to the selected channel.
System.Action	onSuccess	Contains the channel settings of the selected channel. 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.

UpdateChannelSettings(Int32, List<Setting>, Action, Action<EmsError>, Action<Boolean>)

Updates the settings of the channel from a given channel id.

API Requirement: Session Token.

Declaration

public static void UpdateChannelSettings(int channelId, List<Setting> newSettings, Action 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<Setting>	newSettings	Should contains the settings to apply to the selected channel.
System.Action	onSuccess	Contains the channel settings of the selected channel. 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.

UpdateChannelSettingsProcess(List<Setting>, Action, Action<EmsError>, Action<Boolean>)

Updates the settings of the channel currently selected by the current user.

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateChannelSettingsProcess(List<Setting> newSettings, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<Setting>	newSettings	Should contains the settings to apply to the selected channel.
System.Action	onSuccess	Contains the channel settings of the selected channel. 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

UpdateChannelSettingsProcess(Int32, List<Setting>, Action, Action<EmsError>, Action<Boolean>)

Updates the settings of the channel from a given channel id.

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateChannelSettingsProcess(int channelId, List<Setting> newSettings, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<Setting>	newSettings	Should contains the settings to apply to the selected channel.
System.Action	onSuccess	Contains the channel settings of the selected channel. 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)