Class RemoteUser

Hierarchy

RemoteUser

Index

Constructors

constructor

Properties

data
id

Methods

Constructors

constructor

new RemoteUser(id: string, data?: Record<string, unknown>): RemoteUser

- Defined in src/models/users/remote.ts:16
throws

If identifier is not supplied.

Parameters
- id: string
- data: Record<string, unknown> = {}
  
  The serialized key-value data object to assign to this user.
Returns RemoteUser

Properties

Readonly data

data: Record<string, unknown> = {}

Readonly id

id: string

Methods

get

get<T>(key: string): T

- Defined in src/models/users/remote.ts:50
Get the data value for the given key.

Type parameters
- T
Parameters
- key: string
  
  An arbitrary bridge-specific key.
Returns T

Stored data for this key. May be undefined.

getId

getId(): string

- Defined in src/models/users/remote.ts:33
Get the Remote user ID.

Returns string

The id

serialize

serialize(): Record<string, unknown>

- Defined in src/models/users/remote.ts:41
Serialize all the data about this room, excluding the room ID.

Returns Record<string, unknown>

The serialised data

set

set(key: string, val: unknown): void

- Defined in src/models/users/remote.ts:60
Set an arbitrary bridge-specific data value for this room.

Parameters
- key: string
  
  The key to store the data value under.
- val: unknown
  
  The data value. This value should be serializable via JSON.stringify(data).
Returns void

Generated using TypeDoc