live chat,live help,live support Boldchat Web Service
API Reference
 
[ Programmer's Guide | API Reference Home ]


Class SetupItemInfo

A SetupItemInfo instance contains general information about a setup item. Examples of setup items are User Categories, chat window definitions, and Salesforce connectors.

Property Summary
Stringname
The name.
LongsetupItemID
The setupItemID.
BytefolderType
The folder type, which may be one of the following.
ByteisActive
Whether the setup item is active.
IntegeraccessKey
The shortcut or access key code, for setup items that support them.
Calendarcreated
The creation date-time.
Calendarupdated
The last update date-time.

Property Detail
String name

The name.

Long setupItemID

The setupItemID.

Byte folderType

The folder type, which may be one of the following.
  • 8 - Chat Canned Messages
  • 9 - Email Canned Messages
  • 11 - Contact User Categories
  • 12 - Chat Button Defs
  • 13 - Chat Invitation Defs
  • 14 - Chat Window Defs
  • 16 - Email Accounts
  • 18 - Contact User Statuses
  • 19 - Website Defs
  • 20 - Chat User Categories
  • 21 - Chat User Statuses
  • 22 - Email User Categories
  • 23 - Email User Statuses
  • 24 - Ticket User Categories
  • 25 - Ticket User Statuses
  • 30 - Contact Custom Fields 1
  • 31 - Contact Custom Fields 2
  • 32 - Chat Custom Fields 1
  • 33 - Chat Custom Fields 2
  • 34 - Email Custom Fields 1
  • 35 - Email Custom Fields 2
  • 36 - Ticket Custom Fields 1
  • 37 - Ticket Custom Fields 2
  • 42 - Call User Categories
  • 43 - Call User Statuses
  • 44 - Call Custom Fields 1
  • 45 - Call Custom Fields 2
  • 48 - Call Button Defs
  • 49 - Call Window Defs
  • 55 - Salesforce Connectors
  • 65 - Knowledge Bases
  • 75 - Text Canned Messages
  • 76 - Text User Categories
  • 77 - Text User Statuses
  • 78 - Text Custom Fields 1
  • 79 - Text Custom Fields 2
  • 84 - Twitter Canned Messages
  • 85 - Twitter User Categories
  • 86 - Twitter User Statuses
  • 87 - Twitter Custom Fields 1
  • 88 - Twitter Custom Fields 2

Byte isActive

Whether the setup item is active.

Integer accessKey

The shortcut or access key code, for setup items that support them.

Calendar created

The creation date-time.

Calendar updated

The last update date-time.