IBridgeTalkUtils Class Reference

#include <IBridgeTalkUtils.h>

Inheritance diagram for IBridgeTalkUtils:

Public Types
enum	{ kDefaultIID = IID_IBRIDGETALKUTILS }

Public Member Functions
virtual ErrorCode	PostMessageToBridgeTalk (const PMString &msg) const =0
virtual bool16	CheckForIncomingBridgeTalkTraffic () const =0
virtual bool16	IsAppInstalled (const char *appSpec) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Utilities related to BridgeTalk scripting.

Member Function Documentation

virtual bool16 IBridgeTalkUtils::CheckForIncomingBridgeTalkTraffic ( ) const

pure virtual

Checks for pending incoming BridgeTalk messages. Code that might raise a modal dialog during startup should call this method to determine whether the application was launched via a BridgeTalk request (in which case putting up a modal dialog is discouraged). Note: Most clients also test Utils<IStartupUtils>()->WillFilesBeOpenedAtStartup() == kFalse before putting up a modal dialog on startup.

Returns

whether there is a BridgeTalk request pending

virtual bool16 IBridgeTalkUtils::IsAppInstalled ( const char *  appSpec ) const

pure virtual

This is a convenience method to determine if a CS app is installed or not.

Parameters

appSpec

is a character string for the BridgeTalk app specifier (e.g. "bridge-4", "photoshop-11", etc).

Returns

true if the app is installed, false otherwise

virtual ErrorCode IBridgeTalkUtils::PostMessageToBridgeTalk ( const PMString &  msg ) const

pure virtual

Execute a script via the script runner that supports BridgeTalk. For information on how to write a script that sends a message via BridgeTalk, consult a BridgeTalk JavaScript guide.

Parameters

msg	is a text script

Returns

the error code returned by the script