profile

package
v0.35.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 28, 2026 License: MIT Imports: 12 Imported by: 1

Documentation

Index

Constants

View Source 
const NAME = "Profile"

Variables

View Source 
var ApplicationExistsError = errors.New("application already exists")
View Source 
var ClassExistsError = errors.New("apex class already exists")
View Source 
var CustomPermissionExistsError = errors.New("custom permission already exists")
View Source 
var DuplicateIPRangeError = errors.New("login IP range already exists")
View Source 
var FieldExistsError = errors.New("field already exists")
View Source 
var ObjectExistsError = errors.New("object already exists")
View Source 
var RecordTypeExistsError = errors.New("record type already exists")
View Source 
var TabExistsError = errors.New("tab already exists")
View Source 
var UserPermissionExistsError = errors.New("user permission already exists")
View Source 
var VisualforcePageExistsError = errors.New("visualforce page already exists")

Functions

func NewBooleanText 

func NewBooleanText(val string) BooleanText

Types

type ApplicationFilter 

type ApplicationFilter func(ApplicationVisibility) bool

type ApplicationVisibility 

type ApplicationVisibility struct {
	Application string      `xml:"application"`
	Default     BooleanText `xml:"default"`
	Visible     BooleanText `xml:"visible"`
}

func (ApplicationVisibility) GetName 

func (av ApplicationVisibility) GetName() string

func (ApplicationVisibility) MarshalXML 

func (o ApplicationVisibility) MarshalXML(e *xml.Encoder, start xml.StartElement) error

type ApplicationVisibilityList 

type ApplicationVisibilityList []ApplicationVisibility

func (*ApplicationVisibilityList) Tidy 

func (av *ApplicationVisibilityList) Tidy()

type CustomPermissionFilter 

type CustomPermissionFilter func(permissionset.CustomPermission) bool

type FieldFilter 

type FieldFilter func(permissionset.FieldPermissions) bool

type FieldName 

type FieldName struct {
	Text string `xml:",chardata"`
}

type FlowFilter 

type FlowFilter func(permissionset.FlowAccess) bool

type LayoutAssignment 

type LayoutAssignment struct {
	Layout     string      `xml:"layout"`
	RecordType *RecordType `xml:"recordType"`
}

func (LayoutAssignment) MarshalXML 

func (o LayoutAssignment) MarshalXML(e *xml.Encoder, start xml.StartElement) error

type LayoutAssignmentList 

type LayoutAssignmentList []LayoutAssignment

func (LayoutAssignmentList) Tidy 

func (la LayoutAssignmentList) Tidy()

type LayoutFilter 

type LayoutFilter func(LayoutAssignment) bool

type LoginFlow 

type LoginFlow struct {
	Flow                *string     `xml:"flow"`
	FlowType            string      `xml:"flowType"`
	FriendlyName        string      `xml:"friendlyName"`
	UILoginFlowType     string      `xml:"uiLoginFlowType"`
	UseLightningRuntime BooleanText `xml:"useLightningRuntime"`
	VFFlowPage          *string     `xml:"vfFlowPage"`
	VFFlowPageTitle     *string     `xml:"vfFlowPageTitle"`
}

type LoginFlowsList 

type LoginFlowsList []LoginFlow

type LoginIpRange 

type LoginIpRange struct {
	Description  string `xml:"description,omitempty"`
	EndAddress   string `xml:"endAddress"`
	StartAddress string `xml:"startAddress"`
}

type LoginIpRangeList 

type LoginIpRangeList []LoginIpRange

func (LoginIpRangeList) Tidy 

func (ips LoginIpRangeList) Tidy()

type ObjectFilter 

type ObjectFilter func(permissionset.ObjectPermissions) bool

type ObjectName 

type ObjectName struct {
	Text string `xml:",chardata"`
}

type PermissionName 

type PermissionName struct {
	Text string `xml:",chardata"`
}

type Profile 

type Profile struct {
	metadata.MetadataInfo
	XMLName                 xml.Name                    `xml:"Profile"`
	Xmlns                   string                      `xml:"xmlns,attr"`
	ApplicationVisibilities ApplicationVisibilityList   `xml:"applicationVisibilities"`
	ClassAccesses           permissionset.ApexClassList `xml:"classAccesses"`
	Custom                  struct {
		Text string `xml:",chardata"`
	} `xml:"custom"`
	CustomMetadataTypeAccesses permissionset.CustomMetadataTypeList `xml:"customMetadataTypeAccesses"`
	CustomPermissions          permissionset.CustomPermissionList   `xml:"customPermissions"`
	CustomSettingAccesses      permissionset.CustomSettingList      `xml:"customSettingAccesses"`
	Description                *string                              `xml:"description"`
	FieldPermissions           permissionset.FieldPermissionsList   `xml:"fieldPermissions"`
	FlowAccesses               permissionset.FlowAccessList         `xml:"flowAccesses"`
	LayoutAssignments          LayoutAssignmentList                 `xml:"layoutAssignments"`
	LoginFlows                 *LoginFlow                           `xml:"loginFlows"`
	LoginHours                 *struct {
		Text string `xml:",chardata"`
	} `xml:"loginHours"`
	LoginIPRanges          LoginIpRangeList                    `xml:"loginIpRanges"`
	ObjectPermissions      permissionset.ObjectPermissionsList `xml:"objectPermissions"`
	PageAccesses           permissionset.PageAccessList        `xml:"pageAccesses"`
	RecordTypeVisibilities RecordTypeVisibilityList            `xml:"recordTypeVisibilities"`
	TabVisibilities        TabVisibilityList                   `xml:"tabVisibilities"`
	UserLicense            string                              `xml:"userLicense"`
	UserPermissions        permissionset.UserPermissionList    `xml:"userPermissions"`
}

