Previous Topic

Next Topic

Book Contents

Book Index

CF_SetPlayerProperties

This web service modifies the currently established player properties. These properties control what launch configuration values are transmitted by OLSA to the SCP for any SCP-based content, for example, Business Skills, IT, launched via the Asset Integration Referral Object launch URL mechanism. To get the list of available properties the caller must invoke CF_GetPlayerProperties.

To set one or more available properties the caller should extract the desired subset of properties from the CF_GetPlayerProperties XML response. For each property the caller wants to set, update the property's value and enabled status. This modified subset XML must then be specified as the player_properties argument below in the call to CF_SetPlayerProperties.

A property must have its enabled attribute set to 1 for the value to be sent to the Player at launch time. The caller must not add properties beyond the available set. The caller must not change the name or type of an available property.

For example, if CF_GetPlayerProperties returns as a response:

<player_properties>

<property name=”a” type=”text” enabled=”0”>item</property>

<property name=”b” type=”integer” enabled=”0”>99</property>

<property name=”c” type=”boolean” enabled=”0”>true</property>

</player_properties>

You can set the property “b” to the value 100 and enable it by sending this as the SCP properties value to CF_SetPlayerProperties:

<player_properties>

<property name=”b” type=”integer” enabled=”1>100</property>

</player_properties>

Inputs

Outputs

Additional Faults