ProfileField Type

A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'. It does not contain any user data related to the field. A profile field can be a variety of types (textfield, select list, etc) and collectively create a user's profile.

Type Template

<...>
    <!-- List of ... -->
    <descriptions>
        <!-- Contents of LocaleString -->
    <descriptions>
    <!-- List of ... -->
    <displayNames>
        <!-- Contents of LocaleString -->
    <displayNames>
    <editable>xs:boolean</editable>
    <filterable>xs:boolean</filterable>
    <ID>xs:long</ID>
    <index>xs:int</index>
    <name>xs:string</name>
    <!-- List of ... -->
    <options>
        <!-- Contents of ProfileFieldOption -->
    <options>
    <required>xs:boolean</required>
    <searchable>xs:boolean</searchable>
    <typeID>xs:int</typeID>
    <visibleToGuests>xs:boolean</visibleToGuests>
    <visibleToUsers>xs:boolean</visibleToUsers>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element	Description
descriptions	Setting Sets the locale specific descriptions for this profile field. Getting Gets the locale specific descriptions for this profile field.
displayNames	Setting Sets the locale specific display names for this profile field. Getting Gets the locale specific display names for this profile field.
editable	Setting Sets whether or not this profile field is editable by the user. Getting Gets whether or not this profile field is editable by the user.
filterable	Setting Sets whether or not this profile field is filterable. Getting Gets whether or not this profile field is filterable.
ID	Setting Sets the id representing this profile field. Getting
index	Setting Sets the index of this profile field. The index specifies the order in which the profile fields will be displayed. Getting Gets the index of this profile field. The index specifies the order in which the profile fields will be displayed.
name	Setting Getting Gets the internal name of this profile field. The internal name is unique and generally used for internal actions.
options	Setting Sets a array of ProfileFieldOption objects for this profile field. Getting Gets a array of ProfileFieldOption objects for this profile field.
required	Setting Sets whether or not this profile field is a required field. Getting Gets whether or not this profile field is a required field.
searchable	Setting Sets whether or not this profile field is searchable. Getting Gets whether or not this profile field is searchable.
typeID	Setting Sets the id of the type of this profile field. Getting Gets the id of the type of this profile field.
visibleToGuests	Setting Sets whether or not this profile field is visible by guests. Getting Gets whether or not this profile field is visible by guests.
visibleToUsers	Setting Sets whether or not this profile field is visible by registered users. Getting Gets whether or not this profile field is visible by registered users.