Class ChatService

Service for chats and messages

Index

Constructors

Methods

blockChat deleteMessage getChat listChats listGroups listMessages markSeen sendMessage updateMessage

Constructors

constructor

new ChatService(httpClient: IHttpClient, defaultAthleteId: string): ChatService
Parameters
- httpClient: IHttpClient
- defaultAthleteId: string
Returns ChatService
- Defined in services/chat.service.ts:8

Methods

blockChat

blockChat(chatId: number, on: boolean): Promise<Chat>
Block (on = true) or unblock the other athlete in a private chat
Parameters
- chatId: number
- on: boolean
Returns Promise<Chat>
- Defined in services/chat.service.ts:48

deleteMessage

deleteMessage(
chatId: number,
messageId: number,
): Promise<Record<string, unknown>>
Delete a message. The API returns an untyped object.
Parameters
- chatId: number
- messageId: number
Returns Promise<Record<string, unknown>>
- Defined in services/chat.service.ts:58

getChat

getChat(chatId: number): Promise<Chat>
One chat by id
Parameters
- chatId: number
Returns Promise<Chat>
- Defined in services/chat.service.ts:37

listChats

listChats(athleteId?: string): Promise<Chat[]>
List chats (including groups) for the athlete, most recently active first
Parameters
- OptionalathleteId: string
Returns Promise<Chat[]>
- Defined in services/chat.service.ts:14

listGroups

listGroups(athleteId?: string): Promise<Chat[]>
Group chats for the athlete, in name order
Parameters
- OptionalathleteId: string
Returns Promise<Chat[]>
- Defined in services/chat.service.ts:42

listMessages

listMessages(
chatId: number,
options?: { limit?: number; sinceId?: number },
): Promise<Message[]>
List messages in a chat
Parameters
- chatId: number
- Optionaloptions: { limit?: number; sinceId?: number }
Returns Promise<Message[]>
- Defined in services/chat.service.ts:20

markSeen

markSeen(chatId: number, messageId: number): Promise<void>
Mark a message as seen (update last seen message ID)
Parameters
- chatId: number
- messageId: number
Returns Promise<void>
- Defined in services/chat.service.ts:30

sendMessage

sendMessage(data: NewMessage): Promise<SendResponse>
Send a message
Parameters
- data: NewMessage
Returns Promise<SendResponse>
- Defined in services/chat.service.ts:25

updateMessage

updateMessage(
    chatId: number,
    messageId: number,
    message: UpdateMessageDTO,
): Promise<Record<string, unknown>>
Edit a message's content or answer (the only fields the API updates). Returns an untyped object.
Parameters
- chatId: number
- messageId: number
- message: UpdateMessageDTO
Returns Promise<Record<string, unknown>>
- Defined in services/chat.service.ts:53