Syntax
getUserProperty(userNameOrKey, propertyKey)
Description
Gets the specified user property.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| string | Yes | User name or user key to get a property for. |
propertyKey | string | Yes | Key of the property to retrieve. |
Return type
string
Returns the value of the specified property. If the user does not have the property, it will return an empty string.
Example
Example 1
string customProperty = getUserProperty("jdoe", "custom.property");
Returns the value of property "custom.property" for a user "jdoe".
See also