SendInstantMessage Method
The SendInstantMessage method sends an instant message to the specified contacts.
Syntax
object.SendInstantMessage
(
i_pIToContactURLEnumAsIGrooveBSTREnum,
i_Body As String,
i_TrackMessageAs Boolean = True,
i_SaveSentMessageAs Boolean = False
) As Boolean
Parameters
| Parameter | Description |
|---|---|
i_pIToContactURLEnum |
Specifies the contacts to send the instant message tool. The string enumeration specifies contact URLs, which can be obtained from the CreateMemberNameURLEnum method or a field value in a record. See Accessing Forms Records for more information. |
i_Body |
Text of the message to send. |
i_TrackMessage |
TRUE if the message should be tracked (default), FALSE if not. |
i_SaveSentMessage |
TRUE if the message should be saved, FALSE if not (default). |
Return Value
The return value is TRUE if the user allows the script to send the message; FALSE otherwise.
Remarks
When a script calls this function, Groove displays a dialog box asking if the user wants to allow the Forms tool to send an instant message on the user's behalf. If the user allows the tool to send the message, the function returns a TRUE value. If the user does not allow the tool to send the message, the function returns a FALSE value. Note that a TRUE value does not indicate that Groove succeeded in sending the message, only that the user approved it.
Note
This method displays a modal dialog and should not be called from a script when a transaction is open. Macros are run within an open transaction; consequently, this method should not be called from a macro. See Accessing Forms Records for more information on this restriction.
See Also
Reference
IGrooveFormsToolUIDelegate Interface
CreateMemberNameURLEnum Method
SendInstantMessageWithLinks Method