Profile¶

An Profile is an object containing a user’s specific social metadata and information. Each profile can have an alias name by which to identify the user other than their real name. A data property is provided to allow for an arbitrary storage of any metadata desired by the application. A presence property is also provided for storing the applications-specific current online state of the user.

The following is the list of all members included in the data schema.

Member	Description	Type	Default Value	Identifier	Unique	Required
`alias`	The non-unique alternate name of the user.	`string`	`""`	false	false	true
`avatar`	The URL, asset uid or other global identifier that references the user’s avatar.	`string`	`""`	false	false	true
`data`	An arbitrary map of key-value pairs containing the metadata of the profile.	`any`	`undefined`	false	false	true
`presence`	A string containing encoded data about a user’s current online state.	`string`	`""`	false	false	true

Examples¶

Members¶

alias¶

Type: string

Default Value: ""

Required: true

The non-unique alternate name of the user.

avatar¶

Type: string

Default Value: ""

Required: true

The URL, asset uid or other global identifier that references the user’s avatar.

data¶

Type: any

Default Value: undefined

Required: true

An arbitrary map of key-value pairs containing the metadata of the profile.

presence¶

Type: string

Default Value: ""

Required: true

A string containing encoded data about a user’s current online state.