Enables scripted content fragments to use User Profile Field Groups
Methods
Create
Create a UserProfileFieldGroup
Usage
#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Create($userProfileFieldGroupTitle, "%{UserProfileFieldNames = $userProfileFieldNamesArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupTitle | string | User Profile Field Group Title | Required | ||
UserProfileFieldNames | string | A comma-seperated list of user profile field keys | Optional |
Return Type
Delete
Delete a UserProfileFieldGroup
Usage
#set($additionalInfoResponse = $core_v2_userProfileFieldGroup.Delete($userProfileFieldGroupId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupId | int | User Profile Field Group Id | Required |
Return Type
DynamicFormXml
Returns a UserProfileFieldGroup's Property Groups as Dynamic Configuration XML
Usage
#set($stringResponse = $core_v2_userProfileFieldGroup.DynamicFormXml($userProfileFieldGroupId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupId | int | User Profile Field Group Id | Required |
Return Type
string
DynamicFormXml
Returns a UserProfileFieldGroup's Property Groups as Dynamic Configuration XML
Usage
#set($stringResponse = $core_v2_userProfileFieldGroup.DynamicFormXml($userProfileFieldGroupId, "%{ReadOnly = $readOnlyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupId | int | User Profile Field Group Id | Required | ||
ReadOnly | bool | Read Only | Optional | False |
Return Type
string
Get
Get a UserProfileFieldGroup
Usage
#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Get($userProfileFieldGroupId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupId | int | User Profile Field Group Id | Required |
Return Type
List
List UserProfileFieldGroups
Usage
#set($pagedListResponse = $core_v2_userProfileFieldGroup.List())
Return Type
PagedList<UserProfileFieldGroup>
Update
Update a UserProfileFieldGroup
Usage
#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Update($userProfileFieldGroupId, "%{Title = $titleArg, UserProfileFieldNames = $userProfileFieldNamesArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldGroupId | int | User Profile Field Group Id | Required | ||
Title | string | Profile field group title | Optional | ||
UserProfileFieldNames | string | A comma-seperated list of user profile field keys | Optional |