Salesforce Scheduler Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
GetAppointmentCandidatesInputBuilder Class
A Builder object is obtained by invoking one of the GetAppointmentCandidatesInputBuilder methods defined by the GetAppointmentCandidatesInput class.
Namespace
LxScheduler
GetAppointmentCandidatesInputBuilder Methods
The following are methods for GetAppointmentCandidatesInputBuilder.
setAccountId(accountId)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setAccountId(String accountId)
Parameters
- accountId
- Type: String
Return Value
setAllowConcurrent(allowConcurrent)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setAllowConcurrent(Boolean allowConcurrent)
Parameters
- allowConcurrent
- Type: Boolean
- If true, allows scheduling of concurrent appointments in a time slot. The default is
false.
Available in API version 47.0 and later.
Return Value
setApiVersion(apiVersion)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setApiVersion(Double apiVersion)
Parameters
- apiVersion
- Type: Double
Usage
Return Value
setCorrelationId(correlationId)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setCorrelationId(String correlationId)
Parameters
- correlationId
- Type: String
- ID to pass custom information to the ServiceResourceScheduleHandler Apex interface. For example, you can use the correlation ID to identify the app, website, or any other external system that calls this Apex interface implementation. If you don’t pass a custom value, a randomly generated identifier is passed. Available in API version 53.0 and later.
Return Value
setEndTime(endTime)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setEndTime(String endTime)
Parameters
- endTime
- Type: String
- The latest time that a time slot can end (inclusive).
Usage
The specified string should use the standard date format “['yyyy-MM-dd\’T\’HH:mm:ssZ']” in the local time zone. Defaults to the user’s time zone.
Return Value
setEngagementChannelTypeIds(engagementChannelTypeIds)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setEngagementChannelTypeIds(List<String> engagementChannelTypeIds)
Parameters
- engagementChannelTypeIds
- Type: List<String>
- The ID of the engagement channel type record. The availability of service resources is filtered based on the engagement channel type selected. This field is available in API version 56.0 and later.
Return Value
Usage
- The Schedule Appointments Using Engagement Channels setting is enabled in Salesforce Scheduler Settings in your Salesforce org.
- Shifts are defined in the scheduling policy. For more information on setting up shifts in scheduling policy, see Define Shift Rules in Scheduling Policy.
setFilterByResources(filterByResources)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setFilterByResources(List<String> filterByResources)
Parameters
- filterByResources
- Type: List<String>
- Gets only eligible resources that are both in the list and in the selected service territory sorted by the order in which the resource IDs are passed. This field is available in API version 51.0 and later.
Return Value
setResourceLimitApptDistribution(resourceLimitApptDistribution)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setResourceLimitApptDistribution(Integer resourceLimitApptDistribution)
Parameters
- resourceLimitApptDistribution
- Type: Integer
- Specify the maximum number of service resources that you want to show during appointment scheduling when appointment distribution is enabled. Available in API version 53.0 and later.
Return Value
setSchedulingPolicyId(schedulingPolicyId)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setSchedulingPolicyId(String schedulingPolicyId)
Parameters
- schedulingPolicyId
- Type: String
- The ID of the AppointmentSchedulingPolicy object. If no scheduling policy is passed in the request body, the default configurations are used.
Return Value
setStartTime(startTime)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setStartTime(String startTime)
Parameters
- startTime
- Type: String
- The earliest time that a time slot can begin (inclusive). You can also use a time from the past.
Usage
The specified string should use the standard date format “['yyyy-MM-dd\’T\’HH:mm:ssZ']” in the local time zone. Defaults to the user’s time zone.
Return Value
setTerritoryIds(territoryIds)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setTerritoryIds(List<String> territoryIds)
Parameters
- territoryIds
- Type: List<String>
- List of service territory IDs, where the work that is being requested is performed. This is a required field.
Return Value
setWorkType(workType)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setWorkType(lxscheduler.WorkType workType)
Parameters
- workType
- Type: lxscheduler.WorkType
-
This method takes input as an instance of the lxscheduler.WorkType class. Build the instance of the input class using the lxscheduler.WorkTypeBuilder class.
Required if workTypeGroupId is not given. If id of the workType is given, the rest of workType fields are optional.
Usage
Return Value
setWorkTypeGroupId(workTypeGroupId)
Signature
public lxscheduler.GetAppointmentCandidatesInputBuilder setWorkTypeGroupId(String workTypeGroupId)
Parameters
- workTypeGroupId
- Type: String
- The ID of the work type group containing the work types that are being performed. Required if workType is not given. If workType is given, then you must provide either id or durationInMinutes, but not both.