Class ChatDataService

Index

Constructors

Databases

Methods

addReadFlagToMessage addReadFlagToPaginatedMessageResult addReadFlagToPaginatedTopicResult addUnreadCountToTopic createMessage createMessageTemplate createPrivateChatTopic createSubscription createTopic deleteOneMessage deleteOneMessageTemplate deleteOneSubscription deleteOneTopic expandAttachment expandMessagesForTopicsResponse expandOrganizations expandOwnersForTopicsResponse expandSubscribedUsersForTopicsResponse expandUser expandUsers findPrivateTopic getLastTopicMessage getMessageTemplate getMessageTemplateById getMessageTopicPipeline getMessageTopicSubscriptionPipeline getOneMessage getOneMessageAndNormalize getOneSubscription getOneSubscriptionAndNormalize getOneTopic getOneTopicAndNormalize getOrCreatePrivateChatTopic getPaginatedMessageTemplates getPaginatedMessages getPaginatedOrganizationSubscribedTopics getPaginatedPublicMessages getPaginatedSubscriptions getPaginatedTopicMessages getPaginatedTopicSubscriptions getPaginatedTopics getPaginatedTopicsByOwner getPaginatedUserMessages getPaginatedUserSubscribedTopics getSubscriptions getTopicSubscriptionPipeline markMessageRead normalizeMessageList normalizeMessageTemplate normalizeOneMessage normalizeOneSubscription normalizeOneTopic normalizeSubscriptionList normalizeTopicList resetTopicLastMessage setLogger updateMessageTemplate updateOneMessage updateOneTopic

Properties

COLLECTION_MESSAGE COLLECTION_MESSAGE_TEMPLATE COLLECTION_SUBSCRIPTION COLLECTION_TOPIC COLLECTION_USER_TOPIC_CURSOR attachmentService db expandOrganizationAPI expandUserAPI logger? messageRepository messageTemplateRepository subscriptionRepository topicRepository userTopicCursorRepository

Constructors

constructor

new ChatDataService(db, attachmentService, expandOrganizationAPI, expandUserAPI): ChatDataService
Parameters
- db: Db
- attachmentService: AttachmentService
- expandOrganizationAPI: Pick<OrganizationDefaultAdapterAPI, "getOrganizations">
- expandUserAPI: Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">
Returns ChatDataService
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:68

Databases

getTopicMessageCountSinceId

getTopicMessageCountSinceId(topicId, sinceMessageId?): Promise<number>
Get count of messages that have occurred since an id. (This assumes ids are generated in order). This is normally used to get an unread message count.
Parameters
- topicId: string
  id of topic to get message count for
- Optional sinceMessageId: null | string
  id of message to get count since. If null, will get total message count.
Returns Promise<number>
number of messages that have occurred since the given id
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1580

Methods

addReadFlagToMessage

addReadFlagToMessage<T>(message, topicCursorMap?): EnhancedOmit<T, "_id"> & {
readStatus: string;
} | EnhancedOmit<T, "_id"> & {
readStatus: string;
}
Adds readStatus to a single message model
Type Parameters
- T extends defaultChat.MessageEntity<T>
Parameters
- message: WithId<T>
- Optional topicCursorMap: null | Record<string, UserTopicCursorEntity>
Returns EnhancedOmit<T, "_id"> & {
readStatus: string;
} | EnhancedOmit<T, "_id"> & {
readStatus: string;
}
MessageModel
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1234

addReadFlagToPaginatedMessageResult

addReadFlagToPaginatedMessageResult<T>(messageResult, topicCursorMap?): PaginatedFindResult<T>
Adds readStatus to messages in paginated message result
Type Parameters
- T extends defaultChat.MessageEntity<T>
Parameters
- messageResult: PaginatedFindResult<T>
- Optional topicCursorMap: Record<string, UserTopicCursorEntity>
Returns PaginatedFindResult<T>
paginated MessageModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1216

