Milestone SDK Mobile .Net
VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands Class Reference

Class wrapping Views related commands. More...

Inheritance diagram for VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands:
VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsSync VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsAsync VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsAwait

Public Member Functions

IAsyncResult GetItems (ItemParams itemParams, OnResponse< GetAllItemsResponse > onSuccess=null, OnResponse< GetAllItemsResponse > onFail=null)
 Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by ItemCommands object.
Sends message to the Mobile 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
itemParamsParameters for the current command
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

 
GetAllItemsResponse GetItems (ItemParams itemParams, TimeSpan timeout)
 Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by ItemCommands object.
Sends message to the Mobile server and returns GetSubItemsResponse.
If method doesn't succeed GetSubItemsResponse is null.
Error status message could be obtained with query of IErrorResult.
Parameters
itemParamsParameters for the current command
timeoutTime to wait the responce from the server
Returns
GetAllItemsResponse object

 
async Task< GetAllItemsResponseGetItemsAsync (ItemParams itemParams, TimeSpan timeout)
 Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by Views object.
Sends message to the Mobile server and returns Task<GetSubItemsResponse>.
If method doesn't succeed GetSubItemsResponse is null.
Error status message could be obtained with query of IErrorResult.
Parameters
itemParamsParameters for the current command
timeoutTime to wait the responce from the server.
Returns
Task<GetSubItemsResponse> object.

 
 ItemCommands (IConnection connection)
 
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsSync
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsAsync
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IItemsAwait

Detailed Description

Class wrapping Views related commands.

See also
IItemsSync, IItemsAsync, IItemsAwait

Constructor & Destructor Documentation

◆ ItemCommands()

VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands.ItemCommands ( IConnection connection)
inline

Member Function Documentation

◆ GetItems() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands.GetItems ( ItemParams itemParams,
OnResponse< GetAllItemsResponse > onSuccess = null,
OnResponse< GetAllItemsResponse > onFail = null )
inline

Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by ItemCommands object.
Sends message to the Mobile 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
itemParamsParameters for the current command
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

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

◆ GetItems() [2/2]

GetAllItemsResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands.GetItems ( ItemParams itemParams,
TimeSpan timeout )
inline

Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by ItemCommands object.
Sends message to the Mobile server and returns GetSubItemsResponse.
If method doesn't succeed GetSubItemsResponse is null.
Error status message could be obtained with query of IErrorResult.

Parameters
itemParamsParameters for the current command
timeoutTime to wait the responce from the server
Returns
GetAllItemsResponse object

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

◆ GetItemsAsync()

async Task< GetAllItemsResponse > VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ItemCommands.GetItemsAsync ( ItemParams itemParams,
TimeSpan timeout )
inline

Method for request of a sub view items of a current view item from the Mobile Server.

Implemented by Views object.
Sends message to the Mobile server and returns Task<GetSubItemsResponse>.
If method doesn't succeed GetSubItemsResponse is null.
Error status message could be obtained with query of IErrorResult.

Parameters
itemParamsParameters for the current command
timeoutTime to wait the responce from the server.
Returns
Task<GetSubItemsResponse> object.

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