Class SpectrumUser

class: SpectrumUser

Hierarchy

SpectrumUser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SpectrumUser(user: User): SpectrumUser

- Defined in Spectrum/components/user.component.ts:20
Parameters
- user: User
  
  the user info as returned by RSI
Returns SpectrumUser

Properties

Private _messageListener

_messageListener: number

Private _pmListener

_pmListener: number

Protected _user

_user: User

Private broadcaster

broadcaster: Broadcaster = Broadcaster.getInstance()

Protected privateLobby

privateLobby: SpectrumLobby

Private rsi

rsi: RSI = RSI.getInstance()

Methods

closeOnMessage

closeOnMessage(): void

- Defined in Spectrum/components/user.component.ts:91
Stop sending messages to the callback for All messages.

Returns void

closeOnPrivateMessage

closeOnPrivateMessage(): void

- Defined in Spectrum/components/user.component.ts:98
Stop sending messages to the callback for private messages.

Returns void

getPrivateLobbyWithUser

getPrivateLobbyWithUser(): Promise<SpectrumLobby>

- Defined in Spectrum/components/user.component.ts:41
Creates a private lobby for private messaging with the given user

Returns Promise<SpectrumLobby>

The private lobby

getUser

getUser(): User

- Defined in Spectrum/components/user.component.ts:33
Public getter for user

Returns User

the raw user info

mention

mention(): string

- Defined in Spectrum/components/user.component.ts:108
Generate a mention for this user to be used for sending a message to a lobby/forum

see

TextMessage.sendPlainTextMessage()

throws

error on nickname or id not exist

Returns string

a mention rich-text to be parsed by sendPlainTextMessage

onMessage

onMessage(callback?: (Anonymous function)): void

- Defined in Spectrum/components/user.component.ts:79
Declare a custom callback on any message from this user

todo

have more than one callback

Parameters
- Default value callback: (Anonymous function) = (message:receivedTextMessage)=>{}
Returns void

onPrivateMessage

onPrivateMessage(callback?: (Anonymous function)): void

- Defined in Spectrum/components/user.component.ts:69
Declare a custom callback on private message from this user

todo

have more than one callback

Parameters
- Default value callback: (Anonymous function) = (message:receivedTextMessage)=>{}
Returns void

sendPrivateMessage

sendPrivateMessage(text: string): Promise<SpectrumTextMessage>

- Defined in Spectrum/components/user.component.ts:55
Sends plain text message to this user

Parameters
- text: string
Returns Promise<SpectrumTextMessage>

Generated using TypeDoc