HIDIA.Transaction.IDevice Interface Reference

Enables management of the transactions. More...

Public Member Functions
Task< IContainer >	CreateContainer (ContainerInitialization config, char[] sessionPassword, IHIDProgress< IProgressEvent > progressListener)
	Triggers the container activation process to create a new container. More...
Task	DeleteContainer (int containerId, char[] sessionPassword, String reason="user")
	Deletes the container with the specified identifier. More...
Task< IList< IContainer > >	FindContainers (IList< Parameter > filter)
	Finds containers matching the specified filter. More...
Task< string >	GetDeviceInfo (string name)
	Gets the device information. More...
Task< IServerActionInfo >	RetrieveActionInfo (string actionId)
	Retrieves and decodes an encrypted "server action" message received from the server. More...

Properties
ConnectionConfiguration	ConnectionConfiguration [get, set]
	ConnectionConfiguration currently used to connect to servers. More...
string	Version [get]
	Version of the SDK. More...

Detailed Description

Enables management of the transactions.

Member Function Documentation

CreateContainer()

Task<IContainer> HIDIA.Transaction.IDevice.CreateContainer	(	ContainerInitialization	config,
		char []	sessionPassword,
		IHIDProgress< IProgressEvent >	progressListener
	)

Triggers the container activation process to create a new container.

Parameters

config	The initialization configuration see ContainerInitialization for details.
sessionPassword	Transaction protection key password (can be null if not required by the policy).
progressListener	Instance of IHIDProgress<T> to which report progress or receive password request events.

Returns

The newly created container instance.

Exceptions

AuthenticationException	if the given session password is incorrect or locked.
InternalException	if an unexpected error occurred.
InvalidPasswordException	if the given password does not match the required policy constraints.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
PasswordCancelledException	if the password prompt dialog has been cancelled by the user.
PasswordExpiredException	if an expired password is given (changePassword required)
RemoteException	if server responds with any other error.
ServerAuthenticationException	if the server raises an error.

DeleteContainer()

Task HIDIA.Transaction.IDevice.DeleteContainer	(	int	containerId,
		char []	sessionPassword,
		String	reason = "user"
	)

Deletes the container with the specified identifier.

Parameters

containerId	The identifier of the container.
sessionPassword	Transaction protection key password (can be null if not required by the policy).
reason	Optional parameter to specify the container suppression reason.

Exceptions

AuthenticationException	if the given session password is incorrect or locked.
InternalException	if an unexpected error occurred.
InvalidPasswordException	if the given password does not match the required policy constraints.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
PasswordExpiredException	if an expired password is given (changePassword required)

FindContainers()

Task<IList<IContainer> > HIDIA.Transaction.IDevice.FindContainers

(

IList< Parameter >

filter

)

Finds containers matching the specified filter.

Parameters

filter

Array of parameters providing search criteria. It can be: Constants.CONTAINER_NAME: Friendly Name of the container. Constants.CONTAINER_URL: URL of server associated with the container. Constants.CONTAINER_USERID: Identifier of the container.

Returns

The list of containers matching the filter.

Exceptions

InternalException	if an unexpected error occurred.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.

GetDeviceInfo()

Task<string> HIDIA.Transaction.IDevice.GetDeviceInfo

(

string

name

)

Gets the device information.

Parameters

name	The property identifier.

Returns

The info value.

Allowed property ids are defined in Constants:

• Constants.DEVICE_INFO_BRAND: Device Brand Name (for example, "microsoft").
• Constants.DEVICE_INFO_MANUFACTURER: Device Manufacturer Name
• Constants.DEVICE_INFO_MODEL: Device Model
• Constants.DEVICE_INFO_NAME: Device Name. It is set to "Manufacturer | Model" by default, and replaced by the device friendly name sent by the server during a synchronize operation.
• Constants.DEVICE_INFO_OS: Operating System Name (for example, "Windows Phone").
• Constants.DEVICE_INFO_OS_NAME: Operating System Name
• Constants.DEVICE_INFO_OS_VERSION: Operating System Version Number
• Constants.DEVICE_INFO_PRODUCT: Device Product Name

Note that Constants.DEVICE_INFO_PUSHID cannot be retrieved because it is not stored: only the application can have an up-to-date value.

Exceptions

InternalException	if an unexpected error occurred.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.

RetrieveActionInfo()

Task<IServerActionInfo> HIDIA.Transaction.IDevice.RetrieveActionInfo

(

string

actionId

)

Retrieves and decodes an encrypted "server action" message received from the server.

Parameters

actionId

The message received in push notification..

Returns

A IServerActionInfo instance.

Exceptions

InternalException	if an unexpected error occurred.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
TransactionContainerInvalidException	if the action id refers to a container that does not exist.

Property Documentation

ConnectionConfiguration

ConnectionConfiguration HIDIA.Transaction.IDevice.ConnectionConfiguration

getset

ConnectionConfiguration currently used to connect to servers.

Version

string HIDIA.Transaction.IDevice.Version

get

Version of the SDK.