Enables scripted content fragments to use User Profile Fields
Properties
Name | Access | Type | Description |
---|---|---|---|
ProfileFieldTypes | Read | List of UserProfileFieldType | List of User Profile Field Types |
Methods
Create
Create a UserProfileField
Velocity
#set($userProfileFieldResponse = $core_v2_userProfileField.Create($userProfileFieldTitle, $fieldTypeId, "%{ FieldTypeChoices = $fieldTypeChoicesArg, IsSearchable = $isSearchableArg }"))
JavaScript
var 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 | Int32 | Field Type Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
FieldTypeChoices | String | Profile field choices are key-value pairs set using the syntax _ProfileFieldChoices_Label=value. | Optional | ||
IsSearchable | Boolean | Searchability | Optional |
Returns
Delete
Delete a UserProfileField
Velocity
#set($additionalInfoResponse = $core_v2_userProfileField.Delete($userProfileFieldName))
JavaScript
var additionalInfoResponse = core_v2_userProfileField.Delete(userProfileFieldName);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | String | User Profile Field Name | Required |
Returns
DynamicFormXml
DynamicFormXml Overload 1
Get all the properties for a UserProfileField as Dynamic Configuration XML
Velocity
#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName))
JavaScript
var stringResponse = core_v2_userProfileField.DynamicFormXml(userProfileFieldName);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | String | User Profile Field Name | Required |
DynamicFormXml Overload 2
Get all the properties for a UserProfileField as Dynamic Configuration XML
Velocity
#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName, "%{ OrderNumber = $orderNumberArg, ReadOnly = $readOnlyArg }"))
JavaScript
var stringResponse = core_v2_userProfileField.DynamicFormXml(userProfileFieldName, { OrderNumber: orderNumberArg, ReadOnly: readOnlyArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | String | User Profile Field Name | Required | ||
options | Options | Set of optional parameters including: | Required | ||
OrderNumber | Int32 | Order Number | Optional | ||
ReadOnly | Boolean | Read Only | Optional |
Returns
String
Get
Get a UserProfileField
Velocity
#set($userProfileFieldResponse = $core_v2_userProfileField.Get($userProfileFieldName))
JavaScript
var userProfileFieldResponse = core_v2_userProfileField.Get(userProfileFieldName);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userProfileFieldName | String | User Profile Field Name | Required |
Returns
List
List Overload 1
List UserProfileFields
Velocity
#set($pagedListResponse = $core_v2_userProfileField.List())
JavaScript
var pagedListResponse = core_v2_userProfileField.List();
List Overload 2
List UserProfileFields
Velocity
#set($pagedListResponse = $core_v2_userProfileField.List("%{ IsSearchable = $isSearchableArg, UserProfileFieldGroupId = $userProfileFieldGroupIdArg }"))
JavaScript
var pagedListResponse = core_v2_userProfileField.List({ IsSearchable: isSearchableArg, UserProfileFieldGroupId: userProfileFieldGroupIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
IsSearchable | Boolean | Searchability | Optional | ||
UserProfileFieldGroupId | Int32 | Profile field group to filter by | Optional |
Returns
Update
Update a UserProfileField
Velocity
#set($userProfileFieldResponse = $core_v2_userProfileField.Update($userProfileFieldName, "%{ FieldTypeChoices = $fieldTypeChoicesArg, FieldTypeId = $fieldTypeIdArg, IsSearchable = $isSearchableArg, Title = $titleArg }"))
JavaScript
var 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 | ||
options | Options | Set of optional parameters including: | Required | ||
FieldTypeChoices | String | Profile field choices are key-value pairs set using the syntax _FieldTypeChoices_Label=value. | Optional | ||
FieldTypeId | Int32 | Profile field type | Optional | ||
IsSearchable | Boolean | Searchability | Optional | ||
Title | String | Profile field title | Optional |