Home Manual Reference Source
public class | source

User

User informations

Member Summary

Public Members
public

Indicates if the user is an anonymous user

public

User's last know connection ts

public

User's display name

public

User's status

public

User's unique id

Method Summary

Public Methods
public

invite(message: string): Promise<{room: Room, invite: Invite}, Error>

Invite a user directly.

Public Members

public anonymous: boolean source

Indicates if the user is an anonymous user

public lastSeen: number source

User's last know connection ts

public name: string source

User's display name

public status: string source

User's status

public uid: string source

User's unique id

Public Methods

public invite(message: string): Promise<{room: Room, invite: Invite}, Error> source

Invite a user directly. This will create a new Room, log you in it & invite the user.

Params:

NameTypeAttributeDescription
message string
  • optional

a message to add to the invite

Return:

Promise<{room: Room, invite: Invite}, Error>