Class PublicUser

Entity representing the public fields of a user.

Hierarchy

Base
- PublicUser
  - User

Index

Constructors

constructor

Properties

Accessors

Methods

toJSON

Constructors

constructor

new PublicUser(): PublicUser

Inherited from Base.constructor

Returns PublicUser

Properties

_id

_id: string

The ID (primary key) of the entity.

Optional host

host: string

Host that the entity belongs to.

Because this is a federated system, there are many instances where entities are scoped to a specific instance (rather than globally scoped).

profile

profile: UserProfile

The user's profile.

username

username: string

The user's username.

Accessors

created

get created(): number
set created(created: number): void

- Defined in packages/backend-core/src/models/base.ts:71
Access to createdAt as a UNIX timestamp.

Returns number
- Defined in packages/backend-core/src/models/base.ts:75
Access to createdAt as a UNIX timestamp.

Parameters
- created: number
Returns void

id

get id(): string
set id(id: string): void

- Defined in packages/backend-core/src/models/base.ts:60
Alias for the _id property.

Returns string
- Defined in packages/backend-core/src/models/base.ts:64
Alias for the _id property.

Parameters
- id: string
Returns void

modified

get modified(): number
set modified(modified: number): void

- Defined in packages/backend-core/src/models/base.ts:82
Access to updatedAt as a UNIX timestamp.

Returns number
- Defined in packages/backend-core/src/models/base.ts:86
Access to updatedAt as a UNIX timestamp.

Parameters
- modified: number
Returns void

Methods

toJSON

toJSON(): JSONMap

Overrides Base.toJSON
- Defined in packages/backend-core/src/models/public-user.ts:73
Returns a JSON representation of the entity in the format expected by the federation protocol.

Returns JSONMap

Generated using TypeDoc