Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
ChildRelationship Class
DataCategory Class
DataCategoryGroupSobjectTypePair Class
DescribeColorResult Class
Describe​DataCategoryGroupResult Class
Describe​DataCategoryGroupStructureResult Class
DescribeFieldResult Class
DescribeIconResult Class
DescribeSObjectResult Class
DescribeTabResult Class
DescribeTabSetResult Class
DisplayType Enum
FieldDescribeOptions Enum
FieldSet Class
FieldSetMember Class
PicklistEntry Class
RecordTypeInfo Class
SOAPType Enum
SObjectDescribeOptions Enum
SObjectField Class
sObjectField Methods
SObjectType Class
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

SObjectField Class

A Schema.sObjectField object is returned from the field describe result using the getController and getSObjectField methods.

Namespace

Schema

Example

1Schema.DescribeFieldResult F = Account.Industry.getDescribe();
2Schema.sObjectField T = F.getSObjectField();

sObjectField Methods

The following are instance methods for sObjectField.

getDescribe()

Returns the describe field result for this field.

Signature

public Schema.DescribeFieldResult getDescribe()

Return Value

Type: Schema.DescribeFieldResult

getDescribe(options)

Returns the describe field result for this field. This method also provides an option to get all the describe field results for an object.

Signature

public Schema.DescribeFieldResult getDescribe(Object options)

Parameters

  • options:

    Type:

    Object Use this parameter to pass FieldDescribeOptions.FULL_DESCRIBE when a subset of system objects could have different results for picklist values based on the context they're invoked in. This parameter computes all aspects of describe field results.

    For example, AIConversationContext.PersonType field is a picklist that contains a list of accessible object types.

Return Value

Type: Schema.DescribeFieldResult