func Open 

func Open(path string) (*Profile, error)

func (*Profile) AddApplicationVisibility 

func (p *Profile) AddApplicationVisibility(appName string, defaultApp bool) error

func (*Profile) AddClass 

func (p *Profile) AddClass(className string) error

func (*Profile) AddCustomPermission 

func (p *Profile) AddCustomPermission(permissionName string) error

func (*Profile) AddFieldPermissions 

func (p *Profile) AddFieldPermissions(fieldName string) error

func (*Profile) AddLoginIPRange 

func (p *Profile) AddLoginIPRange(start string, end string, description string) error

func (*Profile) AddObjectPermissions 

func (p *Profile) AddObjectPermissions(objectName string) error

func (*Profile) AddRecordType 

func (p *Profile) AddRecordType(recordType string) error

func (*Profile) AddTab 

func (p *Profile) AddTab(tabName string) error

func (*Profile) AddUserPermission 

func (p *Profile) AddUserPermission(permissionName string) error

func (*Profile) AddVisualforcePageAccess 

func (p *Profile) AddVisualforcePageAccess(pageName string) error

func (*Profile) CloneApexClassAccess 

func (p *Profile) CloneApexClassAccess(src, dest string) error

func (*Profile) CloneFieldPermissions 

func (p *Profile) CloneFieldPermissions(src, dest string) error

func (*Profile) CloneObjectPermissions 

func (p *Profile) CloneObjectPermissions(src, dest string) error

func (*Profile) CloneRecordType 

func (p *Profile) CloneRecordType(src, dest string) error

func (*Profile) CloneVisualforcePageAccess 

func (p *Profile) CloneVisualforcePageAccess(src, dest string) error

func (*Profile) DeleteApexClassAccess 

func (p *Profile) DeleteApexClassAccess(apexClassName string) error

func (*Profile) DeleteApplicationVisibility 

func (p *Profile) DeleteApplicationVisibility(applicationName string) error

func (*Profile) DeleteCustomPermission 

func (p *Profile) DeleteCustomPermission(permissionName string) error

func (*Profile) DeleteFieldPermissions 

func (p *Profile) DeleteFieldPermissions(fieldName string) error

func (*Profile) DeleteFlowAccess 

func (p *Profile) DeleteFlowAccess(flowName string) error

func (*Profile) DeleteObjectFieldPermissions 

func (p *Profile) DeleteObjectFieldPermissions(objectName string)

func (*Profile) DeleteObjectLayout 

func (p *Profile) DeleteObjectLayout(objectName string, filters ...LayoutFilter) error

func (*Profile) DeleteObjectLayoutAssignments 

func (p *Profile) DeleteObjectLayoutAssignments(objectName string)

func (*Profile) DeleteObjectPermissions 

func (p *Profile) DeleteObjectPermissions(objectName string)

func (*Profile) DeleteObjectRecordTypeLayoutAssignments 

func (p *Profile) DeleteObjectRecordTypeLayoutAssignments(objectName, recordType string)

func (*Profile) DeleteObjectTabVisibility 

func (p *Profile) DeleteObjectTabVisibility(objectName string)

func (*Profile) DeleteRecordType 

func (p *Profile) DeleteRecordType(recordtype string) error

func (*Profile) DeleteTabVisibility 

func (p *Profile) DeleteTabVisibility(tabName string) error

func (*Profile) DeleteUserPermission 

func (p *Profile) DeleteUserPermission(permissionName string) error

func (*Profile) DeleteVisualforcePageAccess 

func (p *Profile) DeleteVisualforcePageAccess(pageName string) error

func (*Profile) DisableApexClassAccess 

func (p *Profile) DisableApexClassAccess(apexClassName string) error

func (*Profile) DisableCustomPermission 

func (p *Profile) DisableCustomPermission(permissionName string) error

func (*Profile) DisableUserPermission 

func (p *Profile) DisableUserPermission(permissionName string) error

func (*Profile) EnableApexClassAccess 

func (p *Profile) EnableApexClassAccess(apexClassName string) error

func (*Profile) EnableCustomPermission 

func (p *Profile) EnableCustomPermission(permissionName string) error

func (*Profile) EnableUserPermission 

func (p *Profile) EnableUserPermission(permissionName string) error

func (*Profile) GetApexClasses 

func (p *Profile) GetApexClasses() permissionset.ApexClassList

func (*Profile) GetApplications 

func (p *Profile) GetApplications(filters ...ApplicationFilter) []ApplicationVisibility

