Manual Reference Source Test 
import IdentityProperty from 'src/modules/identity-property.js'
public class | source

IdentityProperty

Identity property configuration

Static Member Summary

Static Public Members
public static get

Keys of credential properties:

  • email: Email
  • facebookId: Facebook user id
  • id: IDM user id
  • tcDate: Terms and conditions agreement date (number: milliseconds since epoch)
  • username: Username
public static get

Standard identity properties:

  • address: Address (line 1)
  • address2: Address (line 2)
  • birthday: Birthday
  • country: Country
  • firstName: First (a.k.a: given) name
  • gender: Gender (e.g: male/female/other?)
  • lastName: Last name (a.k.a: surname)
  • phone: Phone
  • state: State
  • zip: Zip code

Constructor Summary

Public Constructor
public

constructor(options: Object)

IdentityProperty constructor

Static Public Members

public static get credentialKeys: string[] source

Keys of credential properties:

  • email: Email
  • facebookId: Facebook user id
  • id: IDM user id
  • tcDate: Terms and conditions agreement date (number: milliseconds since epoch)
  • username: Username

Note: These don't have configurable labels etc. but they can be requested and read

public static get standardMap: Map<string, string>: Map<string, IdentityProperty> source

Standard identity properties:

  • address: Address (line 1)
  • address2: Address (line 2)
  • birthday: Birthday
  • country: Country
  • firstName: First (a.k.a: given) name
  • gender: Gender (e.g: male/female/other?)
  • lastName: Last name (a.k.a: surname)
  • phone: Phone
  • state: State
  • zip: Zip code

Return:

Map<string, string>

Public Constructors

public constructor(options: Object) source

IdentityProperty constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

Options
options.label string
  • optional
  • default: ''

Label to display next to property input
options.detail string
  • optional
  • default: ''

Detail text to display in small font next to property input
options.placeholder string
  • optional
  • default: ''

Placeholder value to show in input when empty
options.type string
  • optional
  • default: 'string'

Value type, one of: string/number/boolean or special type
options.value string | number | boolean
  • optional

Initial input value (type should match)
options.request boolean
  • optional
  • default: false

Whether to request this property during authentication
options.required boolean
  • optional
  • default: false

Whether input value is required
options.mask string
  • optional

Mask string to format the value using an input mask
options.min number
  • optional

Minimum string length / number value
options.max number
  • optional

Maximum string length / number value
options.pattern string
  • optional

Regular expression that string should match
options.mode string
  • optional

Input mode hint to the type of data that will be entered by the user
options.errorMessage string
  • optional

Message to be displayed on field error
options.order string
  • optional
  • default: ['month', 'day', 'year']

The order in which a date field should be displayed
options.options string
  • optional

Select field options