addReadFlagToPaginatedTopicResult

addReadFlagToPaginatedTopicResult<T>(topicResult, topicCursorMap?): Promise<PaginatedFindResult<T>>
Adds unreadCount to topics in paginated topic result
Type Parameters
- T extends defaultChat.TopicEntity<T>
Parameters
- topicResult: PaginatedFindResult<T>
- Optional topicCursorMap: Record<string, UserTopicCursorEntity>
Returns Promise<PaginatedFindResult<T>>
paginated TopicModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1264

addUnreadCountToTopic

addUnreadCountToTopic<T>(topic, topicCursorMap?): Promise<EnhancedOmit<T, "_id"> & {
unreadCount: number;
}>
Adds unreadCount to a single topic model
Type Parameters
- T extends defaultChat.TopicEntity<T>
Parameters
- topic: WithId<T>
- Optional topicCursorMap: null | Record<string, UserTopicCursorEntity>
Returns Promise<EnhancedOmit<T, "_id"> & {
unreadCount: number;
}>
TopicModel
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1284

createMessage

createMessage(messageInfo): Promise<{
id: string;
}>
Create a message into database
Parameters
- messageInfo: defaultChat.CreateMessageDto
Returns Promise<{
id: string;
}>
id of created Message
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:590

createMessageTemplate

createMessageTemplate(payload): Promise<{
id: string;
}>
Create message template
Parameters
- payload: defaultChat.CreateMessageTemplateDto
Returns Promise<{
id: string;
}>
message template id
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1483

createPrivateChatTopic

createPrivateChatTopic(userId, anotherUserId): Promise<{
id: string;
}>
Create a private chat topic and return the id
Parameters
- userId: string
  one of the user in the chat
- anotherUserId: string
  one of the user in the chat
Returns Promise<{
id: string;
}>
object with id, indicate the private topic Id
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:512

createSubscription

createSubscription(subscription): Promise<{
id: string;
}>
Create a subscription into database
Parameters
- subscription: defaultChat.CreateSubscriptionDto
Returns Promise<{
id: string;
}>
id of created subscription
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:414

createTopic

createTopic(topicInfo): Promise<{
id: string;
}>
Create a topic into database
Parameters
- topicInfo: defaultChat.CreateTopicDto & {
  id?: string;
  }
Returns Promise<{
id: string;
}>
id of created Topic
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:114

deleteOneMessage

deleteOneMessage(messageId): Promise<boolean>
Delete message by Id
Parameters
- messageId: string
Returns Promise<boolean>
boolean indicate deletion success or not
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:869

deleteOneMessageTemplate

deleteOneMessageTemplate(id): Promise<boolean>
Delete message template
Parameters
- id: string
Returns Promise<boolean>
true if success
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1509

deleteOneSubscription

deleteOneSubscription(subscriptionId): Promise<boolean>
Delete subscription by Id
Parameters
- subscriptionId: string
Returns Promise<boolean>
boolean indicate deletion success or not
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:502

deleteOneTopic

deleteOneTopic(topicId): Promise<boolean>
Delete topic by Id
Parameters
- topicId: string
Returns Promise<boolean>
boolean indicate deletion success or not
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:392

expandAttachment

expandAttachment(content): Promise<{
content: string;
}>
Expand attachment
Parameters
- content: string
Returns Promise<{
content: string;
}>
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:685

expandMessagesForTopicsResponse

expandMessagesForTopicsResponse(topicsResponse, appendReadStatus?): Promise<defaultChat.TopicResponse[]>
Expands messages fields inside of an array of topics
Parameters
- topicsResponse: defaultChat.TopicResponse[]
- Optional appendReadStatus: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending read status to messages
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<defaultChat.TopicResponse[]>
topicsResponse with messages expanded
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:251

expandOrganizations

