ASUserInteractionChecker Class Reference

#include <ASUserInteraction.h>

List of all members.

Public Member Functions
	ASUserInteractionChecker (SPBasicSuite *spBasic)
	Constructor.
ASBoolean	InteractWithUser (void)
	Reports whether interaction is allowed between the application and the user in the current application context.
ASErr	logInfo (const ai::UnicodeString &msg1, const ai::UnicodeString *msg2=NULL)
	Sets the message to write to the user-interaction log when an Info alert occurs, if user interactivity is turned off.
void	logError (const ai::UnicodeString &msg1, const ai::UnicodeString *msg2=NULL)
	Sets the message to write to the user-interaction log when an Error alert occurs, if user interactivity is turned off.
void	logWarning (const ai::UnicodeString &msg1, const ai::UnicodeString *msg2=NULL)
	Sets the message to write to the user-interaction log when a Warning alert occurs, if user interactivity is turned off.
	~ASUserInteractionChecker ()
	Destructor.

---

Constructor & Destructor Documentation

ASUserInteractionChecker::ASUserInteractionChecker

(

SPBasicSuite *

spBasic

)

[inline]

Constructor.

Creates a user-interaction checker object.

Parameters:

spBasic

The SPBasic suite object.

Returns:

The new object.

References SPBasicSuite::AcquireSuite, kASUserInteractionSuite, kASUserInteractionVersion, kNoErr, and NULL.

ASUserInteractionChecker::~ASUserInteractionChecker

(

)

[inline]

Destructor.

References kASUserInteractionSuite, kASUserInteractionVersion, NULL, and SPBasicSuite::ReleaseSuite.

---

Member Function Documentation

ASBoolean ASUserInteractionChecker::InteractWithUser

(

void

)

[inline]

Reports whether interaction is allowed between the application and the user in the current application context.

(Note that this method returns a boolean value, not an error code.)

Returns:

True if the interaction level is anything other than kASInteractWithNone.

References ASUserInteractionSuite::InteractWithUser.

Referenced by logInfo().

void ASUserInteractionChecker::logError	(	const ai::UnicodeString &	msg1,
		const ai::UnicodeString *	msg2 = NULL
	)			[inline]

Sets the message to write to the user-interaction log when an Error alert occurs, if user interactivity is turned off.

Parameters:

	msg1	The message string.
	msg2	Optional. Another message string.

References logInfo().

ASErr ASUserInteractionChecker::logInfo	(	const ai::UnicodeString &	msg1,
		const ai::UnicodeString *	msg2 = NULL
	)			[inline]

Sets the message to write to the user-interaction log when an Info alert occurs, if user interactivity is turned off.

Parameters:

	msg1	The message string.
	msg2	Optional. Another message string.

References ai::UnicodeString::append(), ai::UnicodeString::as_UTF8(), InteractWithUser(), kNoErr, and ASUserInteractionSuite::LogInteraction.

Referenced by logError(), and logWarning().

void ASUserInteractionChecker::logWarning	(	const ai::UnicodeString &	msg1,
		const ai::UnicodeString *	msg2 = NULL
	)			[inline]

Sets the message to write to the user-interaction log when a Warning alert occurs, if user interactivity is turned off.

Parameters:

	msg1	The message string.
	msg2	Optional. Another message string.

References logInfo().

---

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

• ASUserInteraction.h