UserProfileFields In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:09 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:09

Work with User's profile fields

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUserProfileFields>() and is defined in Telligent.Evolution.Platform.dll

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	User Profile Fields data type identifier
ProfileFieldTypes	`IEnumerable<[[UserProfileFieldType In-Process API Supplementary Type\|UserProfileFieldType]]>`	List of User Profile Field Types

Methods

UserProfileField Create(string userProfileFieldTitle, int fieldTypeId, UserProfileFieldsCreateOptions options);

Create a User Profile Field

Parameters

Name	Type	Description	Required
userProfileFieldTitle	`string`	User's Profile field title	Required
fieldTypeId	`int`	User's Profile field type id	Required
options	`[[UserProfileFieldsCreateOptions In-Process API Supplementary Type\|UserProfileFieldsCreateOptions]]`	User's Profile fields create options	Required

Return Type

[[UserProfileField In-Process API Supplementary Type|UserProfileField]]

AdditionalInfo Delete(string userProfileFieldName);

Delete a User Profile Field by name

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`string`	User's Profile field name	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

UserProfileField Get(string userProfileFieldName);

Get a User Profile Field by name

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`string`	Specified profile field name	Required

Return Type

[[UserProfileField In-Process API Supplementary Type|UserProfileField]]

PagedList<UserProfileField> List();

Get a User Profile Fields List

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[UserProfileField In-Process API Supplementary Type|UserProfileField]]>

PagedList<UserProfileField> List(UserProfileFieldsListOptions options);

Get a User Profile fields List

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UserProfileFieldsListOptions In-Process API Supplementary Type\|UserProfileFieldsListOptions]]`	User's Profile fields list get options	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[UserProfileField In-Process API Supplementary Type|UserProfileField]]>

UserProfileField Update(string userProfileFieldName, UserProfileFieldsUpdateOptions options);

Update a User Profile Field by name

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`string`	User's Profile field name	Required
options	`[[UserProfileFieldsUpdateOptions In-Process API Supplementary Type\|UserProfileFieldsUpdateOptions]]`	User's Profile fields update options	Required

Return Type

[[UserProfileField In-Process API Supplementary Type|UserProfileField]]