Enables scripted content fragments to use User Profile Fields
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ProfileFieldTypes | List<UserProfileFieldType> | List of User Profile Field Types |
Methods
Create
Create a UserProfileField
Usage
#set($userProfileFieldResponse = $core_v2_userProfileField.Create($userProfileFieldTitle, $fieldTypeId, "%{FieldTypeChoices = $fieldTypeChoicesArg, IsSearchable = $isSearchableArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldTitle | string | User Profile Field Title | Required | ||
fieldTypeId | int | Field Type Id | Required | ||
FieldTypeChoices | string | Profile field choices are key-value pairs set using the syntax _ProfileFieldChoices_Label=value. | Optional | ||
IsSearchable | bool | Searchability | Optional |
Return Type
Delete
Delete a UserProfileField
Usage
#set($additionalInfoResponse = $core_v2_userProfileField.Delete($userProfileFieldName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | string | User Profile Field Name | Required |
Return Type
DynamicFormXml
Get all the properties for a UserProfileField as Dynamic Configuration XML
Usage
#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | string | User Profile Field Name | Required |
Return Type
string
DynamicFormXml
Get all the properties for a UserProfileField as Dynamic Configuration XML
Usage
#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName, "%{OrderNumber = $orderNumberArg, ReadOnly = $readOnlyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | string | User Profile Field Name | Required | ||
OrderNumber | int | Order Number | Optional | ||
ReadOnly | bool | Read Only | Optional |
Return Type
string
Get
Get a UserProfileField
Usage
#set($userProfileFieldResponse = $core_v2_userProfileField.Get($userProfileFieldName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | string | User Profile Field Name | Required |
Return Type
List
List UserProfileFields
Usage
#set($pagedListResponse = $core_v2_userProfileField.List())
Return Type
List
List UserProfileFields
Usage
#set($pagedListResponse = $core_v2_userProfileField.List("%{IsSearchable = $isSearchableArg, UserProfileFieldGroupId = $userProfileFieldGroupIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
IsSearchable | bool | Searchability | Optional | ||
UserProfileFieldGroupId | int | Profile field group to filter by | Optional |
Return Type
Update
Update a UserProfileField
Usage
#set($userProfileFieldResponse = $core_v2_userProfileField.Update($userProfileFieldName, "%{FieldTypeChoices = $fieldTypeChoicesArg, FieldTypeId = $fieldTypeIdArg, IsSearchable = $isSearchableArg, Title = $titleArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | string | User Profile Field Name | Required | ||
FieldTypeChoices | string | Profile field choices are key-value pairs set using the syntax _FieldTypeChoices_Label=value. | Optional | ||
FieldTypeId | int | Profile field type | Optional | ||
IsSearchable | bool | Searchability | Optional | ||
Title | string | Profile field title | Optional |