Class Client

Represents the main chatexchange Client class.

Hierarchy

Client

Index

Constructors

constructor

Properties

host

Accessors

Methods

Constructors

constructor

new Client(host: Host): Client

- Defined in src/Client.ts:47
Creates an instance of Client.

throws
{InvalidArgumentError} If the host is invalid

Parameters
- host: Host
  
  The host to connect to (stackexchange.com, meta.stackexchange.com, or stackoverflow.com)
Returns Client

Properties

Readonly host

host: Host

Accessors

browser

set browser(browser: Browser): void

- Defined in src/Client.ts:61
summary
swaps out the internal Browser instance

Parameters
- browser: Browser
  
  instance of Browser to swap with
Returns void

fkey

get fkey(): Promise<string>

- Defined in src/Client.ts:80
summary
gets user chat fkey

memberof
Client#

Returns Promise<string>

loggedIn

get loggedIn(): boolean

- Defined in src/Client.ts:87
summary
gets user login status

Returns boolean

root

get root(): string

- Defined in src/Client.ts:70
summary
Returns the chat host URL

memberof
Client#

Returns string

Methods

broadcast

broadcast(message: string): Promise<Map<number, boolean>>

- Defined in src/Client.ts:291
Broadcasts a message to all joined rooms

Parameters
- message: string
  
  message to broadcast
Returns Promise<Map<number, boolean>>

createRoom

createRoom(config: Omit<IRoomSave, "host">): Promise<Room>

- Defined in src/Client.ts:133
summary
attempts to update a Room

Parameters
- config: Omit<IRoomSave, "host">
  
  Room configuration options
Returns Promise<Room>

delete

delete(message: number | Message): Promise<DeleteMessageStatus>

- Defined in src/Client.ts:327
summary
deletes a given message

Parameters
- message: number | Message
  
  Message or ID to delete
Returns Promise<DeleteMessageStatus>

getMe

getMe(): Promise<User>

- Defined in src/Client.ts:98
Fetches the current logged-in user's profile

throws
{ChatExchangeError} If no user is currently logged in

memberof
Client#

Returns Promise<User>
The user object

getMessage

getMessage(id: number): Message

- Defined in src/Client.ts:106
Parameters
- id: number
Returns Message

getProfile

getProfile(user: number | User): Promise<IProfileData>

- Defined in src/Client.ts:124
summary
gets the chat profile of a given User

Parameters
- user: number | User
  
  user or user ID to get the chat profile of
Returns Promise<IProfileData>

getRoom

getRoom(room: number | Room): Room

- Defined in src/Client.ts:160
summary
gets a Room instance from the client

Parameters
- room: number | Room
  
  Room or Room.id to get
Returns Room

getRooms

getRooms(): Map<number, Room>

- Defined in src/Client.ts:112
Returns Map<number, Room>

getRoomsAsArray

getRoomsAsArray(): Room[]

- Defined in src/Client.ts:116
Returns Room[]

getTranscript

getTranscript(message: number | Message): Promise<ITranscriptData>

- Defined in src/Client.ts:180
summary
gets a given chat message transcript info

Parameters
- message: number | Message
  
  message or message ID to get the transcript for
Returns Promise<ITranscriptData>

getUser

getUser(id: number, existingData?: Omit<Partial<IProfileData>, "id">): User

- Defined in src/Client.ts:185
Parameters
- id: number
- Optional existingData: Omit<Partial<IProfileData>, "id">
Returns User

joinRoom

joinRoom(room: number | Room): Promise<boolean>

- Defined in src/Client.ts:262
summary
Joins a given room

memberof
Client#

Parameters
- room: number | Room
  
  The room or ID to join
Returns Promise<boolean>

leaveAll

leaveAll(): Promise<boolean>

- Defined in src/Client.ts:283
summary
Leaves all rooms (on same chat server)

memberof
Client#

Returns Promise<boolean>

leaveRoom

leaveRoom(room: number | Room): Promise<boolean>

- Defined in src/Client.ts:271
summary
Leaves a given room

Parameters
- room: number | Room
  
  The Room or ID to leave
Returns Promise<boolean>

listUsers

listUsers(room: number | Room): Promise<User[]>

- Defined in src/Client.ts:205
summary
lists users in a given {@link room}

Parameters
- room: number | Room
  
  room or room ID to list current users from
Returns Promise<User[]>

login

login(email: string, password: string): Promise<string>

- Defined in src/Client.ts:218
Attempts to login to the stackexchange network with the provided username and password

memberof
Client#

Parameters
- email: string
  
  Email
- password: string
  
  Password
Returns Promise<string>
Request Cookie Jar (Optionally to save to loginCookie)

loginCookie

loginCookie(cookieString: string): Promise<void>

- Defined in src/Client.ts:248
Attempts to login to stack exchange, using the provided cookie jar string, which was retrieved from the login method.

memberof
Client#

Parameters
- cookieString: string
  
  A cookie jar string
Returns Promise<void>
A promise representing when login is complete

logout

logout(): Promise<boolean>

- Defined in src/Client.ts:233
summary
attempts to logout from the Stack Exchange network

memberof
Client#

Returns Promise<boolean>
status of the logout

send

send(message: string, room: number | Room): Promise<[boolean, Message]>

- Defined in src/Client.ts:342
summary
sends a message to a given room

Parameters
- message: string
  
  message to send
- room: number | Room
  
  room or room ID to send to
Returns Promise<[boolean, Message]>

updateRoom

updateRoom(room: number | Room, config: Omit<IRoomSave, "host">): Promise<Room>

- Defined in src/Client.ts:145
summary
attempts to update a Room

Parameters
- room: number | Room
  
  Room or Room.id to update
- config: Omit<IRoomSave, "host">
  
  Room configuration options
Returns Promise<Room>

watch

watch(room: number | Room): Promise<WebSocket>

- Defined in src/Client.ts:355
summary
watches a given Room for new events

Parameters
- room: number | Room
  
  room or room ID to watch
Returns Promise<WebSocket>

Generated using TypeDoc