VideoOS.Platform.Transact.Services.Client.ITransactQueryClient Interface Reference

This interface is responsible for the operations needed to query the Transact service and get information on the data recorded. More...

Inheritance diagram for VideoOS.Platform.Transact.Services.Client.ITransactQueryClient:

Public Member Functions
void	Close ()
	Shut down the client and clean up resources.
Task< GetExtendedTransactionLinesResult >	GetExtendedTransactionLinesAsync (GetExtendedTransactionLinesParameters parameters)
	Get a number of transaction lines matching the provided parameters.
Task< GetTransactionLinesResult >	GetLinesForSourceByLineIdAsync (GetLinesForSourceByLineIdParameters parameters)
	Get a number of lines for a source before and after a particular line.
Task< GetTransactionLinesResult >	GetLinesForSourceByTimeAsync (GetLinesForSourceByTimeParameters parameters)
	Get a number of lines for a source before and after a timestamp.
Task< GetTransactionLinesResult >	GetLinesForTransactionAsync (GetLinesForTransactionParameters parameters)
	Get all lines for a transaction.
Task< GetLiveLinesResult >	GetLiveLinesAsync (GetLiveLinesParameters parameters)
	Get the transaction lines added in the specified session since last time this method was called. The call will hang until either at least one transaction line can be returned or the specified timeout expires.
Task< GetTransactionsInfoResult >	GetTransactionsInfoAsync (GetTransactionsInfoParameters parameters)
	Get all transaction infos matching the provided parameters.
Task< StartLiveSessionResult >	StartLiveSessionAsync (StartLiveSessionParameters parameters)
	Start a live session on the specified source and fetch the specified number of preceding transaction lines. Use the returned session id when calling GetLiveLinesAsync and StopLiveSessionAsync.
Task< StopLiveSessionResult >	StopLiveSessionAsync (StopLiveSessionParameters parameters)
	Stop a live session, which was started using StartLiveSessionAsync.

Detailed Description

This interface is responsible for the operations needed to query the Transact service and get information on the data recorded.

Member Function Documentation

Close()

void VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.Close

(

)

Shut down the client and clean up resources.

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetExtendedTransactionLinesAsync()

Task< GetExtendedTransactionLinesResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetExtendedTransactionLinesAsync

(

GetExtendedTransactionLinesParameters

parameters

)

Get a number of transaction lines matching the provided parameters.

Parameters

parameters

Returns

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetLinesForSourceByLineIdAsync()

Task< GetTransactionLinesResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetLinesForSourceByLineIdAsync

(

GetLinesForSourceByLineIdParameters

parameters

)

Get a number of lines for a source before and after a particular line.

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetLinesForSourceByTimeAsync()

Task< GetTransactionLinesResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetLinesForSourceByTimeAsync

(

GetLinesForSourceByTimeParameters

parameters

)

Get a number of lines for a source before and after a timestamp.

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetLinesForTransactionAsync()

Task< GetTransactionLinesResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetLinesForTransactionAsync

(

GetLinesForTransactionParameters

parameters

)

Get all lines for a transaction.

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetLiveLinesAsync()

Task< GetLiveLinesResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetLiveLinesAsync

(

GetLiveLinesParameters

parameters

)

Get the transaction lines added in the specified session since last time this method was called. The call will hang until either at least one transaction line can be returned or the specified timeout expires.

Parameters

parameters

Returns

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

GetTransactionsInfoAsync()

Task< GetTransactionsInfoResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.GetTransactionsInfoAsync

(

GetTransactionsInfoParameters

parameters

)

Get all transaction infos matching the provided parameters.

Parameters

parameters

Returns

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

StartLiveSessionAsync()

Task< StartLiveSessionResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.StartLiveSessionAsync

(

StartLiveSessionParameters

parameters

)

Start a live session on the specified source and fetch the specified number of preceding transaction lines. Use the returned session id when calling GetLiveLinesAsync and StopLiveSessionAsync.

Parameters

parameters

Returns

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.

StopLiveSessionAsync()

Task< StopLiveSessionResult > VideoOS.Platform.Transact.Services.Client.ITransactQueryClient.StopLiveSessionAsync

(

StopLiveSessionParameters

parameters

)

Stop a live session, which was started using StartLiveSessionAsync.

Parameters

parameters

Returns

Implemented in VideoOS.Platform.Transact.Services.Client.TransactQueryClient.