Class: ChatMessageEndpoint

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:15

Endpoints for interacting with chat messages.

Extends

• ApiEndpoint

Constructors

Constructor

new ChatMessageEndpoint(config, tokenManager, log?, headerProvider?): ChatMessageEndpoint

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:16

Parameters

config

DefaultApiConfig

tokenManager

TokenManager

log?

Logger

headerProvider?

HeaderProvider

Returns

ChatMessageEndpoint

Overrides

ApiEndpoint.constructor

Properties

config

readonly config: DefaultApiConfig

Defined in: api/endpoints/ApiEndpoint.ts:10

Inherited from

ApiEndpoint.config

---

log?

protected readonly optional log: Logger

Defined in: api/endpoints/ApiEndpoint.ts:15

Inherited from

ApiEndpoint.log

---

tokenManager

readonly tokenManager: TokenManager

Defined in: api/endpoints/ApiEndpoint.ts:14

Inherited from

ApiEndpoint.tokenManager

Methods

deleteMessage()

deleteMessage(id): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:82

Delete a chat message

Parameters

id

string

The id of the message to delete

Returns

Promise<ApiResponse<unknown>>

---

deleteRequest()

protected deleteRequest(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/ApiEndpoint.ts:85

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<unknown>>

Inherited from

ApiEndpoint.deleteRequest

---

endpoint()

protected endpoint(): string

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:20

Returns

string

Overrides

ApiEndpoint.endpoint

---

endpointUrl()

protected endpointUrl(): string

Defined in: api/endpoints/ApiEndpoint.ts:23

Returns

string

Inherited from

ApiEndpoint.endpointUrl

---

getMessage()

getMessage(id): Promise<ApiResponse<ChatMessage>>

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:31

Fetch a chat message

Parameters

id

string

The id of the message

Returns

Promise<ApiResponse<ChatMessage>>

The chat message

---

getMessageHistory()

getMessageHistory(emergencyId, limit, paginationToken?): Promise<ApiResponse<PaginatedResponse<ChatMessage>>>

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:42

Gets the specified amount of chat messages for a given emergency.

Parameters

emergencyId

string

The emergency for which to fetch the chat history

limit

number

The number of emergencies to get

paginationToken?

string

The number to use for pagination

Returns

Promise<ApiResponse<PaginatedResponse<ChatMessage>>>

---

getRequest()

protected getRequest<T>(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:53

Type Parameters

T

T = unknown

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.getRequest

---

patchRequest()

protected patchRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:77

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.patchRequest

---

postRequest()

protected postRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:61

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.postRequest

---

putRequest()

protected putRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:69

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.putRequest

---

sendMessage()

sendMessage(message): Promise<ApiResponse<ChatMessage>>

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:60

Sends a new chat message

Parameters

message

ChatMessageRequest

The message to send

Returns

Promise<ApiResponse<ChatMessage>>

The newly-created chat message

---

updateMessage()

updateMessage(id, contents): Promise<ApiResponse<ChatMessage>>

Defined in: api/endpoints/chatMessage/ChatMessageEndpoint.ts:72

Update a chat message

Parameters

id

string

The id of the message to update

contents

string

The new content of the message

Returns

Promise<ApiResponse<ChatMessage>>

The updated chat message