Class Client

Namespace: KartaViewSharp.V2

Assembly: KartaViewSharp.dll

public class Client

Inheritance: object

Client

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Client()

public Client()

Methods

CreateANewDedicatedCampaign(string)

public Task<object> CreateANewDedicatedCampaign(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateANewDedicatedCampaignCell(string)

public Task<object> CreateANewDedicatedCampaignCell(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateANewPhoto(string)

public Task<PhotoResponse> CreateANewPhoto(string authToken)

Parameters

authToken string

Returns

Task<PhotoResponse>

Exceptions

NotImplementedException: Not currently implemented

CreateANewPhotoPart(string)

public Task<object> CreateANewPhotoPart(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateANewSequence(string)

public Task<SequenceResponse> CreateANewSequence(string authToken)

Parameters

authToken string

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

CreateANewSequenceAttachment(string)

public Task<object> CreateANewSequenceAttachment(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateANewSequenceRawdata(string)

public Task<object> CreateANewSequenceRawdata(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateANewVideo(string)

public Task<object> CreateANewVideo(string authToken)

Parameters

authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

CreateTasksToBlurPhotosWhenDetectionsArePresent()

public Task<object> CreateTasksToBlurPhotosWhenDetectionsArePresent()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteADedicatedCampaign(int)

public Task<object> DeleteADedicatedCampaign(int dedicatedCampaignId)

Parameters

dedicatedCampaignId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteADedicatedCampaignCell(int)

public Task<object> DeleteADedicatedCampaignCell(int dedicatedCampaignCellId)

Parameters

dedicatedCampaignCellId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteAPhoto(int)

public Task<PhotoResponse> DeleteAPhoto(int photoId)

Parameters

photoId int

Returns

Task<PhotoResponse>

Exceptions

NotImplementedException: Not currently implemented

DeleteAPhotoPart(int)

public Task<object> DeleteAPhotoPart(int photoPartId)

Parameters

photoPartId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteASequence(int)

public Task<SequenceResponse> DeleteASequence(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

DeleteASequenceAttachment(int)

public Task<object> DeleteASequenceAttachment(int sequenceAttachementId)

Parameters

sequenceAttachementId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteASequenceRawdata(int)

public Task<object> DeleteASequenceRawdata(int sequenceRawDataId)

Parameters

sequenceRawDataId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

DeleteAVideo(int)

public Task<object> DeleteAVideo(int videoId)

Parameters

videoId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

FindAndUpdateSequencesStatusWhenTheUploadIsFinished(int)

public Task<SequenceResponse> FindAndUpdateSequencesStatusWhenTheUploadIsFinished(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

GetAListOfAllTracksBasedOnASpecificBoundingBox(Coordinate, Coordinate, int)

public Task<SequenceResponse> GetAListOfAllTracksBasedOnASpecificBoundingBox(Coordinate topLeft, Coordinate bottomRight, int zoomLevel)

Parameters

topLeft Coordinate
bottomRight Coordinate
zoomLevel int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

GetMapMatchedTracksDataWithDifferentOutput(int, int, int)

public Task<SequenceResponse> GetMapMatchedTracksDataWithDifferentOutput(int tileX, int tileY, int zoomLevel)

Parameters

tileX int
tileY int
zoomLevel int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

GetMetricsDataBasedOnMetricType()

public Task<object> GetMetricsDataBasedOnMetricType()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetPlatformMetricIntervalData(PhotosCountMetric[])

public Task<object> GetPlatformMetricIntervalData(PhotosCountMetric[] photosCountMetrics)

Parameters

photosCountMetrics PhotosCountMetric[]

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetPlatformMetricIntervalData(PlatformMetric[])

public Task<object> GetPlatformMetricIntervalData(PlatformMetric[] platformMetrics)

Parameters

platformMetrics PlatformMetric[]

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheBreakdownDetailsOfASequence(int)

public Task<object> GetTheBreakdownDetailsOfASequence(int sequenceId)

Parameters

sequenceId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfADedicatedCampaign(int)

public Task<object> GetTheDetailsOfADedicatedCampaign(int dedicatedCampaignId)

Parameters

dedicatedCampaignId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfADedicatedCampaignCell(int)

public Task<object> GetTheDetailsOfADedicatedCampaignCell(int dedicatedCampaignCellId)

Parameters

dedicatedCampaignCellId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfAPhoto(int)

public Task<PhotoResponse> GetTheDetailsOfAPhoto(int photoId)

Parameters

photoId int

Returns

Task<PhotoResponse>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfAPhotoPart(int)

public Task<object> GetTheDetailsOfAPhotoPart(int photoPartId)

Parameters

photoPartId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfARegion(int)

public Task<object> GetTheDetailsOfARegion(int dashboardRegionId)

Parameters

dashboardRegionId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfASequence(int, SequenceJoinResource[]?)

public Task<SequenceDetailsResponse> GetTheDetailsOfASequence(int sequenceId, SequenceJoinResource[]? join)

Parameters

sequenceId int
join SequenceJoinResource[]

Returns

Task<SequenceDetailsResponse>

GetTheDetailsOfASequenceAttachment(int)

public Task<object> GetTheDetailsOfASequenceAttachment(int sequenceAttachmentId)

Parameters

sequenceAttachmentId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfASequenceRawdata(int)

public Task<object> GetTheDetailsOfASequenceRawdata(int sequenceRawDataId)

Parameters

sequenceRawDataId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfAUser(int)

public Task<object> GetTheDetailsOfAUser(int dashboardUserId)

Parameters

dashboardUserId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfAVideo(int)

public Task<object> GetTheDetailsOfAVideo(int videoId)

Parameters

videoId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheDetailsOfAnIssue(int)

public Task<object> GetTheDetailsOfAnIssue(int dashboardIssueId)

Parameters

dashboardIssueId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTheMetricsDetailsOfAUser(int)

public Task<object> GetTheMetricsDetailsOfAUser(int userId)

Parameters

userId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetTotalDistanceMetricIntervalData()

public Task<object> GetTotalDistanceMetricIntervalData()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetUniqueDistanceMetricIntervalData()

public Task<object> GetUniqueDistanceMetricIntervalData()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

GetUserTypeMetricIntervalData(UserTypeMetric[], DashboardQueryFilters)

public Task<object> GetUserTypeMetricIntervalData(UserTypeMetric[] userTypeMetrics, DashboardQueryFilters filters)

Parameters

userTypeMetrics UserTypeMetric[]: Available metrics for user type. Multiple metrics will be separate by ,. Can be combined with other metric types in the same request.
filters DashboardQueryFilters

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

NotifyApolloWhenASequenceHasBeenProcessed()

public Task<object> NotifyApolloWhenASequenceHasBeenProcessed()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveAllPhotoPartsBasedOnThePhotoId(int)

public Task<PhotoResponse> RetrieveAllPhotoPartsBasedOnThePhotoId(int photoId)

Parameters

photoId int

Returns

Task<PhotoResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveDedicatedCampaigns()

public Task<object> RetrieveDedicatedCampaigns()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveIntervalMetricsUsedForDashboardCharts(int)

public Task<object> RetrieveIntervalMetricsUsedForDashboardCharts(int dedicatedCampaignId)

Parameters

dedicatedCampaignId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveIssues()

public Task<object> RetrieveIssues()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveMaintenances()

public Task<object> RetrieveMaintenances()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrievePhotoParts()

public Task<object> RetrievePhotoParts()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrievePhotos(PhotoQueryFilters)

public Task<PhotoResponse> RetrievePhotos(PhotoQueryFilters filters)

Parameters

filters PhotoQueryFilters

Returns

Task<PhotoResponse>

RetrievePhotosBasedOnTheSequenceId(int)

public Task<SequenceResponse> RetrievePhotosBasedOnTheSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceAttachments()

public Task<object> RetrieveSequenceAttachments()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceAttachmentsBasedOnSequenceId(int)

public Task<SequenceResponse> RetrieveSequenceAttachmentsBasedOnSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceBreakdowns()

public Task<object> RetrieveSequenceBreakdowns()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceBreakdownsBasedOnSequenceId(int)

public Task<SequenceResponse> RetrieveSequenceBreakdownsBasedOnSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceMetricsBasedOnSequenceId(int)

public Task<SequenceResponse> RetrieveSequenceMetricsBasedOnSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceRawdatas()

public Task<object> RetrieveSequenceRawdatas()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequenceRawdatasBasedOnSequenceId(int)

public Task<SequenceResponse> RetrieveSequenceRawdatasBasedOnSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequences()

public Task<object> RetrieveSequences()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveSequences(SequenceQueryFilters)

public Task<SequenceResponse> RetrieveSequences(SequenceQueryFilters filters)

Parameters

filters SequenceQueryFilters

Returns

Task<SequenceResponse>

RetrieveTheCellsOfADedicatedCampaign(int)

public Task<object> RetrieveTheCellsOfADedicatedCampaign(int dedicatedCampaignId)

Parameters

dedicatedCampaignId int

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveVideos()

public Task<object> RetrieveVideos()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

RetrieveVideosBasedOnTheSequenceId(int)

public Task<SequenceResponse> RetrieveVideosBasedOnTheSequenceId(int sequenceId)

Parameters

sequenceId int

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

RetrieveVisibleRegions()

public Task<object> RetrieveVisibleRegions()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

TestTheBlurImagesFunctionalityIgnoringDetections()

public Task<object> TestTheBlurImagesFunctionalityIgnoringDetections()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

TestTheBlurImagesFunctionalityIncludingTheApolloDetectionsPipeline()

public Task<object> TestTheBlurImagesFunctionalityIncludingTheApolloDetectionsPipeline()

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfADedicatedCampaign(int, string)

public Task<object> UpdateTheDetailsOfADedicatedCampaign(int dedicatedCampaignId, string authToken)

Parameters

dedicatedCampaignId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfADedicatedCampaignCell(int, string)

public Task<object> UpdateTheDetailsOfADedicatedCampaignCell(int dedicatedCampaignCellId, string authToken)

Parameters

dedicatedCampaignCellId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfAPhoto(int, string)

public Task<PhotoResponse> UpdateTheDetailsOfAPhoto(int photoId, string authToken)

Parameters

photoId int
authToken string

Returns

Task<PhotoResponse>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfAPhotoPart(int, string)

public Task<object> UpdateTheDetailsOfAPhotoPart(int photoPartId, string authToken)

Parameters

photoPartId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfASequence(int, string)

public Task<SequenceResponse> UpdateTheDetailsOfASequence(int sequenceId, string authToken)

Parameters

sequenceId int
authToken string

Returns

Task<SequenceResponse>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfASequenceAttachment(int, string)

public Task<object> UpdateTheDetailsOfASequenceAttachment(int sequenceAttachmentId, string authToken)

Parameters

sequenceAttachmentId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfASequenceRawdata(int, string)

public Task<object> UpdateTheDetailsOfASequenceRawdata(int sequenceRawDataId, string authToken)

Parameters

sequenceRawDataId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

UpdateTheDetailsOfAVideo(int, string)

public Task<object> UpdateTheDetailsOfAVideo(int videoId, string authToken)

Parameters

videoId int
authToken string

Returns

Task<object>

Exceptions

NotImplementedException: Not currently implemented

Table of Contents

Class Client

Constructors

Client()

Methods

CreateANewDedicatedCampaign(string)

Parameters

Returns

Exceptions

CreateANewDedicatedCampaignCell(string)

Parameters

Returns

Exceptions

CreateANewPhoto(string)

Parameters

Returns

Exceptions

CreateANewPhotoPart(string)

Parameters

Returns

Exceptions

CreateANewSequence(string)

Parameters

Returns

Exceptions

CreateANewSequenceAttachment(string)

Parameters

Returns

Exceptions

CreateANewSequenceRawdata(string)

Parameters

Returns

Exceptions

CreateANewVideo(string)

Parameters

Returns

Exceptions

CreateTasksToBlurPhotosWhenDetectionsArePresent()

Returns

Exceptions

DeleteADedicatedCampaign(int)

Parameters

Returns

Exceptions

DeleteADedicatedCampaignCell(int)

Parameters

Returns

Exceptions

DeleteAPhoto(int)

Parameters

Returns

Exceptions

DeleteAPhotoPart(int)

Parameters

Returns

Exceptions

DeleteASequence(int)

Parameters

Returns

Exceptions

DeleteASequenceAttachment(int)

Parameters

Returns

Exceptions

DeleteASequenceRawdata(int)

Parameters

Returns

Exceptions

DeleteAVideo(int)

Parameters

Returns

Exceptions

FindAndUpdateSequencesStatusWhenTheUploadIsFinished(int)

Parameters

Returns

Exceptions

GetAListOfAllTracksBasedOnASpecificBoundingBox(Coordinate, Coordinate, int)

Parameters

Returns

Exceptions