@acceleratxr/core_sdk / UserLink
Class: UserLink#
The UserLink is a representation of a relationship from one user to another. Relatiopships have three
potential types; BLOCK, ENCOUNTER, FOLLOW, or FRIEND. The BLOCK type describes a relationship to a user that the
individual wishes not to encounter. The ENCOUNTER type describes a person whom the user recently interacted with.
The FOLLOW type describes a person whom the user wishes to encounter again in the future. The FRIEND type describes
a person that both users wish to encounter in the future. A FRIEND link is automatically made when each user
creates a follow link to each other.
REQUIRES: Social Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ UserLink
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new UserLink(other?: any): UserLink
Overrides EntityBase.constructor
Defined in src/models/UserLink.ts:51
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: UserLink
Properties#
alias#
• alias: string = “”
Defined in src/models/UserLink.ts:41
The user defined alias that describes this relationship. (e.g. MyBFF, GuyIHateMost)
data#
• data: any = undefined
Defined in src/models/UserLink.ts:51
An arbitrary field for storing custom metadata.
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.
otherUid#
• otherUid: string = “”
Defined in src/models/UserLink.ts:36
The unique identifier of the other user the the link is for.
type#
• type: UserLinkType = UserLinkType.FOLLOW
Defined in src/models/UserLink.ts:46
The type of the link.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
userUid#
• userUid: string = “”
Defined in src/models/UserLink.ts:31
The unique identifier of the user that owns the link.
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/UserLink.ts:26
Returns: string