public interface

CaseUIClient

com.salesforce.android.cases.ui.CaseUIClient

Class Overview

Public API for the CasesUIClient

Summary

Public Methods
abstract void close()
Closes the case Ui Client.
abstract String getCaseListName()
Get the Salesforce unique developer name of the case list to be displayed that was provided to CaseUIConfiguration.
abstract String getCommunityUrl()
Get the Community URL that was provided to CaseUIConfiguration.
abstract CaseClient getCoreClient()
Get the CaseClient that the Case UI Client is using to perform asynchronous data requests.
abstract String getCreateCaseActionName()
Get the name of the quick action to create a case that was provided to CaseUIConfiguration.
abstract Async<Integer> getTotalUnreadCases()
Gets the total unread cases for the authenticated Salesforce user asynchronously.
abstract void launch(Context context)
Launch the Case List Activity if the user is authenticated.
abstract void launchCaseFeed(Context context, String caseId)
Launch the Case Feed Activity.
abstract void launchCaseList(Context context)
Launches the Case List UI Activity
abstract void launchCasePublisher(Context context)
Launch the Case Publisher UI Activity.
abstract void notifyCaseUpdated(String caseId)
Notify the Case UI that a case has been updated.

Public Methods

public abstract void close ()

Closes the case Ui Client. Must be called before reopening a new client to prevent a memory leak.

public abstract String getCaseListName ()

Get the Salesforce unique developer name of the case list to be displayed that was provided to CaseUIConfiguration.

Returns
  • Case List Name

public abstract String getCommunityUrl ()

Get the Community URL that was provided to CaseUIConfiguration.

Returns
  • Case Community URL.

public abstract CaseClient getCoreClient ()

Get the CaseClient that the Case UI Client is using to perform asynchronous data requests.

Returns

public abstract String getCreateCaseActionName ()

Get the name of the quick action to create a case that was provided to CaseUIConfiguration.

Returns
  • Create Case Action Name

public abstract Async<Integer> getTotalUnreadCases ()

Gets the total unread cases for the authenticated Salesforce user asynchronously. If there is no authenticated Salesforce user it will return a result of 0 immediately.

Returns
  • The Async instance

public abstract void launch (Context context)

Launch the Case List Activity if the user is authenticated. Otherwise, launch the Case Publisher Activity.

Parameters
context A Context instance

public abstract void launchCaseFeed (Context context, String caseId)

Launch the Case Feed Activity.

Parameters
context A Context instance
caseId the id of the case to load

public abstract void launchCaseList (Context context)

Launches the Case List UI Activity

Parameters
context A Context instance

public abstract void launchCasePublisher (Context context)

Launch the Case Publisher UI Activity.

Parameters
context A Context instance

public abstract void notifyCaseUpdated (String caseId)

Notify the Case UI that a case has been updated. This is meant to be used in conjunction with Salesforce Mobile Push Notifications in Service Cloud.

Parameters
caseId The ID of the case that has been updated.