Class MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>

Type Parameters

TopicCustomFields = unknown
MessageCustomFields = unknown
SubscriptionCustomFields = unknown

Hierarchy

BaseBackendApi
- MessagingChatAdapterApi

Implements

ChatApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>

Index

Constructors

constructor

new MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>(serviceEndpoint, sessionService): MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>
Type Parameters
- TopicCustomFields = unknown
- MessageCustomFields = unknown
- SubscriptionCustomFields = unknown
Parameters
- serviceEndpoint: string
- sessionService: SessionService
Returns MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>
Inherited from BaseBackendApi.constructor
- Defined in src/api/base.ts:12

Properties

serviceEndpoint

serviceEndpoint: string

sessionService

sessionService: SessionService

Methods

createMessage

createMessage(input): Promise<MessageResponse<MessageCustomFields>>
Perform a POST request to create a message
Parameters
- input: CreateMessageInput<MessageCustomFields>
Returns Promise<MessageResponse<MessageCustomFields>>
Implementation of ChatApi.createMessage
- Defined in src/api/chat.ts:103

createSubscription

createSubscription(input): Promise<SubscriptionResponse<SubscriptionCustomFields>>
Perform a POST request to subscribe somebody to a topic
Parameters
- input: CreateSubscriptionInput<SubscriptionCustomFields>
Returns Promise<SubscriptionResponse<SubscriptionCustomFields>>
Implementation of ChatApi.createSubscription
- Defined in src/api/chat.ts:114

createTopic

createTopic(input): Promise<TopicResponse<TopicCustomFields>>
Perform a POST request to create a topic
Parameters
- input: CreateTopicInput<TopicCustomFields>
Returns Promise<TopicResponse<TopicCustomFields>>
Implementation of ChatApi.createTopic
- Defined in src/api/chat.ts:125

getMessage

getMessage(input): Promise<MessageResponse<MessageCustomFields>>
Perform a GET request to get message
Parameters
- input: GetMessageInput
Returns Promise<MessageResponse<MessageCustomFields>>
Implementation of ChatApi.getMessage
- Defined in src/api/chat.ts:136

`Protected` getPaginatedQueryParams

getPaginatedQueryParams(query): string
Parameters
- query: Partial<PaginatedQuery & SearchableQuery & {
  otherParams: Record<string, undefined | string>;
  }>
Returns string
Inherited from BaseBackendApi.getPaginatedQueryParams
- Defined in src/api/base.ts:30

`Protected` getPaginatedResponse

getPaginatedResponse<T>(backendResponse): PaginatedResponse<T>
Type Parameters
- T
Parameters
- backendResponse: PaginatedBackendResponse<T>
Returns PaginatedResponse<T>
Inherited from BaseBackendApi.getPaginatedResponse
- Defined in src/api/base.ts:86

getRequiredVersion

getRequiredVersion(): string
On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

Returns string
Implementation of ChatApi.getRequiredVersion
Overrides BaseBackendApi.getRequiredVersion
- Defined in src/api/chat.ts:243

`Protected` getServiceUrl

getServiceUrl(path): string
Parameters
- path: string
Returns string
Inherited from BaseBackendApi.getServiceUrl
- Defined in src/api/base.ts:26

getTopic

getTopic(input): Promise<TopicResponse<TopicCustomFields>>
Perform a GET request to get topic
Parameters
- input: GetTopicInput
Returns Promise<TopicResponse<TopicCustomFields>>
Implementation of ChatApi.getTopic
- Defined in src/api/chat.ts:152

listMessagesForTopic

listMessagesForTopic(input): Promise<PaginatedResponse<MessageResponse<MessageCustomFields>>>
Perform a GET request to list messages for a topic.
Parameters
- input: {
      query: PaginatedQuery;
      readStatusForOrg?: string;
      topicId: string;
  }
  - query: PaginatedQuery
  - Optional readStatusForOrg?: string
  - topicId: string
Returns Promise<PaginatedResponse<MessageResponse<MessageCustomFields>>>
Implementation of ChatApi.listMessagesForTopic
- Defined in src/api/chat.ts:170

listTopicsSubscribedByOrganization

listTopicsSubscribedByOrganization(input): Promise<PaginatedResponse<TopicResponse<TopicCustomFields>>>
Perform a GET request to list topics for a organization. Will automatically expand latest message and owners.
Parameters
- input: {
      organizationId: string;
      query: PaginatedQuery;
      readStatusForOrg?: string;
  }
  - organizationId: string
  - query: PaginatedQuery
  - Optional readStatusForOrg?: string
