Class SalesforceProfile

Hierarchy

SalesforceProfile

Index

Constructors

Properties

#hasChanges arrayProperties name profileModel sortConfig

Accessors

classes fields hasChanges objects pages

Methods

addClass addField addPage getClassAccess getFieldAccess hasClass hasField hasPage load mergeProfileData removeClass removeField removeItem removePage resetChanges sort toXml update fromXml

Constructors

constructor

new SalesforceProfile(name, profileModel?): SalesforceProfile
Parameters
- name: string
- Optional profileModel: ProfileModel
Returns SalesforceProfile
- Defined in packages/salesforce/src/salesforceProfile.ts:116

Properties

`Private` #hasChanges

#hasChanges: boolean = false

`Private` arrayProperties

arrayProperties: string[] = ...

`Readonly` name

name: string

`Private` profileModel

profileModel: ProfileModel = ...

`Private` sortConfig

sortConfig: ProfileSortConfig = ...

Accessors

classes

get classes(): readonly ProfileApexClass[]
Returns readonly ProfileApexClass[]
- Defined in packages/salesforce/src/salesforceProfile.ts:100

fields

get fields(): readonly ProfileFieldPermission[]
Returns readonly ProfileFieldPermission[]
- Defined in packages/salesforce/src/salesforceProfile.ts:104

hasChanges

get hasChanges(): boolean
Returns boolean
- Defined in packages/salesforce/src/salesforceProfile.ts:96

objects

get objects(): readonly ProfileObjectPermission[]
Returns readonly ProfileObjectPermission[]
- Defined in packages/salesforce/src/salesforceProfile.ts:108

pages

get pages(): readonly ProfilePageAccess[]
Returns readonly ProfilePageAccess[]
- Defined in packages/salesforce/src/salesforceProfile.ts:112

Methods

addClass

addClass(name, enabled): void
Parameters
- name: string
- enabled: boolean
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:240

addField

addField(field, access): void
Parameters
- field: string
- access: SalesforceFieldPermission
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:191

addPage

addPage(name, enabled): void
Parameters
- name: string
- enabled: boolean
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:214

getClassAccess

getClassAccess(name): undefined | boolean
Parameters
- name: string
Returns undefined | boolean
- Defined in packages/salesforce/src/salesforceProfile.ts:235

getFieldAccess

getFieldAccess(fieldName): undefined | SalesforceFieldPermission
Parameters
- fieldName: string
Returns undefined | SalesforceFieldPermission
- Defined in packages/salesforce/src/salesforceProfile.ts:180

hasClass

hasClass(name): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/salesforce/src/salesforceProfile.ts:231

hasField

hasField(...field): boolean
Parameters
- Rest ...field: string[]
Returns boolean
- Defined in packages/salesforce/src/salesforceProfile.ts:176

hasPage

hasPage(name): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/salesforce/src/salesforceProfile.ts:210

load

load(profileXmlBody): SalesforceProfile
Load profile data into the current profile object, profile data is merged with the existing values.
Parameters
- profileXmlBody: string | Buffer
  
  XML body string to load
Returns SalesforceProfile
this
- Defined in packages/salesforce/src/salesforceProfile.ts:137

`Private` mergeProfileData

mergeProfileData(data): void
Parameters
- data: object
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:157

removeClass

removeClass(name): void
Parameters
- name: string
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:253

removeField

removeField(name): void
Parameters
- name: string
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:206

`Private` removeItem

removeItem<TElement>(array, predicate): any
Type Parameters
- TElement
Parameters
- array: TElement[]
- predicate: ((item) => boolean)
  - - (item): boolean
    - Parameters
      
      item: TElement
      
      Returns boolean
Returns any
- Defined in packages/salesforce/src/salesforceProfile.ts:306

removePage

removePage(name): void
Parameters
- name: string
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:227

resetChanges

resetChanges(): void
Reset the change tracking on this profile.

Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:319

sort

sort(): SalesforceProfile
Sort all the entiries in the profile alphabetically. All profile data is sorted in place.

Returns SalesforceProfile
This instance of the profile.
- Defined in packages/salesforce/src/salesforceProfile.ts:273

toXml

toXml(options?): string
Convert the current profile object to XML metadata
Parameters
- Optional options: {
  sort?: boolean;
  }
  - Optional sort?: boolean
Returns string
XML metadata representation of the current profile object
- Defined in packages/salesforce/src/salesforceProfile.ts:261

`Private` update

update<T, K>(target, key, value): void
Update an arbitrary property on the profile object. If the new value is different than the current value, the change will be tracked.
Type Parameters
- T extends object
- K extends string | number | symbol
Parameters
- target: T
  
  The object to update
- key: K
  
  Property name to update
- value: T[K]
  
  Value to set the property to
Returns void
- Defined in packages/salesforce/src/salesforceProfile.ts:299

`Static` fromXml

fromXml(name, profileXmlBody): SalesforceProfile
Load a profile from XML buffer or string that repeats the profile metadata
Parameters
- name: string
  
  Name of the profile; for metadata this is the file name without extension.
- profileXmlBody: string | Buffer
  
  String or buffer containing the profile XML
Returns SalesforceProfile
A profile object
- Defined in packages/salesforce/src/salesforceProfile.ts:128