Broadcast Class Method

The following is the description of the Broadcast class method Broadcast.

Syntax

Broadcast(ClusterID,QueueID, ChannelID, AgentState, AgentPresence, Message, MessageSetNumber, MessageNumber, DefaultMessage, SecurityLevel, ImportanceLevel, SenderId, NameValueString)

Description

Use the Broadcast function to broadcast a notification message. You can specify whether to send the message to agents, to a queue, or even system wide.

Parameters

Field or Control	Definition
`ClusterID`	Specify the name of the cluster that you want to broadcast the message to, such as, RENCLSTR_001, as a string.
`QueueID`	Specify the name of the physical or logical queue that you want to broadcast the message to, such as, SALES, as a string.
`ChannelID`	Specify the name of the channel, or task, for the broadcast, such as Email, Chat, Voice or Generic, as a string.
`AgentState`	Specify the state of the agents you want to broadcast the message to, such as Available, as a string.
`AgentPresence`	Specify the presence of the agents you want to broadcast the message to, such as Active, as a string.
`Message`	Specify the text of the message you want to broadcast, as a string.
`MessageSetNumber`	Specify the message set number of a message from the message catalog if you want to broadcast a message from the message catalog. You must also specify values for the `MessageNumber` and `DefaultMessageText` parameters if you want to broadcast this type of message. Specify the message set number as a number.
`MessageNumber`	Specify the message number of a message from the message catalog if you want to broadcast a message from the message catalog. You must also specify values for the `MessageSetNumber` and `DefaultMessageText` parameters if you want to broadcast this type of message. Specify the message number as a number.
`DefaultMessageText`	Specify the text to be used if the specified message catalog message isn't found. Use the `MessageSetNumber` and `MessageNumber` parameters to specify the catalog message. Specify the default message text as a string.
`SercurityLevel`	Specify the security level for the broadcast message, as a string.
`ImportanceLevel`	Specify the importance level of the broadcast message, as a string.
`SenderID`	Specify the ID of the sender of the broadcast message, as a string.
`NameValueString`	Specify a string containing name-value pairs specific to your application.

Returns

None.

Example

The following example would broadcast a message to a specific logical queue:

import PT_MCF_UQAPI:Broadcast:*;
Local PT_MCF_UQAPI:Broadcast &BC;

&BC.Broadcast("", "SALES", "", "", "Best of Luck!", "", "", "Default Message", "PRIV1", "URGENT", "Admin", "EffDate, 2005-10-25:12:00:45");