@acceleratxr/core_sdk / Profile
Class: 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.
REQUIRES: Social Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ Profile
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new Profile(other?: any): Profile
Overrides EntityBase.constructor
Defined in src/models/Profile.ts:34
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Profile
Properties#
alias#
• alias: string = “”
Defined in src/models/Profile.ts:19
The non-unique alternate name of the user.
avatar#
• avatar: string = “”
Defined in src/models/Profile.ts:24
The URL, asset uid or other global identifier that references the user’s avatar.
data#
• data: any = null
Defined in src/models/Profile.ts:29
An arbitrary map of key-value pairs containing the metadata of the profile.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
presence#
• presence: string = “”
Defined in src/models/Profile.ts:34
A string containing encoded data about a user’s current online state.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/Profile.ts:14
Returns: string