Apex Reference Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
GetAppointmentSlotsInputBuilder Class
A Builder object is obtained by invoking one of the GetAppointmentSlotsInputBuilder methods defined by the GetAppointmentSlotsInput class.
Namespace
GetAppointmentSlotsInputBuilder Methods
The following are methods for GetAppointmentSlotsInputBuilder.
setAccountId(accountId)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setAccountId(String accountId)
Parameters
- accountId
- Type: String
- The ID of the associated account.
Return Value
setAllowConcurrentScheduling(allowConcurrentScheduling)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setAllowConcurrentScheduling(Boolean allowConcurrentScheduling)
Parameters
- allowConcurrentScheduling
- Type: Boolean
- If true, allows scheduling of concurrent appointments in a time slot. If false, concurrent appointments are not allowed. The default is false. Available in API version 47.0 and later.
Return Value
setApiVersion(apiVersion)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setApiVersion(Double apiVersion)
Parameters
- apiVersion
- Type: Double
Usage
Return Value
setCorrelationId(correlationId)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder 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.GetAppointmentSlotsInputBuilder setEndTime(String endTime)
Parameters
- endTime
- Type: String
- The latest time that a time slot can end (inclusive). If end time is not specified, it defaults to 31 days.
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.GetAppointmentSlotsInputBuilder setEngagementChannelTypeIds(List<String> engagementChannelTypeIds)
Parameters
- engagementChannelTypeIds
- Type: List<String>
- The ID of the engagement channel type record. The availability of time slots 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.
setPrimaryResourceId(primaryResourceId)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setPrimaryResourceId(String primaryResourceId)
Parameters
- primaryResourceId
- Type: String
- The ID of the primary resource in multi-resource scheduling. Required only when multi-resource scheduling is enabled. Available in API version 48.0 and later.
Return Value
setRequiredResourceIds(requiredResourceIds)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setRequiredResourceIds(List<String> requiredResourceIds)
Parameters
- requiredResourceIds
- Type: List<String>
- List of resource IDs that must be available during the time slot. This is a required field.
Return Value
setSchedulingPolicyId(schedulingPolicyId)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setSchedulingPolicyId(String schedulingPolicyId)
Parameters
- schedulingPolicyId
- Type: String
- If no scheduling policy is passed in the request body, the default configurations are used.
Return Value
setStartTime(startTime)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setStartTime(String startTime)
Parameters
- startTime
- Type: String
- The earliest time that a time slot can begin (inclusive). Defaults to the current time of the request, if empty.
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.GetAppointmentSlotsInputBuilder setTerritoryIds(List<String> territoryIds)
Parameters
- territoryIds
- Type: List<String>
- List of IDs of service territories, where the work that is being requested is performed. This is a required field.
Return Value
setWorkType(workType)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder 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.
Return Value
setWorkTypeGroupId(workTypeGroupId)
Signature
public lxscheduler.GetAppointmentSlotsInputBuilder setWorkTypeGroupId(String workTypeGroupId)
Parameters
- workTypeGroupId
- Type: String
- The ID of the work type group containing the work types that are being performed.