GetAppointmentSlotsInputBuilder Class
Contains methods to build an instance of the lxscheduler.GetAppointmentSlotsInput class.
A Builder object is obtained by invoking one of the GetAppointmentSlotsInputBuilder methods defined by the GetAppointmentSlotsInput class.
The following are methods for GetAppointmentSlotsInputBuilder.
-
Returns an instance of the
lxscheduler.GetAppointmentSlotsInputobject. -
Sets the ID of the associated account for which you want to create appointments.
-
setAllowConcurrentScheduling(allowConcurrentScheduling)
Allows the scheduling of concurrent appointments.
-
Sets the API version of the business logic for the
getAppointmentSlotsmethod. -
setCorrelationId(correlationId)
Sets the correlation ID.
-
Sets the scheduling end time.
-
setEngagementChannelTypeIds(engagementChannelTypeIds)
Sets an engagement channel type.
-
setPrimaryResourceId(primaryResourceId)
Sets the ID of the primary resource.
-
setRequiredResourceIds(requiredResourceIds)
Sets the resource IDs.
-
setSchedulingPolicyId(schedulingPolicyId)
Sets the ID of the
AppointmentSchedulingPolicyobject. -
Sets the scheduling start time.
-
Sets the IDs of service territories.
-
Sets the type of work to be performed.
-
setWorkTypeGroupId(workTypeGroupId)
Sets the ID of the work type group.
Returns an instance of the lxscheduler.GetAppointmentSlotsInput object.
public lxscheduler.GetAppointmentSlotsInput build()
Type: lxscheduler.GetAppointmentSlotsInput
Sets the ID of the associated account for which you want to create appointments.
public lxscheduler.GetAppointmentSlotsInputBuilder setAccountId(String accountId)
-
accountId:
Type: String
The ID of the associated account.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Allows the scheduling of concurrent appointments.
public lxscheduler.GetAppointmentSlotsInputBuilder setAllowConcurrentScheduling(Boolean allowConcurrentScheduling)
-
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.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the API version of the business logic for the getAppointmentSlots method.
public lxscheduler.GetAppointmentSlotsInputBuilder setApiVersion(Double apiVersion)
-
apiVersion:
Type: Double
The specified parameter must use the correct API version. For example, if API version is set to 45.0 and primaryResourceId is set (which is available in API version 48.0 and later), then this field is ignored. If no API version or incorrect API version is passed in the request body, by default the latest version is used.
The API is available since version 45.0.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the correlation ID.
public lxscheduler.GetAppointmentSlotsInputBuilder setCorrelationId(String correlationId)
-
correlationId:
Type: String
ID to pass
custom information to the
ServiceResourceScheduleHandlerApex 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.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the scheduling end time.
public lxscheduler.GetAppointmentSlotsInputBuilder setEndTime(String endTime)
-
endTime:
Type: String
The latest time that a time slot can end (inclusive). If end time is not specified, it defaults to 31 days.
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.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets an engagement channel type.
public lxscheduler.GetAppointmentSlotsInputBuilder setEngagementChannelTypeIds(List<String> engagementChannelTypeIds)
-
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.
This field supports only one engagement channel type ID.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
You can use engagement channel types only in these cases:
-
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.
Engagement channel types are not supported with operating-hours rules in the scheduling policy.
Sets the ID of the primary resource.
public lxscheduler.GetAppointmentSlotsInputBuilder setPrimaryResourceId(String primaryResourceId)
-
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.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the resource IDs.
public lxscheduler.GetAppointmentSlotsInputBuilder setRequiredResourceIds(List<String> requiredResourceIds)
-
requiredResourceIds:
Type: List<String> List of resource IDs that must be available during the time slot. This is a required field.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the ID of the AppointmentSchedulingPolicy object.
public lxscheduler.GetAppointmentSlotsInputBuilder setSchedulingPolicyId(String schedulingPolicyId)
-
schedulingPolicyId:
Type: String
If no scheduling policy is passed in the request body, the default configurations are used.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the scheduling start time.
public lxscheduler.GetAppointmentSlotsInputBuilder setStartTime(String startTime)
-
startTime:
Type: String
The earliest time that a time slot can begin (inclusive). Defaults to the current time of the request, if empty.
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.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the IDs of service territories.
public lxscheduler.GetAppointmentSlotsInputBuilder setTerritoryIds(List<String> territoryIds)
-
territoryIds:
Type: List<String> List of IDs of service territories, where the work that is being requested is performed. This is a required field.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the type of work to be performed.
public lxscheduler.GetAppointmentSlotsInputBuilder setWorkType(lxscheduler.WorkType workType)
-
workType:
Type: lxscheduler.WorkType
This method takes input as an instance of the
lxscheduler.WorkTypeclass. Build the instance of the input class using thelxscheduler.WorkTypeBuilderclass.Required if workTypeGroupId is not given.
Type: lxscheduler.GetAppointmentSlotsInputBuilder
Sets the ID of the work type group.
public lxscheduler.GetAppointmentSlotsInputBuilder setWorkTypeGroupId(String workTypeGroupId)
-
workTypeGroupId:
Type: String
The ID of the work type group containing the work types that are being performed.