Class Member

API Member model.

Hierarchy

default<APIMember>
- Member

Index

Constructors

Properties

channel client id joinedAt permissions user

Methods

_clone _patch _update fetch toJson

Constructors

constructor

new Member(client: Client, data: APIMember): Member
Parameters
- client: Client
- data: APIMember
Returns Member
Overrides Data<APIMember>.constructor
- Defined in packages/foxochat.js/src/models/Member.ts:31

Properties

channel

channel: Channel

The channel of the member.

`Readonly`client

client: Client

The client that instantiated this Model.

`Readonly`id

id: number

The id of the model.

joinedAt

joinedAt: Date

The time when member joined.

permissions

permissions: MemberPermissions

The permissions of the member.

user

user: User

The user of the member.

Methods

_clone

_clone(): Member
Returns Member
Inherited from Data._clone
- Defined in packages/foxochat.js/src/models/Base.ts:17

_patch

_patch(data: Partial<APIMember>): void
Parameters
- data: Partial<APIMember>
Returns void
Overrides Data._patch
- Defined in packages/foxochat.js/src/models/Member.ts:37

_update

_update(data: Partial<T>): Member
Parameters
- data: Partial<T>
Returns Member
Inherited from Data._update
- Defined in packages/foxochat.js/src/models/Base.ts:21

fetch

fetch(force?: boolean): Promise<Member>
Fetch this member.
Parameters
- force: boolean = true
Returns Promise<Member>
- Defined in packages/foxochat.js/src/models/Member.ts:48

toJson

toJson(): APIMember
Returns APIMember
Overrides Data.toJson
- Defined in packages/foxochat.js/src/models/Member.ts:52