vlocode-project - v1.40.0-beta-4
Preparing search index...
salesforce/src
ISalesforceSchemaService
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
SalesforceSchemaService
Index
Methods
describe
By
Prefix
describe
Custom
Metadata
Objects
describe
Picklist
Values
describe
S
Object
describe
S
Object
By
Id
describe
S
Object
By
Prefix
describe
S
Object
Field
describe
S
Object
Field
Path
describe
S
Objects
dispose
filter
Ids
get
Name
Field
get
S
Object
Fields
is
S
Object
Defined
is
S
Object
Field
Defined
s
Object
Get
Field
Type
s
Object
Has
Field
to
Salesforce
Field
Methods
describe
By
Prefix
describeByPrefix
(
prefix
:
string
)
:
Promise
<
undefined
|
DescribeSObjectResult
>
Parameters
prefix
:
string
Returns
Promise
<
undefined
|
DescribeSObjectResult
>
describe
Custom
Metadata
Objects
describeCustomMetadataObjects
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
describe
Picklist
Values
describePicklistValues
(
type
:
string
,
fieldName
:
string
,
)
:
Promise
<
PicklistEntry
[]
>
Parameters
type
:
string
fieldName
:
string
Returns
Promise
<
PicklistEntry
[]
>
describePicklistValues
(
type
:
string
,
fieldName
:
string
,
throwWhenNotFound
:
boolean
,
)
:
Promise
<
undefined
|
PicklistEntry
[]
>
Parameters
type
:
string
fieldName
:
string
throwWhenNotFound
:
boolean
Returns
Promise
<
undefined
|
PicklistEntry
[]
>
describe
S
Object
describeSObject
(
type
:
string
)
:
Promise
<
DescribeSObjectResult
>
Parameters
type
:
string
Returns
Promise
<
DescribeSObjectResult
>
describeSObject
(
type
:
string
,
throwWhenNotFound
:
boolean
,
)
:
Promise
<
undefined
|
DescribeSObjectResult
>
Parameters
type
:
string
throwWhenNotFound
:
boolean
Returns
Promise
<
undefined
|
DescribeSObjectResult
>
describe
S
Object
By
Id
describeSObjectById
(
id
:
string
)
:
Promise
<
DescribeSObjectResult
>
Parameters
id
:
string
Returns
Promise
<
DescribeSObjectResult
>
describe
S
Object
By
Prefix
describeSObjectByPrefix
(
prefix
:
string
)
:
Promise
<
DescribeSObjectResult
>
Parameters
prefix
:
string
Returns
Promise
<
DescribeSObjectResult
>
describe
S
Object
Field
describeSObjectField
(
type
:
string
,
fieldName
:
string
)
:
Promise
<
Field
>
Parameters
type
:
string
fieldName
:
string
Returns
Promise
<
Field
>
describeSObjectField
(
type
:
string
,
fieldName
:
string
,
throwWhenNotFound
:
boolean
,
)
:
Promise
<
undefined
|
Field
>
Parameters
type
:
string
fieldName
:
string
throwWhenNotFound
:
boolean
Returns
Promise
<
undefined
|
Field
>
describe
S
Object
Field
Path
describeSObjectFieldPath
(
type
:
string
,
fieldName
:
string
)
:
Promise
<
Field
[]
>
Parameters
type
:
string
fieldName
:
string
Returns
Promise
<
Field
[]
>
describeSObjectFieldPath
(
type
:
string
,
fieldName
:
string
,
throwWhenNotFound
:
boolean
,
)
:
Promise
<
undefined
|
readonly
Field
[]
>
Parameters
type
:
string
fieldName
:
string
throwWhenNotFound
:
boolean
Returns
Promise
<
undefined
|
readonly
Field
[]
>
describe
S
Objects
describeSObjects
()
:
Promise
<
DescribeGlobalSObjectResult
[]
>
Returns
Promise
<
DescribeGlobalSObjectResult
[]
>
dispose
dispose
()
:
void
Returns
void
filter
Ids
filterIds
(
ids
:
string
|
string
[]
,
predicate
:
(
type
:
DescribeSObjectResult
,
id
:
string
)
=>
boolean
,
)
:
Promise
<
string
[]
>
Parameters
ids
:
string
|
string
[]
predicate
:
(
type
:
DescribeSObjectResult
,
id
:
string
)
=>
boolean
Returns
Promise
<
string
[]
>
get
Name
Field
getNameField
(
type
:
string
)
:
Promise
<
undefined
|
string
>
Parameters
type
:
string
Returns
Promise
<
undefined
|
string
>
get
S
Object
Fields
getSObjectFields
(
type
:
string
)
:
Promise
<
ReadonlyMap
<
string
,
Field
>
>
Parameters
type
:
string
Returns
Promise
<
ReadonlyMap
<
string
,
Field
>
>
is
S
Object
Defined
isSObjectDefined
(
type
:
string
)
:
Promise
<
boolean
>
Parameters
type
:
string
Returns
Promise
<
boolean
>
is
S
Object
Field
Defined
isSObjectFieldDefined
(
type
:
string
,
field
:
string
)
:
Promise
<
boolean
>
Parameters
type
:
string
field
:
string
Returns
Promise
<
boolean
>
s
Object
Get
Field
Type
sObjectGetFieldType
(
type
:
string
,
fieldName
:
string
)
:
Promise
<
FieldType
>
Parameters
type
:
string
fieldName
:
string
Returns
Promise
<
FieldType
>
sObjectGetFieldType
(
type
:
string
,
fieldName
:
string
,
throwWhenNotFound
:
boolean
,
)
:
Promise
<
undefined
|
FieldType
>
Parameters
type
:
string
fieldName
:
string
throwWhenNotFound
:
boolean
Returns
Promise
<
undefined
|
FieldType
>
s
Object
Has
Field
sObjectHasField
(
type
:
string
,
fieldName
:
string
)
:
Promise
<
boolean
>
Parameters
type
:
string
fieldName
:
string
Returns
Promise
<
boolean
>
to
Salesforce
Field
toSalesforceField
(
type
:
string
,
path
:
string
)
:
Promise
<
string
>
Parameters
type
:
string
path
:
string
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
Methods
describe
By
Prefix
describe
Custom
Metadata
Objects
describe
Picklist
Values
describe
S
Object
describe
S
Object
By
Id
describe
S
Object
By
Prefix
describe
S
Object
Field
describe
S
Object
Field
Path
describe
S
Objects
dispose
filter
Ids
get
Name
Field
get
S
Object
Fields
is
S
Object
Defined
is
S
Object
Field
Defined
s
Object
Get
Field
Type
s
Object
Has
Field
to
Salesforce
Field
vlocode-project - v1.40.0-beta-4
Loading...
Interface defining the contract for accessing Salesforce schema information