Class UserPreview

Hierarchy

UserPreview

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserPreview(data: any, session: Session): UserPreview

- Defined in user.ts:67
Parameters
- data: any
- session: Session
Returns UserPreview

Properties

displayName

displayName: string

The first and last name of the user

groupDisplayName

groupDisplayName: string

id

id: string

The uuid of the user

profile

profile: profile

The profile of the user (eg. Student, Teacher...)

session

session: Session

Methods

avatarURL

avatarURL(): string

- Defined in user.ts:119
The users avatar url

Returns string

fetchUser

fetchUser(): Promise<User>

- Defined in user.ts:106
Fetches user from preview

Returns Promise<User>

sendMessage

sendMessage(config: IMessageConfig): Promise<number>

- Defined in user.ts:90
Sends a message to this user preview and returns the message id.

Parameters
- config: IMessageConfig
  
  The configuration of the message
Returns Promise<number>

toJSON

toJSON(): IUserPreview

- Defined in user.ts:77
This user preview instance as a JSON object

Returns IUserPreview

Generated using TypeDoc