BlueprintRecordRequest - gomeddo/js-sdk GitHub Wiki

Object used to retrieve configured blueprint records that match this request.

Example

const blueprintRequest = gm.buildBlueprintRecordRequest()
    .withCondition(
        new Condition('Name', Operator.EQUAL, 'Parent Blueprint')
    )
    .includeAdditionalFields(new Set(['B25__Description__c', 'B25__Image_Url__c', 'B25__Duration__c']))
    .getResults()

---

withCondition

Syntax

withCondition(conditionObject1)
withCondition(conditionObject1, conditionObject2)
withCondition(conditionObject1, conditionObject2, /* … ,*/ conditionObjectN)

Parameters:

• conditionObjectN The condition(s) you want to filter on. Of type Condition.

Return value: The updated blueprint record request.

Description

Only return blueprint records that match the conditions. Multiple conditions will be combined using AND.

---

includeAdditionalField

Syntax

includeAdditionalField(fieldname)

Parameters:

• fieldname The fieldname of a field in salesforce on the blueprint object you want to be returned from the request

Return value: The updated blueprint record request.

Description

Add this field to the list of fields requested from the salesforce endpoint.

---

includeAdditionalFields

Syntax

includeAdditionalFields(fieldnameList)

Parameters:

• fieldnameList The fieldnames of fields in salesforce on the blueprint object you want to be returned from the request

Return value: The updated blueprint record request.

Description

Add these fields to the list of fields requested from the salesforce endpoint.

---

getResults

Syntax

await getResults()

Return value: A BlueprintRecordResult object with the blueprint records matching the request.

Description

async Calls the GoMeddo APIs to construct the requested blueprint records.

---

setRequestedIds

Syntax

setRequestedIds(ids)

Parameters:

• ids The Salesforce ids of the B25__Reservation_Blueprint__c records to be returned from the request

Return value: The updated blueprint record request.

Description

Adds a WHERE clause to the query that will only return B25__Reservation_Blueprint__c records with matching ids.

---

setRequestedNames

Syntax

setRequestedNames(names)

Parameters:

• names The names of the B25__Reservation_Blueprint__c records to be returned from the request.

Return value: The updated blueprint record request.

Description

Adds a WHERE clause to the query that will only return B25__Reservation_Blueprint__c records with matching names. The query will be performed on B25__Reservation_Blueprint__c.Name.