Interface ISalesforceSchemaService
Methods
describeCustomMetadataObjects
- describeCustomMetadataObjects(): Promise<string[]>
-
Returns Promise<string[]>
describePicklistValues
- describePicklistValues(type, fieldName): Promise<PicklistEntry[]>
-
Parameters
-
type: string
-
fieldName: string
Returns Promise<PicklistEntry[]>
- describePicklistValues(type, fieldName, throwWhenNotFound): Promise<undefined | PicklistEntry[]>
-
Parameters
-
type: string
-
fieldName: string
-
throwWhenNotFound: boolean
Returns Promise<undefined | PicklistEntry[]>
describeSObjectField
- describeSObjectField(type, fieldName): Promise<Field>
-
Parameters
-
type: string
-
fieldName: string
Returns Promise<Field>
- describeSObjectField(type, fieldName, throwWhenNotFound): Promise<undefined | Field>
-
Parameters
-
type: string
-
fieldName: string
-
throwWhenNotFound: boolean
Returns Promise<undefined | Field>
describeSObjectFieldPath
- describeSObjectFieldPath(type, fieldName): Promise<Field[]>
-
Parameters
-
type: string
-
fieldName: string
Returns Promise<Field[]>
- describeSObjectFieldPath(type, fieldName, throwWhenNotFound): Promise<undefined | readonly Field[]>
-
Parameters
-
type: string
-
fieldName: string
-
throwWhenNotFound: boolean
Returns Promise<undefined | readonly Field[]>
dispose
- dispose(): void
-
Returns void
filterIds
- filterIds(ids, predicate): Promise<string[]>
-
Parameters
-
ids: string | string[]
-
predicate: ((type, id) => boolean)
-
- (type, id): boolean
-
Returns boolean
Returns Promise<string[]>
getNameField
- getNameField(type): Promise<undefined | string>
-
Returns Promise<undefined | string>
getSObjectFields
- getSObjectFields(type): Promise<ReadonlyMap<string, Field>>
-
Returns Promise<ReadonlyMap<string, Field>>
isSObjectDefined
- isSObjectDefined(type): Promise<boolean>
-
Returns Promise<boolean>
isSObjectFieldDefined
- isSObjectFieldDefined(type, field): Promise<boolean>
-
Parameters
-
type: string
-
field: string
Returns Promise<boolean>
sObjectGetFieldType
- sObjectGetFieldType(type, fieldName): Promise<FieldType>
-
Parameters
-
type: string
-
fieldName: string
- sObjectGetFieldType(type, fieldName, throwWhenNotFound): Promise<undefined | FieldType>
-
Parameters
-
type: string
-
fieldName: string
-
throwWhenNotFound: boolean
Returns Promise<undefined | FieldType>
sObjectHasField
- sObjectHasField(type, fieldName): Promise<boolean>
-
Parameters
-
type: string
-
fieldName: string
Returns Promise<boolean>
toSalesforceField
- toSalesforceField(type, path): Promise<string>
-
Parameters
-
type: string
-
path: string
Returns Promise<string>
Interface defining the contract for accessing Salesforce schema information