Class RemoteReference

Entity representing another entity on a remote instance.

Hierarchy

Base
- RemoteReference

Index

Constructors

constructor

Properties

_id
host

Accessors

Methods

toJSON

Constructors

constructor

new RemoteReference(): RemoteReference

Inherited from Base.constructor

Returns RemoteReference

Properties

_id

_id: string

The ID of the entity.

host

host: string

The host that the entity belongs to.

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/remote-reference.ts:49
Returns a JSON representation of the entity in the format expected by the federation protocol.

Returns JSONMap

Generated using TypeDoc