Apex リファレンスガイド
jGetAppointmentCandidatesInputBuilder クラス
ビルダーオブジェクトを取得するには、GetAppointmentCandidatesInput クラスで定義される GetAppointmentCandidatesInputBuilder メソッドの 1 つを呼び出します。
名前空間
GetAppointmentCandidatesInputBuilder のメソッド
GetAppointmentCandidatesInputBuilder のメソッドは次のとおりです。
setAccountId(accountId)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setAccountId(String accountId)
パラメーター
- accountId
- 型: String
setAllowConcurrent(allowConcurrent)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setAllowConcurrent(Boolean allowConcurrent)
パラメーター
- allowConcurrent
- 型: Boolean
- true の場合、時間枠での同時予定のスケジュールが許可されます。デフォルトは、false です。
API バージョン 47.0 以降で利用できます。
setApiVersion(apiVersion)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setApiVersion(Double apiVersion)
パラメーター
- apiVersion
- 型: Double
使用方法
setCorrelationId(correlationId)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setCorrelationId(String correlationId)
パラメーター
- correlationId
- 型: String
- ServiceResourceScheduleHandler Apex インターフェースにカスタム情報を渡すための ID。たとえば、この相関関係 ID によって Apex インターフェース実装をコールするアプリケーション、Web サイト、または外部システムを識別できます。カスタム値を渡さない場合、ランダムに生成された識別子が渡されます。API バージョン 53.0 以降で使用できます。
setEndTime(endTime)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setEndTime(String endTime)
パラメーター
- endTime
- 型: String
- 時間枠 (両端を含む) が終わる最も遅い時間。
使用方法
指定した文字列は、ローカルタイムゾーンの標準の日付形式「['yyyy-MM-dd\’T\’HH:mm:ssZ']」を使用する必要があります。デフォルトはユーザーのタイムゾーンです。
setEngagementChannelTypeIds(engagementChannelTypeIds)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setEngagementChannelTypeIds(List<String> engagementChannelTypeIds)
パラメーター
- engagementChannelTypeIds
- 型: List<String>
- エンゲージメントチャネル種別レコードの ID。サービスリソースの対応可能状況は、選択したエンゲージメントチャネル種別に基づいて絞り込みます。この項目は、API バージョン 56.0 以降で使用できます。
使用方法
- [エンゲージメントチャネルを使用して予定をスケジュール] 設定が、Salesforce 組織の Salesforce Scheduler の設定で有効になっている。
- シフトが、スケジュールポリシーで定義されている。スケジュールポリシーでのシフトの設定の詳細は、「スケジュールポリシーでのシフトルールの定義」を参照してください。
setFilterByResources(filterByResources)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setFilterByResources(List<String> filterByResources)
パラメーター
- filterByResources
- 型: List<String>
- リストに含まれ、さらに選択したサービステリトリーにある資格のあるリソースのみが、リソース ID が渡された順序で並べ替えられて取得されます。この項目は、API バージョン 51.0 以降で使用できます。
setResourceLimitApptDistribution(resourceLimitApptDistribution)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setResourceLimitApptDistribution(Integer resourceLimitApptDistribution)
パラメーター
- resourceLimitApptDistribution
- 型: Integer
- 予定の配分が有効になっている場合に予定のスケジュール中に表示するサービスリソースの最大数を指定します。API バージョン 53.0 以降で使用できます。
setSchedulingPolicyId(schedulingPolicyId)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setSchedulingPolicyId(String schedulingPolicyId)
パラメーター
- schedulingPolicyId
- 型: String
- AppointmentSchedulingPolicy オブジェクトの ID。リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。
setStartTime(startTime)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setStartTime(String startTime)
パラメーター
- startTime
- 型: String
- 時間枠 (両端を含む) が始まる最も早い時間。過去の時間も使用できます。
使用方法
指定した文字列は、ローカルタイムゾーンの標準の日付形式「['yyyy-MM-dd\’T\’HH:mm:ssZ']」を使用する必要があります。デフォルトはユーザーのタイムゾーンです。
setTerritoryIds(territoryIds)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setTerritoryIds(List<String> territoryIds)
パラメーター
- territoryIds
- 型: List<String>
- 要求されている作業が実施されるサービステリトリー ID のリスト。これは必須項目です。
setWorkType(workType)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setWorkType(lxscheduler.WorkType workType)
パラメーター
- workType
- 型: lxscheduler.WorkType
-
このメソッドは入力で、lxscheduler.WorkType クラスのインスタンスを取得します。lxscheduler.WorkTypeBuilder クラスを使用して、入力クラスのインスタンスを作成します。
workTypeGroupId が指定されていない場合は必須。workType の id が指定されている場合、他の workType 項目は省略可能です。
使用方法
setWorkTypeGroupId(workTypeGroupId)
署名
public lxscheduler.GetAppointmentCandidatesInputBuilder setWorkTypeGroupId(String workTypeGroupId)
パラメーター
- workTypeGroupId
- 型: String
- 実施されている作業種別を含む作業種別グループの ID。workType が指定されていない場合は必須。workType が指定されている場合、id または durationInMinutes のいずれかを指定する必要があります。ただし両方は指定できません。