WebCenter Interaction API  
 

IPTAsyncGadgetProvider.BeginProcessing Method (Int32, IPTSession, IPTGadgetInfo, IPTStates, IPTAdminSettings, Object, IPTUserInterface, Int32)

The Provider must be Initialized before this method may be called. After a successful initialization, this method may, if desired, be called, repeatedly with different preferences and different sessions. GetHTMLText should be called with the same arguments after this method if this method returns a success code. -jas

int BeginProcessing(
   int lMode,
   IPTSession pUserSession,
   IPTGadgetInfo pGadgetInfo,
   IPTStates pStates,
   IPTAdminSettings pAdminSettings,
   object vAppDataStateObject,
   IPTUserInterface pUserInterface,
   int nStateMode
);

Parameters

lMode
The mode, see see {@link com.plumtree.server.PT_GADGET_MODES PT_GADGET_MODES}.
pUserSession
The current user's session.
pGadgetInfo
Used to get and set persistent settings.
pStates
State information, used to store page, session, and application level state.
pAdminSettings
Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.
vAppDataStateObject
Contains additonal arguments specific to the provider or the user interface.
pUserInterface
The user interface (e.g. devices, low bandwidth). Optional, may be null.
nStateMode
The state to use for storing the requests {@link com.plumtree.server.PT_STATEMODES PT_STATEMODES}.

Return Value

A result code. Currently it always returns PT_S_OK.

See Also

IPTAsyncGadgetProvider Interface | com.plumtree.server Namespace | IPTAsyncGadgetProvider.BeginProcessing Overload List