Caplin SL4B SDK 4.5.4

Class SL4B_AbstractSubscriber

Object
   |
   +--SL4B_AbstractSubscriber
Direct Known Subclasses:
LF_RtmlSubscriber, SL4B_ProxySubscriber, LF_ContributionSubscriber, LF_RtslSubscriber, LF_NullSubscriptionManager

class SL4B_AbstractSubscriber


Base class that must be extended by any class that is interested in receiving notifications of updates to RTTP objects stored in a Liberator. The type of notification that will be received depends on whether a valid object has been requested, whether the user has permission to view the object, and what the type of the object is.

A subscription must be made via an implementation of the SL4B_AbstractRttpProvider class. The SL4B_Accessor.getRttpProvider() singleton method should be used to get a reference to the concrete RTTP provider that has been specified for the web page.

All subclasses must invoke the SL4B_AbstractSubscriber.initialise() method within their constructor. It is strongly recommended that it is only invoked after the constructor has initialised the object instance, since the ready() callback may be invoked as part of this initialise call.


Constructor Summary
SL4B_AbstractSubscriber ()
            Constructs a new SL4B_AbstractSubscriber.
 
Method Summary
 void chat(<String> l_sObjectName, <String> l_sTime, <String> l_sUsername, <String> l_sMessage, <int> l_nStatus)
           Invoked when a message has been contributed to the specified RTTP chat object which has been subscribed to.
 void contribFailed(<String> l_sObjectName, <String> l_sReason, <int> l_nAuthCode)
           Invoked after an attempt to contribute data to the specified RTTP object has failed.
 void contribOk(<String> l_sObjectName)
           Invoked after an attempt to contribute data to the specified RTTP object has been successful.
 void directoryMultiUpdated(l_sDirObjectName, <SL4B_RecordFieldData> l_oFieldData)
           Invoked when a several field updates occur at the same time for an RTTP record object that has been subscribed to.
 void directoryUpdated(<String> l_sDirObjectName, <String> l_sObjectName, <int> l_nType, <boolean> l_bAdded)
           Invoked when the contents of an RTTP directory object that has been subscribed to change.
 void fieldDeleted(<String> l_sObjectName, <String> l_sFieldName, <String> l_sMarketMakerId)
           Invoked when a field is deleted from an RTTP record object which has been subscribed to.
 void initialise()
           Initialises the member variables for the SL4B_AbstractSubscriber.
 void newsUpdated(<String> l_sObjectName, <String> l_sStoryCode, <String> l_sHeadline, <String> l_sDate)
           Invoked when an update is generated for an RTTP news headline object which has been subscribed to.
 void objectDeleted(<String> l_sObjectName)
           Invoked when an object that has been subscribed to is deleted from the Liberator.
 void objectInfo(<String> l_sObjectName, <int> l_nType, <String> l_sParameter, <String> l_sValue)
           Invoked when an generic informational message is generated for an RTTP object that has been subscribed to.
 void objectNotFound(<String> l_sObjectName)
           Invoked when an RTTP object that has been subscribed to is not found on the Liberator (i.e.
 void objectNotStale(<String> l_sObjectName, <String> l_sFieldName)
           Invoked when the value of a field of an RTTP object that has been subscribed to is no longer stale.
 void objectReadDenied(<String> l_sObjectName, <int> l_nAuthCode)
           Invoked when the user does not have permission to view an RTTP object that has been subscribed to.
 void objectStale(<String> l_sObjectName, <String> l_sFieldName)
           Invoked when the value of a field of an RTTP object that has been subscribed to is stale.
 void objectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)
           Invoked when the status of an RTTP object that has been subscribed to changes (e.g.
 void objectType(<String> l_sObjectName, <int> l_nRttpType, <int> l_nDataSourceType)
           Invoked when an update for the type of an RTTP object that has been subscribed to is received.
 void objectUnavailable(<String> l_sObjectName)
           Invoked when an RTTP object that has been subscribed to is unavailable from the Liberator.
 void objectUpdated(<String> l_sObjectName)
           Invoked when a generic object update is received for an RTTP object that has been subscribed to.
 void objectWriteDenied(<String> l_sObjectName, <int> l_nAuthCode)
           Invoked when the user does not have permission to contribute (write) data to an RTTP object that has been subscribed to.
 void pageUpdated(<String> l_sObjectName, <int> l_nColumn, <int> l_nRow, <String> l_sPageData, <int> l_nUpdate)
           Invoked when a update is received for an RTTP page object that has been subscribed to.
 void permissionDeleted(<String> l_sObjectName, <String> l_sKeyName)
           Invoked when either a delete entry or a clear all entries message is received for an RTTP permission object that has been subscribed to.
 void permissionUpdated(<String> l_sObjectName, <String> l_sKeyName, <SL4B_RecordFieldData> l_oFieldData)
           Invoked when an upate is received for an RTTP permission object that has been subscribed to.
 void ready()
           Invoked once the SL4B_AbstractRttpProvider has successfully logged into a Liberator.
 void recordMultiUpdated(<String> l_sObjectName, <SL4B_RecordFieldData> l_oFieldData, l_bIsCachedImage)
           Invoked when a several field updates occur at the same time for an RTTP record object that has been subscribed to.
 void recordUpdated(<String> l_sObjectName, <String> l_sFieldName, <String> l_sValue)
           Invoked when a field is updated for an RTTP record object that has been subscribed to.
 void storyReset(<String> l_sObjectName)
           Invoked when a reset message is received for an RTTP news story object that has been subscribed to.
 void storyUpdated(<String> l_sObjectName, <String> l_sStoryText)
           Invoked when an update is received for an RTTP news story object that has been subscribed to.
 void structureChange(<String> l_sContainerName, <String> l_sObjectName, <String> l_sObjectType, <boolean> l_bAdded)
          

Invoked when the structure of a container or auto directory changes.

 void structureMultiChange(<String> l_sContainerName, <Array> l_pContainerStructureChanges, <Array> l_pOrderChanges, <int> l_nContainerSize)
          

Invoked when the structure of a container changes, returns multiple structure changes plus ordering and size information.

 void type2Clear(<String> l_sObjectName)
           Invoked when a type 2 clear update is received for a RTTP record object which has been subscribed to.
 void type3Clear(<String> l_sObjectName)
           Invoked when a type 3 clear update is received for a RTTP record object which has been subscribed to.
 void WTObjectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)
           Invoked when the status of an RTTP object that has been subscribed to changes.

