Profile
Represents a user profile that exists on the system.
Constructors
new Profile()
new Profile(uid): Profile
Creates a new Profile instance from the given profile UID.
Parameters
| Parameter | Type |
|---|---|
uid | ProfileUid |
Returns
Example
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
image | readonly | ArrayBuffer | The raw JPEG data for the profile image. Can be decoded with the Image class. |
nickname | readonly | string | The human readable nickname of the profile. |
uid | readonly | ProfileUid | The unique ID of the profile, represented as an array of two bigint values. |
Accessors
current
get static current(): null | Profile
set static current(v): void
Parameters
| Parameter | Type |
|---|---|
v | null | Profile |
Returns
null | Profile
Methods
[iterator]()
Can be used as an iterator to retrieve the list of user profiles.
Returns
Generator<Profile, void, unknown>
Example
select()
static select(): null | Profile
Shows the user selection interface and returns a Profile instance representing the user that was selected.
Returns
null | Profile
Note
This function blocks the event loop until the user has made their selection.