UserLink¶
The UserLink is a representation of a relationship from one user to another. Relatiopships have four potential states; block, encounter, follow, or friend. The block state describes a relationship to a user that the individual wishes not to encounter. The encounter state describes a person whom the user recently interacted with. The follow state describes a person whom the user wishes to encounter again in the future. The friend state 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.
The following is the list of all members included in the data schema.
Member |
Description |
Type |
Format/Schema |
Default Value |
Identifier |
Unique |
Required |
---|---|---|---|---|---|---|---|
|
The unique identifier of the user that owns the link. |
|
|
false |
false |
true |
|
|
The unique identifier of the other user the the link is for. |
|
|
false |
false |
true |
|
|
The current state of the link. |
|
|
false |
false |
true |
Examples¶
Members¶
userUid¶
Type: string
Default Value: ""
Required: true
The unique identifier of the user that owns the link.
otherUid¶
Type: string
Default Value: ""
Required: true
The unique identifier of the other user the the link is for.
status¶
Type: string
Default Value: follow
Required: true
The current state of the link.