Caplin Trader 5.1.0

Interface: module:ct-trading/service/TOBOUserServiceListener

module:ct-trading/service/TOBOUserServiceListener

The TOBOUserServiceListener interface — this should never be constructed.

The TOBOUserServiceListener is the interface designed to be implemented by listeners of the module:ct-trading/service/TOBOUserService. It consists of all the callbacks triggered by the ToboUserService to notify listeners when new TOBO permissions are received or when the TOBO user and account are changed.

Methods

onLockChanged(bLocked)

This method is called when the selected TOBO user/account can or cannot be changed due to an ongoing trade or the connection to the server being down.

Parameters:
Name Type Description
bLocked Boolean

True/False.

onTOBOAccountChanged(sAccount)

This method is called when there is a change in the TOBO user's account being used by the logged-in user to trade on behalf of the selected TOBO user.

Parameters:
Name Type Description
sAccount String

The account name.

onTOBOAccountListChanged(pAccountList)

This method is called when there is a change in the list of the currently selected TOBO user's accounts that the logged-in user can use to trade on behalf of the selected TOBO user.

Parameters:
Name Type Description
pAccountList Array

A String array containing the new list of accounts.

onTOBOUserChanged(sUser)

This method is called when there is a change in the TOBO user whom the logged-in user is trading on behalf of.

Parameters:
Name Type Description
sUser String

The TOBO user's userName.

onTOBOUserListChanged(pUserList)

This method is called when there is a change in the list of TOBO users which the logged-in user can trade on behalf of.

Parameters:
Name Type Description
pUserList Array

A String array containing the new list of users.

onUserTypeChanged(sUserType)

This method is called when the type of the logged-in user is changed.

Parameters:
Name Type Description
sUserType String

The user type.