expandOrganizations(orgIds): Promise<Organization[]>
Expand the organizations by orgIds, return org detail if found, otherwise return orgIds
Parameters
- orgIds: string[]
Returns Promise<Organization[]>
users detail
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1677

expandOwnersForTopicsResponse

expandOwnersForTopicsResponse(topicsResponse, expandUser, expandOrganization): Promise<defaultChat.TopicResponse[]>
Expands owner fields inside of an array of topics
Parameters
- topicsResponse: defaultChat.TopicResponse[]
- expandUser: boolean
- expandOrganization: boolean
Returns Promise<defaultChat.TopicResponse[]>
topicsResponse with users expanded
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:337

expandSubscribedUsersForTopicsResponse

expandSubscribedUsersForTopicsResponse(topicsResponse): Promise<defaultChat.TopicResponse[]>
Expands subscriptions and subscriptions.users fields inside of an array of topics
Parameters
- topicsResponse: defaultChat.TopicResponse[]
Returns Promise<defaultChat.TopicResponse[]>
topicsResponse with subscriptions expanded
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:283

expandUser

expandUser(userId): Promise<undefined | UserResponse>
Expand the user by userId, return user detail if found, otherwise return userId
Parameters
- userId: string
Returns Promise<undefined | UserResponse>
user detail
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1640

expandUsers

expandUsers(userIds): Promise<UserResponse[]>
Expand the user by userIds, return users detail if found, otherwise return userIds
Parameters
- userIds: string[]
Returns Promise<UserResponse[]>
users detail
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1654

findPrivateTopic

findPrivateTopic(senderId, receiptId): Promise<null | defaultChat.TopicEntity>
Find a matching private topic for the given senderId and receiptId
Parameters
- senderId: string
- receiptId: string
Returns Promise<null | defaultChat.TopicEntity>
topic data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:163

getLastTopicMessage

getLastTopicMessage(topicId): Promise<null | defaultChat.MessageEntity>
Get the last message for a topic.
Parameters
- topicId: string
  id of topic to get last message for
Returns Promise<null | defaultChat.MessageEntity>
last message for the given topic
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1603

getMessageTemplate

getMessageTemplate(filter): Promise<undefined | null | defaultChat.MessageTemplateResponse>
Get message template by filter
Parameters
- filter: undefined | Expression
Returns Promise<undefined | null | defaultChat.MessageTemplateResponse>
message template
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1529

getMessageTemplateById

getMessageTemplateById(id): Promise<undefined | null | defaultChat.MessageTemplateEntity>
Get message template by Id
Parameters
- id: string
Returns Promise<undefined | null | defaultChat.MessageTemplateEntity>
message template
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1518

getMessageTopicPipeline

getMessageTopicPipeline(): Document[]
Returns Document[]
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1041

getMessageTopicSubscriptionPipeline

getMessageTopicSubscriptionPipeline(): Document[]
Returns Document[]
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1054

getOneMessage

getOneMessage(messageId, appendReadStatus?): Promise<null | defaultChat.MessageEntity>
Get message data from messageId
Parameters
- messageId: string
  id of topic
- Optional appendReadStatus: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending read status to messages
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<null | defaultChat.MessageEntity>
message data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:625

getOneMessageAndNormalize

getOneMessageAndNormalize(messageId, appendReadStatus?, expand?): Promise<null | defaultChat.MessageResponse>
Get message data and then normalize
Parameters
- messageId: string
  id of topic
- Optional appendReadStatus: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending read status to messages
  - Optional organizationId?: string
  - Optional userId?: string
- Optional expand: Expand
  list of fields to expand on the message (from parsed query)
Returns Promise<null | defaultChat.MessageResponse>
message data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:852

getOneSubscription

getOneSubscription(subscriptionId): Promise<null | defaultChat.SubscriptionEntity>
Get subscription data from subscriptionId
Parameters
- subscriptionId: string
  id of topic
Returns Promise<null | defaultChat.SubscriptionEntity>
subscription data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:426