Constructor Detail

SL4B_AbstractSubscriber

SL4B_AbstractSubscriber()

Method Detail

chat

void chat(<String> l_sObjectName, <String> l_sTime, <String> l_sUsername, <String> l_sMessage, <int> l_nStatus)

contribFailed

void contribFailed(<String> l_sObjectName, <String> l_sReason, <int> l_nAuthCode)

contribOk

void contribOk(<String> l_sObjectName)

directoryMultiUpdated

void directoryMultiUpdated(l_sDirObjectName, <SL4B_RecordFieldData> l_oFieldData)

directoryUpdated

void directoryUpdated(<String> l_sDirObjectName, <String> l_sObjectName, <int> l_nType, <boolean> l_bAdded)

fieldDeleted

void fieldDeleted(<String> l_sObjectName, <String> l_sFieldName, <String> l_sMarketMakerId)

initialise

void initialise()

newsUpdated

void newsUpdated(<String> l_sObjectName, <String> l_sStoryCode, <String> l_sHeadline, <String> l_sDate)

objectDeleted

void objectDeleted(<String> l_sObjectName)

objectInfo

void objectInfo(<String> l_sObjectName, <int> l_nType, <String> l_sParameter, <String> l_sValue)

objectNotFound

void objectNotFound(<String> l_sObjectName)

objectNotStale

void objectNotStale(<String> l_sObjectName, <String> l_sFieldName)

objectReadDenied

void objectReadDenied(<String> l_sObjectName, <int> l_nAuthCode)

objectStale

void objectStale(<String> l_sObjectName, <String> l_sFieldName)

objectStatus

void objectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)

objectType

void objectType(<String> l_sObjectName, <int> l_nRttpType, <int> l_nDataSourceType)

objectUnavailable

void objectUnavailable(<String> l_sObjectName)

objectUpdated

void objectUpdated(<String> l_sObjectName)

objectWriteDenied

void objectWriteDenied(<String> l_sObjectName, <int> l_nAuthCode)

pageUpdated

void pageUpdated(<String> l_sObjectName, <int> l_nColumn, <int> l_nRow, <String> l_sPageData, <int> l_nUpdate)

permissionDeleted

void permissionDeleted(<String> l_sObjectName, <String> l_sKeyName)

permissionUpdated

void permissionUpdated(<String> l_sObjectName, <String> l_sKeyName, <SL4B_RecordFieldData> l_oFieldData)

ready

void ready()

recordMultiUpdated

void recordMultiUpdated(<String> l_sObjectName, <SL4B_RecordFieldData> l_oFieldData, l_bIsCachedImage)

recordUpdated

void recordUpdated(<String> l_sObjectName, <String> l_sFieldName, <String> l_sValue)

storyReset

void storyReset(<String> l_sObjectName)

storyUpdated

void storyUpdated(<String> l_sObjectName, <String> l_sStoryText)

structureChange

void structureChange(<String> l_sContainerName, <String> l_sObjectName, <String> l_sObjectType, <boolean> l_bAdded)

structureMultiChange

void structureMultiChange(<String> l_sContainerName, <Array> l_pContainerStructureChanges, <Array> l_pOrderChanges, <int> l_nContainerSize)

type2Clear

void type2Clear(<String> l_sObjectName)

type3Clear

void type3Clear(<String> l_sObjectName)

WTObjectStatus

void WTObjectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)

Caplin SL4B SDK 4.5.4

${JSDOC.FOOTER}
Documentation generated by JSDoc on Tue May 12 09:30:26 2009