Class LocationHandler

Handles the API requests for the Location module.

Inheritance

System.Object

BaseHandler

LocationHandler

Inherited Members

BaseHandler.GetReusableApiRequest<T>()

BaseHandler.GetHandlerStoragePath<T>()

BaseHandler.JSON_FOLDER_NAME

BaseHandler.GetHandlerJsonFolderPath<K>()

BaseHandler.GetApiJsonFullPath<T, K>()

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile, Int32, String)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile, Int32, String)

BaseHandler.GetApiDownloadedBytesFullPath<T, K>(T, UserProfile, Int32, String)

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

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

BaseHandler.DeleteFileProcess(String, Action<Boolean>)

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

BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)

BaseHandler.GetChecksumFromExistingFile(String)

BaseHandler.ClearHandlerCache<T>(Action<Boolean>)

BaseHandler.TokenUsedForDownloads

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

BaseHandler.GetEmsContentFileSize(String, Action<Nullable<Int64>>)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Appearition.Location

Assembly: Appearition.SDK.dll

Syntax

public sealed class LocationHandler : BaseHandler

Methods

ClearLocalPointOfInterestData(Location, PointOfInterest, Action<Boolean>)

Clears the cached files of the given PointOfInterest.

Declaration

public static void ClearLocalPointOfInterestData(Location location, PointOfInterest poi, Action<bool> onComplete)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not all the processes successfully completed.

ClearLocalPointOfInterestDataProcess(Location, PointOfInterest, Action<Boolean>)

Clears the cached files of the given PointOfInterest.

Declaration

public static IEnumerator ClearLocalPointOfInterestDataProcess(Location location, PointOfInterest poi, Action<bool> onComplete)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not all the processes successfully completed.

Returns

Type	Description
System.Collections.IEnumerator

