\GravityUser

A user in the recommendation system. A user is an entity which generates event, and can get recommendations.

Summary

Methods
Properties
Constants
__construct()
$userId
$nameValues
$hidden
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$userId

$userId : string

This is a unqiue identifier for a registered user.

Strings in the PHP client are always UTF-8 encoded.

Type

string

$nameValues

$nameValues : array<mixed,\GravityNameValue>

NameValues provide additional description of the user.

There can multiple NameValues with the same name. The order of NameValues will not be preserved.

The recommendation engine in most cases does not require detailed information about the users, usually only some basic information can be used to enhance the quality of recommendation. For example:

NameDescription
ZipCodeThe zip code of the user.
CityThe city of the user.
CountryThe country of the user.

Type

array<mixed,\GravityNameValue>

$hidden

$hidden : boolean

True if the user is hidden. A no more existing user should be set to hidden.

Type

boolean

Methods

__construct()

__construct()