getOneSubscriptionAndNormalize

getOneSubscriptionAndNormalize(subscriptionId, expand?): Promise<null | defaultChat.SubscriptionResponse>
Get subscription data and then normalize
Parameters
- subscriptionId: string
  id of topic
- Optional expand: Expand
  list of fields to expand on the subscription (from parsed query)
Returns Promise<null | defaultChat.SubscriptionResponse>
subscription data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:489

getOneTopic

getOneTopic(topicId, appendUnreadCount?): Promise<null | defaultChat.TopicEntity>
Get topic data from topicId
Parameters
- topicId: string
  id of topic
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<null | defaultChat.TopicEntity>
topic data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:125

getOneTopicAndNormalize

getOneTopicAndNormalize(topicId, appendUnreadCount?, expand?): Promise<null | defaultChat.TopicResponse>
Get topic data and then normalize
Parameters
- topicId: string
  id of topic
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
- Optional expand: Expand
  list of fields to expand on the topic (from parsed query)
Returns Promise<null | defaultChat.TopicResponse>
topic data
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:375

getOrCreatePrivateChatTopic

getOrCreatePrivateChatTopic(senderId, receiptId): Promise<{
id: string;
}>
Search database if there is a private chat topic for userId, and receiptId, if yes, return directly if no, create one and return
Parameters
- senderId: string
- receiptId: string
Returns Promise<{
id: string;
}>
object with id, indicate the private topic Id
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:545

getPaginatedMessageTemplates

