IFmsNotifyAction Class Reference

Calls a method on a Client object or on an application object in a server-side script. You must define the method to be called in the server-side script.

#include <FmsAuthActions.h>

Inheritance diagram for IFmsNotifyAction:

List of all members.

Public Member Functions
virtual IFmsAuthEvent::Status	setClientId (const FmsVariant &field)=0
virtual const FmsVariant &	getMethodName () const =0
virtual IFmsAuthEvent::Status	setMethodName (const FmsVariant &field)=0
virtual const FmsVariant *	getParam (unsigned int iIndex) const =0
virtual IFmsAuthEvent::Status	removeParam (unsigned int iFirst, unsigned int iLast)=0
virtual IFmsAuthEvent::Status	addParam (const FmsVariant &field)=0
virtual unsigned int	getNumParams () const =0

---

Member Function Documentation

virtual IFmsAuthEvent::Status IFmsNotifyAction::setClientId

(

const FmsVariant &

field

)

[pure virtual]

Sets the ID of the client on which to call the method.

Parameters:

field

kI64 variant (see the FmsVariant class). If you set a value, the method is called on the Client object in the server-side script. If you don't set a value, the method is called on the application object in the server-side script.

virtual const FmsVariant& IFmsNotifyAction::getMethodName

(

)

const [pure virtual]

Gets the method name.

Returns:

kString variant

virtual IFmsAuthEvent::Status IFmsNotifyAction::setMethodName

(

const FmsVariant &

field

)

[pure virtual]

Sets the method name.

Parameters:

field

kString variant

virtual const FmsVariant* IFmsNotifyAction::getParam

(

unsigned int

iIndex

)

const [pure virtual]

Gets a parameter by index.

Parameters:

iIndex

The index of a parameter, starting from 0.

Returns:

A pointer to a variant; 0 means no parameter was found.

virtual IFmsAuthEvent::Status IFmsNotifyAction::removeParam	(	unsigned int	iFirst,
		unsigned int	iLast
	)			[pure virtual]

Removes a parameter or a range of parameters from the specified positions.

Parameters:

	iFirst	The first index value.
	iLast	The last index value.

Returns:

S_SUCCESS If the parameter was removed.

virtual IFmsAuthEvent::Status IFmsNotifyAction::addParam

(

const FmsVariant &

field

)

[pure virtual]

Adds a parameter to the method to call in the server-side script.

Parameters:

field

variant

Returns:

S_SUCCESS If the parameter was added.

virtual unsigned int IFmsNotifyAction::getNumParams

(

)

const [pure virtual]

Returns the number of parameters in the method.

---

The documentation for this class was generated from the following file:

• FmsAuthActions.h

©2007 Adobe Systems Incorporated.  All Rights Reserved.