Class wrapping the 'Utilities' commands. More...

Inheritance diagram for VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands:

Public Member Functions

IAsyncResult GetCapabilities (CapabilitiesParams tCapabilitiesParams, OnResponse< BaseCommandResponse > onSuccess=null, OnResponse< BaseCommandResponse > onFail=null)

Method for getting a capabilities from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

capabilitiesParams	Capabiliites parameters
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

CameraCapabilitiesResponse GetCapabilities (CapabilitiesParams tCapabilitiesParams, TimeSpan timeout)

Method for getting a capabilities from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

capabilitiesParams	Capabiliites parameters
timeout	Time to wait the responce from the server

Returns

IAsyncResult GetConfiguration (string name, Guid id, OnResponse< GetConfigurationResponse > onSuccess=null, OnResponse< GetConfigurationResponse > onFail=null)

Method for request of a server configuration from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

name	Nameof the parameter
id	ID of the parameter
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

GetConfigurationResponse GetConfiguration (string name, Guid id, TimeSpan timeout)

Method for request of a server configuration from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns GetServerStatusResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

name	Nameof the parameter
id	ID of the parameter
timeout	Time to wait the responce from the server

Returns

IAsyncResult GetServerCapabilities (CapabilitiesParams tCapabilitiesParams, OnResponse< BaseCommandResponse > onSuccess=null, OnResponse< BaseCommandResponse > onFail=null)

Method for getting a capabilities of the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

ServerCapabilitiesResponse GetServerCapabilities (TimeSpan timeout)

Method for getting a capabilities of the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

GetServerStatusResponse GetServerStatus (GetServerStatusParams serverStatusParams, TimeSpan timeout)

Method for request of a server status from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns GetServerStatusResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

serverStatusParams	Parameters for getting server status
timeout	Time to wait the responce from the server

Returns

IAsyncResult GetServerStatus (GetServerStatusParams tServerStatusParams=null, OnResponse< GetServerStatusResponse > onSuccess=null, OnResponse< GetServerStatusResponse > onFail=null)

Method for request of a server status from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

tServerStatusParams	Parameters for getting server status
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

UtilitiesCommands (IConnection connection, Action< ServerFeatures > onServerFeatures)

Constructor.

Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesSync

Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesAsync

Properties
ErrorCodes	ErrorCode `[get]`
	Returns error code (if presents) of the last call.

string	ErrorMessage `[get]`
	Returns error string (if presents) of the last call.

Command.CommandResultTypes	Result `[get]`
	Returns error status of the last call.

Properties inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult

Detailed Description

Class wrapping the 'Utilities' commands.

See also: IErrorResult, IUtilitiesSync, IUtilitiesAsync

Constructor & Destructor Documentation

◆ UtilitiesCommands()

VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.UtilitiesCommands	(	IConnection	connection,
		Action< ServerFeatures >	onServerFeatures )

inline

Constructor.

Parameters

connection IConnection implementer

Member Function Documentation

◆ GetCapabilities() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetCapabilities	(	CapabilitiesParams	tCapabilitiesParams,
		OnResponse< BaseCommandResponse >	onSuccess = null,
		OnResponse< BaseCommandResponse >	onFail = null )

inline

Method for getting a capabilities from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

capabilitiesParams	Capabiliites parameters
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesAsync.

◆ GetCapabilities() [2/2]

CameraCapabilitiesResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetCapabilities	(	CapabilitiesParams	tCapabilitiesParams,
		TimeSpan	timeout )

inline

Method for getting a capabilities from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

capabilitiesParams	Capabiliites parameters
timeout	Time to wait the responce from the server

Returns

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesSync.

◆ GetConfiguration() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetConfiguration	(	string	name,
		Guid	id,
		OnResponse< GetConfigurationResponse >	onSuccess = null,
		OnResponse< GetConfigurationResponse >	onFail = null )

inline

Method for request of a server configuration from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

name	Nameof the parameter
id	ID of the parameter
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesAsync.

◆ GetConfiguration() [2/2]

GetConfigurationResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetConfiguration	(	string	name,
		Guid	id,
		TimeSpan	timeout )

inline

Method for request of a server configuration from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns GetServerStatusResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

name	Nameof the parameter
id	ID of the parameter
timeout	Time to wait the responce from the server

Returns

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesSync.

◆ GetServerCapabilities() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetServerCapabilities	(	CapabilitiesParams	capabilitiesParams,
		OnResponse< BaseCommandResponse >	onSuccess = null,
		OnResponse< BaseCommandResponse >	onFail = null )

inline

Method for getting a capabilities of the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

capabilitiesParams
onSuccess
onFail

Returns

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesAsync.

◆ GetServerCapabilities() [2/2]

ServerCapabilitiesResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetServerCapabilities ( TimeSpan timeout )

inline

Method for getting a capabilities of the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

timeout

Returns

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesSync.

◆ GetServerStatus() [1/2]

GetServerStatusResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetServerStatus	(	GetServerStatusParams	serverStatusParams,
		TimeSpan	timeout )

inline

Method for request of a server status from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the server and returns GetServerStatusResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

serverStatusParams	Parameters for getting server status
timeout	Time to wait the responce from the server

Returns

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesSync.

◆ GetServerStatus() [2/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.GetServerStatus	(	GetServerStatusParams	tServerStatusParams = null,
		OnResponse< GetServerStatusResponse >	onSuccess = null,
		OnResponse< GetServerStatusResponse >	onFail = null )

inline

Method for request of a server status from the Mobile Server.

Implemented by UtilititesCommands object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters

tServerStatusParams	Parameters for getting server status
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IUtilitiesAsync.

Property Documentation

◆ ErrorCode

ErrorCodes VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.ErrorCode

get

Returns error code (if presents) of the last call.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult.

◆ ErrorMessage

string VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.ErrorMessage

get

Returns error string (if presents) of the last call.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult.

◆ Result

Command.CommandResultTypes VideoOS.Mobile.SDK.Portable.Server.Base.Connection.UtilitiesCommands.Result

get

Returns error status of the last call.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ UtilitiesCommands()

Member Function Documentation

◆ GetCapabilities() [1/2]

◆ GetCapabilities() [2/2]

◆ GetConfiguration() [1/2]

◆ GetConfiguration() [2/2]

◆ GetServerCapabilities() [1/2]

◆ GetServerCapabilities() [2/2]

◆ GetServerStatus() [1/2]

◆ GetServerStatus() [2/2]

Property Documentation

◆ ErrorCode

◆ ErrorMessage

◆ Result