getPaginatedMessageTemplates(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultChat.MessageTemplateEntity>>
Get pagination message templates
Parameters
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<defaultChat.MessageTemplateEntity>>
paginated MessageTemplateEntity list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1551

getPaginatedMessages

getPaginatedMessages(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultChat.MessageEntity>>
Get paginated messages from by filtering
Parameters
- filter: undefined | Expression
  to filter the message list
- orderParams: OrderParam<string>[]
  to order the message list
- paginationOptions: PaginationOptions
  pagination options
Returns Promise<PaginatedFindResult<defaultChat.MessageEntity>>
message list with pagination information
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:664

getPaginatedOrganizationSubscribedTopics

getPaginatedOrganizationSubscribedTopics(organizationId, filter, orderParams, paginationOptions, appendUnreadCount?): Promise<PaginatedFindResult<TopicSubscriptionEntity>>
Get topics organization is subscribed to with pagination
Parameters
- organizationId: string
  organizationId that want to get the topics with
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<PaginatedFindResult<TopicSubscriptionEntity>>
paginated TopicModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1369

getPaginatedPublicMessages

getPaginatedPublicMessages(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<MessageTopicEntity>>
Get public message with pagination
Parameters
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<MessageTopicEntity>>
paginated MessageModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1017

getPaginatedSubscriptions

getPaginatedSubscriptions(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultChat.SubscriptionEntity>>
Get subscription with pagination
Parameters
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<defaultChat.SubscriptionEntity>>
paginated SubscriptionModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:967

getPaginatedTopicMessages

getPaginatedTopicMessages(topicId, filter, orderParams, paginationOptions, appendReadStatus?): Promise<PaginatedFindResult<defaultChat.MessageEntity>>
Get topic message with pagination
Parameters
- topicId: string
  topicId that want to get the message with
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
- Optional appendReadStatus: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending read status to messages
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<PaginatedFindResult<defaultChat.MessageEntity>>
paginated MessageModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1165

getPaginatedTopicSubscriptions

getPaginatedTopicSubscriptions(topicId, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultChat.SubscriptionEntity>>
Get subscription with pagination belongs to a topic
Parameters
- topicId: string
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<defaultChat.SubscriptionEntity>>
paginated SubscriptionModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:990

getPaginatedTopics

getPaginatedTopics(filter, orderParams, paginationOptions, appendUnreadCount?): Promise<PaginatedFindResult<defaultChat.TopicEntity>>
Get topic list by filter
Parameters
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<PaginatedFindResult<defaultChat.TopicEntity>>
paginated topic list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:911

getPaginatedTopicsByOwner

getPaginatedTopicsByOwner(ownerId, ownerType, filter, orderParams, paginationOptions, appendUnreadCount?): Promise<PaginatedFindResult<TopicSubscriptionEntity>>
Get topics user/org is one of the owner ids of with pagination
Parameters
- ownerId: string
  ownerId that want to get the topic with
- ownerType: string
  user or organization
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<PaginatedFindResult<TopicSubscriptionEntity>>
paginated TopicModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1309

getPaginatedUserMessages

getPaginatedUserMessages(userId, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<MessageTopicSubscriptionEntity>>
Get user message with pagination
Parameters
- userId: string
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<MessageTopicSubscriptionEntity>>
paginated MessageModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1098

getPaginatedUserSubscribedTopics

getPaginatedUserSubscribedTopics(userId, filter, orderParams, paginationOptions, appendUnreadCount?): Promise<PaginatedFindResult<TopicSubscriptionEntity>>
Get topics user is subscribed to with pagination
Parameters
- userId: string
  userId that want to get the topic with
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread count to topics
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<PaginatedFindResult<TopicSubscriptionEntity>>
paginated TopicModel list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1428

getSubscriptions

getSubscriptions(filter): Promise<defaultChat.SubscriptionEntity[]>
Get subscription list by filter
Parameters
- filter: Filter<defaultChat.SubscriptionEntity>
Returns Promise<defaultChat.SubscriptionEntity[]>
subscription list
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:897

getTopicSubscriptionPipeline

getTopicSubscriptionPipeline(): Document[]
Returns Document[]
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1078

markMessageRead

markMessageRead(__namedParameters): Promise<void>
Mark a single message as being read by a user/organization
Parameters
- __namedParameters: {
      messageId: string;
      organizationId?: string;
      userId?: string;
  }
  - messageId: string
  - Optional organizationId?: string
  - Optional userId?: string
Returns Promise<void>
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:802

normalizeMessageList

normalizeMessageList(messages, expand?): Promise<defaultChat.MessageResponse[]>
Normalize message List
Parameters
- messages: defaultChat.MessageEntity[]
- Optional expand: Expand
  list of fields to expand on the message (from parsed query)
Returns Promise<defaultChat.MessageResponse[]>
normalized message or undefined
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:749

normalizeMessageTemplate

normalizeMessageTemplate(messageTemplate): undefined | defaultChat.MessageTemplateResponse
Parameters
- messageTemplate: undefined | defaultChat.MessageTemplateEntity
Returns undefined | defaultChat.MessageTemplateResponse
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1536

normalizeOneMessage

normalizeOneMessage(message, expand?): Promise<null | defaultChat.MessageResponse>
Normalize message
Parameters
- message: null | defaultChat.MessageEntity
- Optional expand: Expand
  list of fields to expand on the message (from parsed query)
Returns Promise<null | defaultChat.MessageResponse>
normalized message or undefined
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:708

normalizeOneSubscription

normalizeOneSubscription(subscription, expand?): Promise<null | defaultChat.SubscriptionResponse>
Normalize subscription
Parameters
- subscription: null | defaultChat.SubscriptionEntity
- Optional expand: Expand
  list of fields to expand on the subscription (from parsed query)
Returns Promise<null | defaultChat.SubscriptionResponse>
normalized subscription or undefined
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:438

normalizeOneTopic

normalizeOneTopic(topic, appendUnreadCount?, expand?): Promise<null | defaultChat.TopicResponse>
Normalize topic
Parameters
- topic: null | defaultChat.TopicEntity
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread counts to topics
  - Optional organizationId?: string
  - Optional userId?: string
- Optional expand: Expand
  list of fields to expand on the message (from parsed query)
Returns Promise<null | defaultChat.TopicResponse>
normalized topic or null
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:183

normalizeSubscriptionList

normalizeSubscriptionList(subscriptions, expand?): Promise<defaultChat.SubscriptionResponse[]>
Normalize subscription
Parameters
- subscriptions: defaultChat.SubscriptionEntity[]
- Optional expand: Expand
  list of fields to expand on the subscription (from parsed query)
Returns Promise<defaultChat.SubscriptionResponse[]>
normalized subscription or undefined
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:460

normalizeTopicList

normalizeTopicList(topics, appendUnreadCount?, expand?): Promise<defaultChat.TopicResponse[]>
Normalize topics
Parameters
- topics: defaultChat.TopicEntity[]
- Optional appendUnreadCount: {
  organizationId?: string;
  userId?: string;
  }
  optional userId or organization used for appending unread counts to topics
  - Optional organizationId?: string
  - Optional userId?: string
- Optional expand: Expand
  list of fields to expand on the message (from parsed query)
Returns Promise<defaultChat.TopicResponse[]>
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:210

resetTopicLastMessage

resetTopicLastMessage(topicId): Promise<{
id: string;
}>
Reset the last message of a topic to the latest message in the topic
Parameters
- topicId: string
  id of topic to reset last message for
Returns Promise<{
id: string;
}>
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1626

setLogger

setLogger(logger): ChatDataService
Parameters
- logger: Logger
Returns ChatDataService
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:104

updateMessageTemplate

updateMessageTemplate(id, payload): Promise<{
id: string;
}>
Update message template
Parameters
- id: string
- payload: defaultChat.UpdateMessageTemplateDto
Returns Promise<{
id: string;
}>
message template id
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:1497

updateOneMessage

updateOneMessage(messageId, payload): Promise<{
id: string;
}>
Update message by Id
Parameters
- messageId: string
  id of message want to update
- payload: defaultChat.UpdateMessageDto
  content to overwrite
Returns Promise<{
id: string;
}>
id of updated message
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:885

updateOneTopic

updateOneTopic(topicId, payload): Promise<{
id: string;
}>
Update topic by Id
Parameters
- topicId: string
  id of topic want to update
- payload: defaultChat.UpdateTopicDto
  content to overwrite
Returns Promise<{
id: string;
}>
id of updated topic
- Defined in src/adapter/default_chat/dataServices/chat.dataService.ts:402

Properties

`Private` COLLECTION_MESSAGE

COLLECTION_MESSAGE: string = 'chat_messages'

`Private` COLLECTION_MESSAGE_TEMPLATE

COLLECTION_MESSAGE_TEMPLATE: string = 'message_templates'

`Private` COLLECTION_SUBSCRIPTION

COLLECTION_SUBSCRIPTION: string = 'chat_subscriptions'

`Private` COLLECTION_TOPIC

COLLECTION_TOPIC: string = 'chat_topics'

`Private` COLLECTION_USER_TOPIC_CURSOR

COLLECTION_USER_TOPIC_CURSOR: string = 'chat_user_topic_cursors'

`Private` attachmentService

attachmentService: AttachmentService

`Private` db

db: Db

`Private` expandOrganizationAPI

expandOrganizationAPI: Pick<OrganizationDefaultAdapterAPI, "getOrganizations">

`Private` expandUserAPI

expandUserAPI: Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">

`Private` `Optional` logger

logger?: Logger

`Private` messageRepository

messageRepository: MongoRepository<defaultChat.MessageEntity>

`Private` messageTemplateRepository

messageTemplateRepository: MongoRepository<defaultChat.MessageTemplateEntity>

`Private` subscriptionRepository

subscriptionRepository: MongoRepository<defaultChat.SubscriptionEntity>

`Private` topicRepository

topicRepository: MongoRepository<defaultChat.TopicEntity>

`Private` userTopicCursorRepository

userTopicCursorRepository: MongoRepository<UserTopicCursorEntity>

Class ChatDataService

Index

Constructors

Databases

Methods

Properties

Constructors

constructor

Parameters

db: Db

attachmentService: AttachmentService

expandOrganizationAPI: Pick<OrganizationDefaultAdapterAPI, "getOrganizations">

expandUserAPI: Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">

Returns ChatDataService

Databases

getTopicMessageCountSinceId

Parameters

topicId: string

Optional sinceMessageId: null | string

Returns Promise<number>

Methods

addReadFlagToMessage

Type Parameters

T extends defaultChat.MessageEntity<T>

Parameters

message: WithId<T>

Optional topicCursorMap: null | Record<string, UserTopicCursorEntity>

Returns EnhancedOmit<T, "_id"> & { readStatus: string; } | EnhancedOmit<T, "_id"> & { readStatus: string; }

addReadFlagToPaginatedMessageResult

Type Parameters

T extends defaultChat.MessageEntity<T>

Parameters

messageResult: PaginatedFindResult<T>

Optional topicCursorMap: Record<string, UserTopicCursorEntity>

Returns PaginatedFindResult<T>

addReadFlagToPaginatedTopicResult

Type Parameters

T extends defaultChat.TopicEntity<T>

Parameters

topicResult: PaginatedFindResult<T>

Optional topicCursorMap: Record<string, UserTopicCursorEntity>

Returns Promise<PaginatedFindResult<T>>

addUnreadCountToTopic

Type Parameters

T extends defaultChat.TopicEntity<T>

Parameters

topic: WithId<T>

Optional topicCursorMap: null | Record<string, UserTopicCursorEntity>

Returns Promise<EnhancedOmit<T, "_id"> & { unreadCount: number; }>

createMessage

Parameters

messageInfo: defaultChat.CreateMessageDto

Returns Promise<{ id: string; }>

createMessageTemplate

Parameters

payload: defaultChat.CreateMessageTemplateDto

Returns Promise<{ id: string; }>

createPrivateChatTopic

Parameters

userId: string

anotherUserId: string

Returns Promise<{ id: string; }>

createSubscription

Parameters

subscription: defaultChat.CreateSubscriptionDto

Returns Promise<{ id: string; }>

createTopic

Parameters

topicInfo: defaultChat.CreateTopicDto & { id?: string; }

Returns Promise<{ id: string; }>

deleteOneMessage

Parameters

messageId: string

Returns Promise<boolean>

deleteOneMessageTemplate

Parameters

id: string

Returns Promise<boolean>

deleteOneSubscription

Parameters

`Optional` sinceMessageId: null | string

`Optional` topicCursorMap: null | Record<string, UserTopicCursorEntity>

Returns EnhancedOmit<T, "_id"> & {
readStatus: string;
} | EnhancedOmit<T, "_id"> & {
readStatus: string;
}

`Optional` topicCursorMap: Record<string, UserTopicCursorEntity>

`Optional` topicCursorMap: Record<string, UserTopicCursorEntity>

`Optional` topicCursorMap: null | Record<string, UserTopicCursorEntity>

Returns Promise<EnhancedOmit<T, "_id"> & {
unreadCount: number;
}>

Returns Promise<{
id: string;
}>

Returns Promise<{
id: string;
}>

Returns Promise<{
id: string;
}>

Returns Promise<{
id: string;
}>

topicInfo: defaultChat.CreateTopicDto & {
id?: string;
}

Returns Promise<{
id: string;
}>

Returns Promise<{
content: string;
}>

`Optional` appendReadStatus: {
organizationId?: string;
userId?: string;
}

`Optional` organizationId?: string

`Optional` userId?: string

`Optional` appendReadStatus: {
organizationId?: string;
userId?: string;
}

`Optional` organizationId?: string

`Optional` userId?: string