この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

GetAppointmentSlotsInputBuilder クラス

lxscheduler.GetAppointmentSlotsInput クラスのインスタンスを作成するメソッドが含まれます。

ビルダーオブジェクトを取得するには、GetAppointmentSlotsInput クラスで定義される GetAppointmentSlotsInputBuilder メソッドの 1 つを呼び出します。

名前空間

LxScheduler

GetAppointmentSlotsInputBuilder のメソッド

GetAppointmentSlotsInputBuilder のメソッドは次のとおりです。

build()

lxscheduler.GetAppointmentSlotsInput オブジェクトのインスタンスを返します。

署名

public lxscheduler.GetAppointmentSlotsInput build()

setAccountId(accountId)

予定を作成する関連付けられている取引先の ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setAccountId(String accountId)

パラメーター

accountId
型: String
関連取引先の ID。

setAllowConcurrentScheduling(allowConcurrentScheduling)

同時予定のスケジュールを許可します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setAllowConcurrentScheduling(Boolean allowConcurrentScheduling)

パラメーター

allowConcurrentScheduling
型: Boolean
true の場合、時間枠での同時予定のスケジュールが許可されます。true の場合、同時予定は許可されません。デフォルトは、false です。API バージョン 47.0 以降で利用できます。

setApiVersion(apiVersion)

getAppointmentSlots メソッドにビジネスロジックの API バージョンを設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setApiVersion(Double apiVersion)

パラメーター

apiVersion
型: Double

使用方法

パラメーターには、正しい API バージョンを指定する必要があります。たとえば、API バージョンが 45.0 に設定されていて、primaryResourceId が設定されている場合 (API バージョン 48.0 以降で使用可能)、この項目は無視されます。リクエストボディで API バージョンが渡されない場合、または正しくない API バージョンが渡された場合、デフォルトでは最新バージョンが使用されます。

API は、バージョン 45.0 以降で使用できます。

メモ

setCorrelationId(correlationId)

相関関係 ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setCorrelationId(String correlationId)

パラメーター

correlationId
型: String
ServiceResourceScheduleHandler Apex インターフェースにカスタム情報を渡すための ID。たとえば、この相関関係 ID によって Apex インターフェース実装をコールするアプリケーション、Web サイト、または外部システムを識別できます。カスタム値を渡さない場合、ランダムに生成された識別子が渡されます。API バージョン 53.0 以降で使用できます。

setEndTime(endTime)

スケジュールの終了時刻を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setEndTime(String endTime)

パラメーター

endTime
型: String
時間枠 (両端を含む) が終わる最も遅い時間。終了時刻が指定されていない場合、デフォルトは 31 日です。

使用方法

指定した文字列は、ローカルタイムゾーンの標準の日付形式「['yyyy-MM-dd\’T\’HH:mm:ssZ']」を使用する必要があります。デフォルトはユーザーのタイムゾーンです。

setEngagementChannelTypeIds(engagementChannelTypeIds)

エンゲージメントチャネル種別を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setEngagementChannelTypeIds(List<String> engagementChannelTypeIds)

パラメーター

engagementChannelTypeIds
型: List<String>
エンゲージメントチャネル種別レコードの ID。時間枠の対応可能状況は、選択したエンゲージメントチャネル種別に基づいて絞り込みます。この項目は、API バージョン 56.0 以降で使用できます。

この項目は、1 つのエンゲージメントチャネル種別 ID のみをサポートします。

メモ

使用方法

エンゲージメントチャネル種別を使用できるのは、次の場合のみです。
  • [エンゲージメントチャネルを使用して予定をスケジュール] 設定が、Salesforce 組織の Salesforce Scheduler の設定で有効になっている。
  • シフトが、スケジュールポリシーで定義されている。スケジュールポリシーでのシフトの設定の詳細は、「スケジュールポリシーでのシフトルールの定義」を参照してください。

    エンゲージメントチャネル種別は、スケジュールポリシーの営業-時間ルールではサポートされていません。

    メモ

setPrimaryResourceId(primaryResourceId)

プライマリリソースの ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setPrimaryResourceId(String primaryResourceId)

パラメーター

primaryResourceId
型: String
マルチリソーススケジュールのプライマリリソースの ID。マルチリソーススケジュールが有効な場合のみ必須です。API バージョン 48.0 以降で利用できます。

setRequiredResourceIds(requiredResourceIds)

リソース ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setRequiredResourceIds(List<String> requiredResourceIds)

パラメーター

requiredResourceIds
型: List<String>
時間枠内で利用可能でなければならないリソース ID のリスト。これは必須項目です。

setSchedulingPolicyId(schedulingPolicyId)

AppointmentSchedulingPolicy オブジェクトの ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setSchedulingPolicyId(String schedulingPolicyId)

パラメーター

schedulingPolicyId
型: String
リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。

setStartTime(startTime)

スケジュールの開始時刻を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setStartTime(String startTime)

パラメーター

startTime
型: String
時間枠 (両端を含む) が始まる最も早い時間。指定されていない場合は、デフォルトの要求の現時刻に設定されます。

使用方法

指定した文字列は、ローカルタイムゾーンの標準の日付形式「['yyyy-MM-dd\’T\’HH:mm:ssZ']」を使用する必要があります。デフォルトはユーザーのタイムゾーンです。

setTerritoryIds(territoryIds)

サービステリトリーの ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setTerritoryIds(List<String> territoryIds)

パラメーター

territoryIds
型: List<String>
要求されている作業が実施されるサービステリトリーの ID のリスト。これは必須項目です。

setWorkType(workType)

実行する作業の種別を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setWorkType(lxscheduler.WorkType workType)

パラメーター

workType
型: lxscheduler.WorkType

このメソッドは入力で、lxscheduler.WorkType クラスのインスタンスを取得します。lxscheduler.WorkTypeBuilder クラスを使用して、入力クラスのインスタンスを作成します。

workTypeGroupId が指定されていない場合は必須。

setWorkTypeGroupId(workTypeGroupId)

作業種別グループの ID を設定します。

署名

public lxscheduler.GetAppointmentSlotsInputBuilder setWorkTypeGroupId(String workTypeGroupId)

パラメーター

workTypeGroupId
型: String
実施されている作業種別を含む作業種別グループの ID。