Returns Promise<PaginatedResponse<TopicResponse<TopicCustomFields>>>
Implementation of ChatApi.listTopicsSubscribedByOrganization
- Defined in src/api/chat.ts:192

listTopicsSubscribedByUser

listTopicsSubscribedByUser(input): Promise<PaginatedResponse<TopicResponse<TopicCustomFields>>>
Perform a GET request to list topics for a user. Will automatically expand latest message and owners.
Parameters
- input: {
  query: PaginatedQuery;
  userId: string;
  }
  - query: PaginatedQuery
  - userId: string
Returns Promise<PaginatedResponse<TopicResponse<TopicCustomFields>>>
Implementation of ChatApi.listTopicsSubscribedByUser
- Defined in src/api/chat.ts:215

ping

ping(): Promise<PingResponse>
Ping the backend service to check that it is alive and well

Returns Promise<PingResponse>
Implementation of ChatApi.ping
Inherited from BaseBackendApi.ping
- Defined in src/api/base.ts:17

updateMessageReadStatus

updateMessageReadStatus(input): Promise<void>
Perform a PATCH request to update read statuses for a topic message
Parameters
- input: UpdateMessageReadStatusInput
Returns Promise<void>
Implementation of ChatApi.updateMessageReadStatus
- Defined in src/api/chat.ts:235

Class MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>

Type Parameters

TopicCustomFields = unknown

MessageCustomFields = unknown

SubscriptionCustomFields = unknown

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TopicCustomFields = unknown

MessageCustomFields = unknown

SubscriptionCustomFields = unknown

Parameters

serviceEndpoint: string

sessionService: SessionService

Returns MessagingChatAdapterApi<TopicCustomFields, MessageCustomFields, SubscriptionCustomFields>

Properties

serviceEndpoint

sessionService

Methods

createMessage

Parameters

input: CreateMessageInput<MessageCustomFields>

Returns Promise<MessageResponse<MessageCustomFields>>

createSubscription

Parameters

input: CreateSubscriptionInput<SubscriptionCustomFields>

Returns Promise<SubscriptionResponse<SubscriptionCustomFields>>

createTopic

Parameters

input: CreateTopicInput<TopicCustomFields>

Returns Promise<TopicResponse<TopicCustomFields>>

getMessage

Parameters

input: GetMessageInput

Returns Promise<MessageResponse<MessageCustomFields>>

Protected getPaginatedQueryParams

Parameters

query: Partial<PaginatedQuery & SearchableQuery & { otherParams: Record<string, undefined | string>; }>

Returns string

Protected getPaginatedResponse

Type Parameters

T

Parameters

backendResponse: PaginatedBackendResponse<T>

Returns PaginatedResponse<T>

getRequiredVersion

Returns string

Protected getServiceUrl

Parameters

path: string

Returns string

getTopic

Parameters

input: GetTopicInput

Returns Promise<TopicResponse<TopicCustomFields>>

listMessagesForTopic

Parameters

input: { query: PaginatedQuery; readStatusForOrg?: string; topicId: string; }

query: PaginatedQuery

Optional readStatusForOrg?: string

topicId: string

Returns Promise<PaginatedResponse<MessageResponse<MessageCustomFields>>>

listTopicsSubscribedByOrganization

Parameters

input: { organizationId: string; query: PaginatedQuery; readStatusForOrg?: string; }

organizationId: string

query: PaginatedQuery

Optional readStatusForOrg?: string

Returns Promise<PaginatedResponse<TopicResponse<TopicCustomFields>>>

listTopicsSubscribedByUser

Parameters

input: { query: PaginatedQuery; userId: string; }

query: PaginatedQuery

userId: string

`Protected` getPaginatedQueryParams

query: Partial<PaginatedQuery & SearchableQuery & {
otherParams: Record<string, undefined | string>;
}>

`Protected` getPaginatedResponse

`Protected` getServiceUrl

input: {
query: PaginatedQuery;
readStatusForOrg?: string;
topicId: string;
}

`Optional` readStatusForOrg?: string

input: {
organizationId: string;
query: PaginatedQuery;
readStatusForOrg?: string;
}

`Optional` readStatusForOrg?: string

input: {
query: PaginatedQuery;
userId: string;
}