User.startAvailableCampaignObjectEnum Property

Definition

This property returns an enumeration of campaigns which are available for agent to logon to or out of. The enumeration is traversed using the hasMoreElements and nextElement methods of the enumeration. Each call to the nextElement method returns successive elements of the series.

The hasMoreElements method will return a Boolean true if this enumeration contains more elements. note: only campaings that the agent has view permission granted will be returned by this enumeration.

This enumeration will only return campaigns that are available to the user, and campaigns that the user has been granted view permission on.

Syntax

User.startAvailableCampaignObjectEnum

Usage

Read Yes

Write No

Value Assigned

None.

Value Returned

Enumeration

The enumeration contains a list of campaign objects.

Java Enumeration Example (JavaScript)

// show all available campaigns and their status.
var campaigns = scripter.myUser.startAvailableCampaignObjectEnum;
while (campaigns.hasMoreElements()) {
    var campaign = campaigns.nextElement();
    alert(campaign.campaignName);
    alert(campaign.campaignStateString);
}