Class User

Represents a user on Guilded.

Example

new User(client, rawUser);

Hierarchy

Base
- User
  - ClientUser

Index

Constructors

constructor

new User(client: Client, raw: APIUser | APIUserSummary, cache?: boolean): User
Parameters
- client: Client
  
  The client the user belongs to.
- raw: APIUser | APIUserSummary
  
  The raw data of the user.
- cache: boolean = ...
  
  Whether to cache the user.
Returns User
Overrides Base.constructor
- Defined in guilded.ts/src/structures/User.ts:26

Properties

`Optional` `Readonly` avatar

avatar?: string

The avatar of the user.

`Optional` `Readonly` banner

banner?: string

The banner of the user.

`Readonly` client

client: Client

The client the data model belongs to.

`Optional` `Readonly` createdAt

createdAt?: Date

The date the user was created.

`Readonly` id

id: string

The ID of the structure.

`Readonly` name

name: string

The name of the user.

`Readonly` raw

raw: APIUser | APIUserSummary

The raw data of the user.

`Optional` `Readonly` type

type?: UserType

The type of the user.

Accessors

createdTimestamp

get createdTimestamp(): undefined | number
The timestamp the user was created.

Returns undefined | number
- Defined in guilded.ts/src/structures/User.ts:46

isBot

get isBot(): boolean
Whether the user is a bot.

Returns boolean
- Defined in guilded.ts/src/structures/User.ts:51

isCached

get isCached(): boolean
Whether the user is cached.

Returns boolean
- Defined in guilded.ts/src/structures/User.ts:41

isUser

get isUser(): boolean
Whether the user is a human.

Returns boolean
- Defined in guilded.ts/src/structures/User.ts:56

Class User

Example

Hierarchy

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

client: Client

raw: APIUser | APIUserSummary

cache: boolean = ...

Returns User

Properties

`Optional` `Readonly` avatar

`Optional` `Readonly` banner

`Readonly` client

`Optional` `Readonly` createdAt

`Readonly` id

`Readonly` name

`Readonly` raw

`Optional` `Readonly` type

Accessors

createdTimestamp

Returns undefined | number

isBot

Returns boolean

isCached

Returns boolean

isUser

Returns boolean

Settings

Member Visibility

Theme

Class User

Example

Hierarchy

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

client: Client

raw: APIUser | APIUserSummary

cache: boolean = ...

Returns User

Properties

Optional Readonly avatar

Optional Readonly banner

Readonly client

Optional Readonly createdAt

Readonly id

Readonly name

Readonly raw

Optional Readonly type

Accessors

createdTimestamp

Returns undefined | number

isBot

Returns boolean

isCached

Returns boolean

isUser

Returns boolean

Settings

Member Visibility

Theme

`Optional` `Readonly` avatar

`Optional` `Readonly` banner

`Readonly` client

`Optional` `Readonly` createdAt

`Readonly` id

`Readonly` name

`Readonly` raw

`Optional` `Readonly` type