mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 19:50:42 +08:00
48 lines
10 KiB
JSON
48 lines
10 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"fields",
|
|
"wsdl_segment",
|
|
"declarative_metadata_sample_definition"
|
|
],
|
|
"title": "ProfileActionOverride - Metadata API",
|
|
"description": "Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. In API versions 39.0 to 44.0, you can access ProfileActionOverride by accessing its encompassing CustomApplication or Profile metadata types. In API version 45.0 and later, you can access ProfileActionOverride only by accessing its encompassing CustomApplication.",
|
|
"fields_columns": [
|
|
"type",
|
|
"description"
|
|
],
|
|
"fields": {
|
|
"actionName": {
|
|
"type": "string",
|
|
"description": "The name of the action. The only valid values are Tab and View. If pageOrSobjectType is standard-home, this field must be Tab. The Tab action is supported only when ProfileActionOverride is being specified as part of a Profile in API version 39.0 to 44.0. In API version 45.0 and later, this action is supported only when ProfileActionOverride is being specified as part of a CustomApplication, pageOrSobjectType is standard-home, and this field is Tab. If pageOrSobjectType is record-home, this field must be View. The View action is supported only when ProfileActionOverride is being specified as part of a CustomApplication."
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"description": "Read-only. Represents the name of the Lightning page being used as the override."
|
|
},
|
|
"formFactor": {
|
|
"type": "FormFactor (enumeration of type string)",
|
|
"description": "The size of the page being overridden. The Large value represents the Lightning Experience desktop environment."
|
|
},
|
|
"pageOrSobjectType": {
|
|
"type": "string",
|
|
"description": "The name of the page being overridden. The only valid values are record-home and standard-home. If the actionName is Tab, this field must be standard-home"
|
|
},
|
|
"recordType": {
|
|
"type": "string",
|
|
"description": "The record type associated with the override. If pageOrSobjectType is standard-home, this field must be null. This field is required when actionName is set to View."
|
|
},
|
|
"type": {
|
|
"type": "ActionOverrideType (enumeration of type string)",
|
|
"description": "Read-only. The type of action override. The only valid value is flexipage."
|
|
}
|
|
},
|
|
"wsdl_segment": "```xml\n<xsd:simpleType name=\"ActionOverrideType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Default\"/>\n <xsd:enumeration value=\"Standard\"/>\n <xsd:enumeration value=\"Scontrol\"/>\n <xsd:enumeration value=\"Visualforce\"/>\n <xsd:enumeration value=\"Flexipage\"/>\n <xsd:enumeration value=\"LightningComponent\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"AppProfileActionOverride\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:ProfileActionOverride\">\n <xsd:sequence>\n <xsd:element name=\"profile\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"CustomApplication\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"actionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:AppActionOverride\"/>\n <xsd:element name=\"brand\" minOccurs=\"0\" type=\"tns:AppBrand\"/>\n <xsd:element name=\"consoleConfig\" minOccurs=\"0\" type=\"tns:ServiceCloudConsoleConfig\"/>\n <xsd:element name=\"defaultLandingTab\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"formFactors\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FormFactor\"/>\n <xsd:element name=\"isNavAutoTempTabsDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isNavPersonalizationDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isNavTabPersistenceDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isOmniPinnedViewEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"isServiceCloudConsole\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"logo\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"navType\" minOccurs=\"0\" type=\"tns:NavType\"/>\n <xsd:element name=\"preferences\" minOccurs=\"0\" type=\"tns:AppPreferences\"/>\n <xsd:element name=\"profileActionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:AppProfileActionOverride\"/>\n <xsd:element name=\"setupExperience\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"subscriberTabs\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"tabs\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"uiBundle\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"uiType\" minOccurs=\"0\" type=\"tns:UiType\"/>\n <xsd:element name=\"utilityBar\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"workspaceConfig\" minOccurs=\"0\" type=\"tns:AppWorkspaceConfig\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"FormFactor\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Small\"/>\n <xsd:enumeration value=\"Medium\"/>\n <xsd:enumeration value=\"Large\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Profile\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"agentAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileAgentAccess\"/>\n <xsd:element name=\"applicationVisibilities\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileApplicationVisibility\"/>\n <xsd:element name=\"categoryGroupVisibilities\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileCategoryGroupVisibility\"/>\n <xsd:element name=\"classAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileApexClassAccess\"/>\n <xsd:element name=\"custom\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"customMetadataTypeAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileCustomMetadataTypeAccess\"/>\n <xsd:element name=\"customPermissions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileCustomPermissions\"/>\n <xsd:element name=\"customSettingAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileCustomSettingAccess\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalDataSourceAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileExternalDataSourceAccess\"/>\n <xsd:element name=\"fieldPermissions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileFieldLevelSecurity\"/>\n <xsd:element name=\"flowAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileFlowAccess\"/>\n <xsd:element name=\"genComputingSummaryDefAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileGenComputingSummaryDefAccess\"/>\n <xsd:element name=\"layoutAssignments\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileLayoutAssignment\"/>\n <xsd:element name=\"loginFlows\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:LoginFlow\"/>\n <xsd:element name=\"loginHours\" minOccurs=\"0\" type=\"tns:ProfileLoginHours\"/>\n <xsd:element name=\"loginIpRanges\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileLoginIpRange\"/>\n <xsd:element name=\"objectPermissions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileObjectPermissions\"/>\n <xsd:element name=\"pageAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileApexPageAccess\"/>\n <xsd:element name=\"profileActionOverrides\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileActionOverride\"/>\n <xsd:element name=\"recordTypeVisibilities\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileRecordTypeVisibility\"/>\n <xsd:element name=\"servicePresenceStatusAccesses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileServicePresenceStatusAccess\"/>\n <xsd:element name=\"tabVisibilities\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileTabVisibility\"/>\n <xsd:element name=\"userLicense\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"userPermissions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ProfileUserPermission\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ProfileActionOverride\">\n <xsd:sequence>\n <xsd:element name=\"actionName\" type=\"xsd:string\"/>\n <xsd:element name=\"content\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"formFactor\" type=\"tns:FormFactor\"/>\n <xsd:element name=\"pageOrSobjectType\" type=\"xsd:string\"/>\n <xsd:element name=\"recordType\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"type\" type=\"tns:ActionOverrideType\"/>\n </xsd:sequence>\n</xsd:complexType>\n```",
|
|
"declarative_metadata_sample_definition": [
|
|
{
|
|
"description": "You can define a ProfileActionOverride like this.",
|
|
"code": "<CustomApplication xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <profileActionOverrides>\n <actionName>View</actionName>\n <content>CustomObjectFlexiPage</content>\n <formFactor>Large</formFactor>\n <pageOrSobjectType>TestObj__c</pageOrSobjectType>\n <type>Flexipage</type>\n <profile>standard</profile>\n <recordType>TestObj__c.TestRecordType</recordType>\n </profileActionOverrides>\n <defaultLandingTab>standard-home</defaultLandingTab>\n <formFactors>Large</formFactors>\n <label>My Custom App</label>\n <tab>standard-Account</tab>\n <tab>standard-Opportunity</tab>\n <uiType>Lightning</uiType>\n <navType>Standard</navType>\n</CustomApplication>"
|
|
}
|
|
]
|
|
} |