func (*Profile) GetCustomPermissions 

func (p *Profile) GetCustomPermissions(filters ...CustomPermissionFilter) permissionset.CustomPermissionList

func (*Profile) GetEnabledClasses 

func (p *Profile) GetEnabledClasses() []string

func (*Profile) GetEnabledCustomPermissions 

func (p *Profile) GetEnabledCustomPermissions() []string

func (*Profile) GetEnabledPageAccesses 

func (p *Profile) GetEnabledPageAccesses() []string

func (*Profile) GetEnabledUserPermissions 

func (p *Profile) GetEnabledUserPermissions() []string

func (*Profile) GetFieldPermissions 

func (p *Profile) GetFieldPermissions(filters ...FieldFilter) permissionset.FieldPermissionsList

func (*Profile) GetFlows 

func (p *Profile) GetFlows(filters ...FlowFilter) permissionset.FlowAccessList

func (*Profile) GetGrantedFieldPermissions 

func (p *Profile) GetGrantedFieldPermissions() []permissionset.FieldPermissions

func (*Profile) GetGrantedObjectPermissions 

func (p *Profile) GetGrantedObjectPermissions() []permissionset.ObjectPermissions

func (*Profile) GetLayouts 

func (p *Profile) GetLayouts(filters ...LayoutFilter) LayoutAssignmentList

func (*Profile) GetObjectPermissions 

func (p *Profile) GetObjectPermissions(filters ...ObjectFilter) []permissionset.ObjectPermissions

func (*Profile) GetRecordTypeVisibility 

func (p *Profile) GetRecordTypeVisibility(filters ...RecordTypeFilter) RecordTypeVisibilityList

func (*Profile) GetTabs 

func (p *Profile) GetTabs(filters ...TabFilter) TabVisibilityList

func (*Profile) GetUserPermissions 

func (p *Profile) GetUserPermissions(filters ...UserPermissionFilter) permissionset.UserPermissionList

func (*Profile) GetVisibleApplications 

func (p *Profile) GetVisibleApplications() []string

func (*Profile) GetVisibleRecordTypes 

func (p *Profile) GetVisibleRecordTypes() []string

func (*Profile) GetVisualforcePageVisibility 

func (p *Profile) GetVisualforcePageVisibility() permissionset.PageAccessList

func (*Profile) SetApplicationVisibility 

func (p *Profile) SetApplicationVisibility(applicationName string, updates ApplicationVisibility) error

func (*Profile) SetFieldPermissions 

func (p *Profile) SetFieldPermissions(fieldName string, updates permissionset.FieldPermissions) error

func (*Profile) SetMetadata 

func (c *Profile) SetMetadata(m metadata.MetadataInfo)

func (*Profile) SetObjectLayout 

func (p *Profile) SetObjectLayout(objectName, layoutName string)

func (*Profile) SetObjectLayoutForRecordType 

func (p *Profile) SetObjectLayoutForRecordType(objectName, layoutName, recordType string)

func (*Profile) SetObjectPermissions 

func (p *Profile) SetObjectPermissions(objectName string, updates permissionset.ObjectPermissions) error

func (*Profile) SetRecordTypeVisibility 

func (p *Profile) SetRecordTypeVisibility(fieldName string, updates RecordTypeVisibility) error

func (*Profile) SetTabVisibility 

func (p *Profile) SetTabVisibility(tabName string, visibility string) error

func (*Profile) Tidy 

func (p *Profile) Tidy()

func (*Profile) Type 

func (c *Profile) Type() metadata.MetadataType

func (*Profile) UpdateLoginFlow 

func (p *Profile) UpdateLoginFlow(updates LoginFlow) error

func (*Profile) UpdateVisualforcePageAccess 

func (p *Profile) UpdateVisualforcePageAccess(pageName string, enabled bool) error

type RecordType 

type RecordType struct {
	Text string `xml:",chardata"`
}

type RecordTypeFilter 

type RecordTypeFilter func(RecordTypeVisibility) bool

type RecordTypeVisibility 

type RecordTypeVisibility struct {
	Default              BooleanText  `xml:"default"`
	PersonAccountDefault *BooleanText `xml:"personAccountDefault"`
	permissionset.RecordTypeVisibility
}

func (RecordTypeVisibility) MarshalXML 

func (o RecordTypeVisibility) MarshalXML(e *xml.Encoder, start xml.StartElement) error

type RecordTypeVisibilityList 

type RecordTypeVisibilityList []RecordTypeVisibility

func (RecordTypeVisibilityList) Tidy 

func (rt RecordTypeVisibilityList) Tidy()

type TabFilter 

type TabFilter func(TabVisibility) bool

type TabVisibility 

type TabVisibility struct {
	Tab        string `xml:"tab"`
	Visibility string `xml:"visibility"`
}

func (TabVisibility) MarshalXML 

func (o TabVisibility) MarshalXML(e *xml.Encoder, start xml.StartElement) error

type TabVisibilityList 

type TabVisibilityList []TabVisibility

type UserPermissionFilter 

type UserPermissionFilter func(permissionset.UserPermission) bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.