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
DescribeDataCategoryGroupStructureResult Methods
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
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.

Describe​DataCategoryGroupStructureResult Class

Contains the category groups and categories associated with KnowledgeArticleVersion and Question.

Namespace

Schema

Usage

The describeDataCategoryGroupStructures method returns a list of Schema.Describe​DataCategoryGroupStructureResult objects containing the category groups and categories associated with the specified object.

For additional information and code examples, see Accessing All Data Categories Associated with an sObject.

Example

The following is an example of how to instantiate a data category group structure describe result object:
1List <DataCategoryGroupSobjectTypePair> pairs = 
2      new List<DataCategoryGroupSobjectTypePair>();
3
4DataCategoryGroupSobjectTypePair pair1 = 
5      new DataCategoryGroupSobjectTypePair();
6pair1.setSobject('KnowledgeArticleVersion');
7pair1.setDataCategoryGroupName('Regions');
8
9DataCategoryGroupSobjectTypePair pair2 = 
10      new DataCategoryGroupSobjectTypePair();
11pair2.setSobject('Questions');
12pair2.setDataCategoryGroupName('Regions');
13
14pairs.add(pair1);
15pairs.add(pair2);
16
17List<Schema.DescribeDataCategoryGroupStructureResult>results = 
18      Schema.describeDataCategoryGroupStructures(pairs, true);

DescribeDataCategoryGroupStructureResult Methods

The following are methods for DescribeDataCategoryGroupStructureResult. All are instance methods.

getDescription()

Returns the description of the data category group.

Signature

public String getDescription()

Return Value

Type: String

getLabel()

Returns the label for the data category group used in the Salesforce user interface.

Signature

public String getLabel()

Return Value

Type: String

getName()

Returns the unique name used by the API to access to the data category group.

Signature

public String getName()

Return Value

Type: String

getSobject()

Returns the name of object associated with the data category group.

Signature

public String getSobject()

Return Value

Type: String

getTopCategories()

Returns a Schema.DataCategory object, that contains the top categories visible depending on the user's data category group visibility settings.

Signature

public List<Schema.DataCategory> getTopCategories()

Return Value

Type: List<Schema.DataCategory>

Usage

For more information on data category group visibility, see “Data Category Visibility” in the Salesforce online help.