vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Interface ISalesforceSchemaService

    Interface defining the contract for accessing Salesforce schema information

    interface ISalesforceSchemaService {
        describeByPrefix(
            prefix: string,
        ): Promise<undefined | DescribeSObjectResult>;
        describeCustomMetadataObjects(): Promise<string[]>;
        describePicklistValues(
            type: string,
            fieldName: string,
        ): Promise<PicklistEntry[]>;
        describePicklistValues(
            type: string,
            fieldName: string,
            throwWhenNotFound: boolean,
        ): Promise<undefined | PicklistEntry[]>;
        describeSObject(type: string): Promise<DescribeSObjectResult>;
        describeSObject(
            type: string,
            throwWhenNotFound: boolean,
        ): Promise<undefined | DescribeSObjectResult>;
        describeSObjectById(id: string): Promise<DescribeSObjectResult>;
        describeSObjectByPrefix(prefix: string): Promise<DescribeSObjectResult>;
        describeSObjectField(type: string, fieldName: string): Promise<Field>;
        describeSObjectField(
            type: string,
            fieldName: string,
            throwWhenNotFound: boolean,
        ): Promise<undefined | Field>;
        describeSObjectFieldPath(type: string, fieldName: string): Promise<Field[]>;
        describeSObjectFieldPath(
            type: string,
            fieldName: string,
            throwWhenNotFound: boolean,
        ): Promise<undefined | readonly Field[]>;
        describeSObjects(): Promise<DescribeGlobalSObjectResult[]>;
        dispose(): void;
        filterIds(
            ids: string | string[],
            predicate: (type: DescribeSObjectResult, id: string) => boolean,
        ): Promise<string[]>;
        getNameField(type: string): Promise<undefined | string>;
        getSObjectFields(type: string): Promise<ReadonlyMap<string, Field>>;
        isSObjectDefined(type: string): Promise<boolean>;
        isSObjectFieldDefined(type: string, field: string): Promise<boolean>;
        sObjectGetFieldType(type: string, fieldName: string): Promise<FieldType>;
        sObjectGetFieldType(
            type: string,
            fieldName: string,
            throwWhenNotFound: boolean,
        ): Promise<undefined | FieldType>;
        sObjectHasField(type: string, fieldName: string): Promise<boolean>;
        toSalesforceField(type: string, path: string): Promise<string>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • type: string
      • fieldName: string

      Returns Promise<PicklistEntry[]>

    • Parameters

      • type: string
      • fieldName: string
      • throwWhenNotFound: boolean

      Returns Promise<undefined | PicklistEntry[]>