Salesforce Console Developer Guide

Salesforce Console Developer Guide
How are the Classic and Lightning APIs Different?
Lightning Experience API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods for Salesforce Classic
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Chat
Methods for Omni-Channel
acceptAgentWork
closeAgentWork
declineAgentWork
getAgentWorks
getAgentWorkload
getServicePresenceStatusChannels
getServicePresenceStatusId
login
logout
setServicePresenceStatus
Methods for Omni-Channel Console Events
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

closeAgentWork

Changes the status of a work item to “Closed” and removes it from the list of work items in the Omni-Channel widget. Available in API versions 32.0 and later.

Syntax

Arguments

Name Type Description
workId String The ID of the work item that’s closed.
callback function JavaScript method to call when the work item associated with the workId is closed.

Sample Code–Visualforce

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

Name Type Description
success Boolean true if closing the work item was successful; false if closing the work item wasn’t successful.