GetChannelArLocations(Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Location>>	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.

GetChannelArLocations(Boolean, Boolean, Boolean, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetChannelArLocations(bool downloadLabelImageIfAny, bool downloadMarkerImageIfAny, bool downloadInfoImageIfAny, Action<List<Location>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadLabelImageIfAny	Downloads or loads the label images of the PointOfInterests.
System.Boolean	downloadMarkerImageIfAny	Downloads or loads the marker images of the PointOfInterests.
System.Boolean	downloadInfoImageIfAny	Downloads or loads the info images of the PointOfInterests.
System.Action<System.Collections.Generic.List<Location>>	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.

GetChannelArLocations(Int32, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetChannelArLocations(int channelId, Action<List<Location>> 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<Location>>	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.

GetChannelArLocations(Int32, Boolean, Boolean, Boolean, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static void GetChannelArLocations(int channelId, bool downloadLabelImageIfAny, bool downloadMarkerImageIfAny, bool downloadInfoImageIfAny, Action<List<Location>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadLabelImageIfAny	Downloads or loads the label images of the PointOfInterests.
System.Boolean	downloadMarkerImageIfAny	Downloads or loads the marker images of the PointOfInterests.
System.Boolean	downloadInfoImageIfAny	Downloads or loads the info images of the PointOfInterests.
System.Action<System.Collections.Generic.List<Location>>	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.

GetChannelArLocationsProcess(Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Location>>	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

GetChannelArLocationsProcess(Boolean, Boolean, Boolean, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetChannelArLocationsProcess(bool downloadLabelImageIfAny, bool downloadMarkerImageIfAny, bool downloadInfoImageIfAny, Action<List<Location>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadLabelImageIfAny	Downloads or loads the label images of the PointOfInterests.
System.Boolean	downloadMarkerImageIfAny	Downloads or loads the marker images of the PointOfInterests.
System.Boolean	downloadInfoImageIfAny	Downloads or loads the info images of the PointOfInterests.
System.Action<System.Collections.Generic.List<Location>>	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

GetChannelArLocationsProcess(Int32, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetChannelArLocationsProcess(int channelId, Action<List<Location>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<Location>>	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

GetChannelArLocationsProcess(Int32, Boolean, Boolean, Boolean, Action<List<Location>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArLocations for the channel selected by the current user.

API Requirement: Anonymous Token. Offline Capability.

Declaration

public static IEnumerator GetChannelArLocationsProcess(int channelId, bool downloadLabelImageIfAny, bool downloadMarkerImageIfAny, bool downloadInfoImageIfAny, Action<List<Location>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadLabelImageIfAny	Downloads or loads the label images of the PointOfInterests.
System.Boolean	downloadMarkerImageIfAny	Downloads or loads the marker images of the PointOfInterests.
System.Boolean	downloadInfoImageIfAny	Downloads or loads the info images of the PointOfInterests.
System.Action<System.Collections.Generic.List<Location>>	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

GetPathToInfoImage(Location, PointOfInterest)

Path to the Info Image for a given location and PointOfInterest.

Declaration

public static string GetPathToInfoImage(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the given info image for the given location data.

GetPathToInfoImageDirectory(Location, PointOfInterest)

Path to the Info Image directory for a given location and PointOfInterest.

Declaration

public static string GetPathToInfoImageDirectory(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the given info directory for the given location data.

GetPathToLabelDirectory(Location, PointOfInterest)

Path to the Label Image directory for a given location and PointOfInterest.

Declaration

public static string GetPathToLabelDirectory(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the label directory for the given location data.

GetPathToLabelImage(Location, PointOfInterest)

Path to the Label Image for a given location and PointOfInterest.

Declaration

public static string GetPathToLabelImage(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the given label image for the given location data.

GetPathToLocationDirectory(Location)

Path to the container of a single Location entry.

Declaration

public static string GetPathToLocationDirectory(Location location)

Parameters

Type	Name	Description
Location	location	Given location data.

Returns

Type	Description
System.String	Full path to the location entry directory.

GetPathToMarkerImage(Location, PointOfInterest)

Path to the Marker Image for a given location and PointOfInterest.

Declaration

public static string GetPathToMarkerImage(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the given marker image for the given location data.

GetPathToMarkerImageDirectory(Location, PointOfInterest)

Path to the Marker Image directory for a given location and PointOfInterest.

Declaration

public static string GetPathToMarkerImageDirectory(Location location, PointOfInterest poi)

Parameters

Type	Name	Description
Location	location	Given location data.
PointOfInterest	poi	Given PointOfInterest.

Returns

Type	Description
System.String	Full path to the marker directory for the given location data.

LoadInfoImageToPointOfInterest(Location, PointOfInterest, Action<Sprite>)

Loads the info image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's InfoImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static void LoadInfoImageToPointOfInterest(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

LoadInfoImageToPointOfInterestProcess(Location, PointOfInterest, Action<Sprite>)

Loads the info image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's InfoImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static IEnumerator LoadInfoImageToPointOfInterestProcess(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

Returns

Type	Description
System.Collections.IEnumerator

LoadLabelImageToPointOfInterest(Location, PointOfInterest, Action<Sprite>)

Loads the label image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's LabelImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static void LoadLabelImageToPointOfInterest(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

LoadLabelImageToPointOfInterestProcess(Location, PointOfInterest, Action<Sprite>)

Loads the label image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's LabelImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static IEnumerator LoadLabelImageToPointOfInterestProcess(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

Returns

Type	Description
System.Collections.IEnumerator

LoadMarkerImageToPointOfInterest(Location, PointOfInterest, Action<Sprite>)

Loads the marker image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's MarkerImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static void LoadMarkerImageToPointOfInterest(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

LoadMarkerImageToPointOfInterestProcess(Location, PointOfInterest, Action<Sprite>)

Loads the marker image of a given point of interest into the given point of interest data. The Sprite will both be given in the callback and on the PointOfInterest's MarkerImageSprite field. If this process failed, the callback will contain a null object.

Declaration

public static IEnumerator LoadMarkerImageToPointOfInterestProcess(Location location, PointOfInterest poi, Action<Sprite> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Action<UnityEngine.Sprite>	onComplete	Occurs when the process is completed. Contains the data of the loaded Sprite.

Returns

Type	Description
System.Collections.IEnumerator

LoadPointOfInterestImages(Location, PointOfInterest, Boolean, Boolean, Boolean, Action<Boolean>)

Loads the PointOfInterest's images onto the given PointOfInterest data based on the given parameters and availability.

Declaration

public static void LoadPointOfInterestImages(Location location, PointOfInterest poi, bool loadLabelImageIfAny = true, bool loadMarkerImageIfAny = true, bool loadInfoImageIfAny = true, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Boolean	loadLabelImageIfAny	Whether or not the label image should be loaded.
System.Boolean	loadMarkerImageIfAny	Whether or not the marker image should be loaded.
System.Boolean	loadInfoImageIfAny	Whether or not hte info image should be loaded.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not all the processes successfully completed.

LoadPointOfInterestImagesProcess(Location, PointOfInterest, Boolean, Boolean, Boolean, Action<Boolean>)

Loads the PointOfInterest's images onto the given PointOfInterest data based on the given parameters and availability.

Declaration

public static IEnumerator LoadPointOfInterestImagesProcess(Location location, PointOfInterest poi, bool loadLabelImageIfAny = true, bool loadMarkerImageIfAny = true, bool loadInfoImageIfAny = true, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Location	location	Given Location data which contains the given PointOfInterest.
PointOfInterest	poi	Given PointOfInterest.
System.Boolean	loadLabelImageIfAny	Whether or not the label image should be loaded.
System.Boolean	loadMarkerImageIfAny	Whether or not the marker image should be loaded.
System.Boolean	loadInfoImageIfAny	Whether or not hte info image should be loaded.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not all the processes successfully completed.

Returns

Type	Description
System.Collections.IEnumerator

Extension Methods

ObjectExtension.ToStream(Object)