Class CompositeSchemaAccess

Index

Constructors

Properties

describeAccess schemaStore toolingAccess

Methods

describe dispose enqueueDescribe enqueueTooling getEntityDefinition getFieldDefinition listObjectTypes

Constructors

constructor

new CompositeSchemaAccess(
    schemaStore: SchemaDataStore,
    toolingAccess: ToolingApiSchemaAccess,
    describeAccess: DescribeSchemaAccess,
): CompositeSchemaAccess
Parameters
- schemaStore: SchemaDataStore
- toolingAccess: ToolingApiSchemaAccess
- describeAccess: DescribeSchemaAccess
Returns CompositeSchemaAccess
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:13

Properties

`Private` `Readonly`describeAccess

describeAccess: DescribeSchemaAccess

`Private` `Readonly`schemaStore

schemaStore: SchemaDataStore

`Private` `Readonly`toolingAccess

toolingAccess: ToolingApiSchemaAccess

Methods

describe

describe(type: string): Promise<undefined | DescribeSObjectResult>
Parameters
- type: string
Returns Promise<undefined | DescribeSObjectResult>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:30
describe(type: string, field: string): Promise<undefined | Field>
Parameters
- type: string
- field: string
Returns Promise<undefined | Field>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:31

dispose

dispose(): void
Returns void
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:19

`Private`enqueueDescribe

enqueueDescribe(sobjectType: string): Promise<void>
Parameters
- sobjectType: string
Returns Promise<void>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:59

`Private`enqueueTooling

enqueueTooling(sobjectType: string): Promise<void>
Parameters
- sobjectType: string
Returns Promise<void>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:54

getEntityDefinition

getEntityDefinition(type: string): Promise<undefined | EntityDefinition>
Parameters
- type: string
Returns Promise<undefined | EntityDefinition>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:39

getFieldDefinition

getFieldDefinition(
type: string,
field: string,
): Promise<undefined | FieldDefinition>
Parameters
- type: string
- field: string
Returns Promise<undefined | FieldDefinition>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:46

listObjectTypes

listObjectTypes(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/salesforce/src/schema/compositeSchemaAccess.ts:26