Class ChatDefaultAdapter

Implements

Constructors

constructor

HandlerAndValidators

createMessage createMessageTemplate createSubscription createTopic createTopicAttachment deleteMessage deleteMessageTemplate deleteSubscription deleteTopic deleteTopicAttachment getMessage getMessageTemplate getSubscription getTopic getTopicAttachment getTopicAttachmentUploadUrl listMessageTemplates listMessageTemplatesForOrganization listMessages listMessagesForPublic listMessagesForTopic listMessagesForUser listSubscriptions listSubscriptionsForTopic listTopicAttachments listTopics listTopicsOwnedByOrganization listTopicsOwnedByUser listTopicsSubscribedByOrganization listTopicsSubscribedByUser updateMessage updateMessageReadStatus updateMessageTemplate updateTopic

Properties

adapterName authSecrets dataServices dependencies opts

Constructors

constructor

HandlerAndValidators

createMessage

createMessage: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isOwnMessage: undefined | Predicate;
    isUserOrganization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create a message handler and validators

handler: createMessageHandler

validators:

createMessageTemplate

createMessageTemplate: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create a message template handler and validators

handler: createMessageTemplateHandler

validators:

createSubscription

createSubscription: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
    verifySubscriptionNotExist: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create a subscription handler and validators

handler: createSubscriptionHandler

validators:

createTopic

createTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create a topic handler and validators

handler: createTopicHandler

validators:

createTopicAttachment

createTopicAttachment: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create a topic attachment handler and validators

handler: createAttachmentHandler

validators:

deleteMessage

deleteMessage: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    messageExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete a message handler and validators

handler: deleteMessageHandler

validators:

deleteMessageTemplate

deleteMessageTemplate: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    checkMessageTemplatePermission: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete a message template handler and validators

handler: deleteMessageTemplate

validators:

deleteSubscription

deleteSubscription: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    subscriptionExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete a subscription handler and validators

handler: deleteSubscriptionHandler

validators:

deleteTopic

deleteTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete a topic handler and validators

handler: deleteTopicHandler

validators:

deleteTopicAttachment

deleteTopicAttachment: HandlerAndValidators<{
    attachmentBelongsToTopic: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete a topic attachment handler and validators

handler: deleteAttachmentHandler

validators:

getMessage

getMessage: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    userCanSeeReadStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get a message handler and validators

handler: getMessageHandler

validators:

getMessageTemplate

getMessageTemplate: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    checkMessageTemplatePermission: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get a message template handler and validators

handler: getMessageTemplateHandler

validators:

getSubscription

getSubscription: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get a subscription handler and validators

handler: getSubscriptionHandler

validators:

getTopic

getTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    userCanSeeReadStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get a topic handler and validators

handler: getTopicHandler

validators:

getTopicAttachment

getTopicAttachment: HandlerAndValidators<{
    attachmentBelongsToTopic: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get one topic attachment handler and validators

handler: getAttachmentHandler

validators:

getTopicAttachmentUploadUrl

getTopicAttachmentUploadUrl: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachment upload url handler and validators

handler: getAttachmentUploadUrlHandler

validators:

listMessageTemplates

listMessageTemplates: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get message templates handler and validators

handler: listMessageTemplatesHandler

validators:

listMessageTemplatesForOrganization

listMessageTemplatesForOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get organization message templates handler and validators

handler: listMessageTemplatesForOrganizationHandler

validators:

listMessages

listMessages: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get messages handler and validators

handler: listMessagesHandler

validators:

listMessagesForPublic

listMessagesForPublic: HandlerAndValidators<Record<string, Predicate>>

Description

Get public messages handler and validators

handler: adapter.notFoundHandler

validators: {}

listMessagesForTopic

listMessagesForTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
    userCanSeeReadStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get topic messages handler and validators

handler: listMessagesForTopicHandler

validators:

listMessagesForUser

listMessagesForUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user messages handler and validators

handler: listMessagesForUserHandler

validators:

listSubscriptions

listSubscriptions: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get subscriptions handler and validators

handler: listSubscriptionsHandler

validators:

listSubscriptionsForTopic

listSubscriptionsForTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get topic subscriptions handler and validators

handler: listSubscriptionsForTopicHandler

validators:

listTopicAttachments

listTopicAttachments: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    topicExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get topic attachments handler and validators

handler: getAttachmentsByOwnerHandler

validators:

listTopics

listTopics: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get topics handler and validators

handler: listTopicsHandler

validators:

listTopicsOwnedByOrganization

listTopicsOwnedByOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get topics owned by an organization handler and validators

handler: listTopicsOwnedByOrganizationHandler

validators:

listTopicsOwnedByUser

listTopicsOwnedByUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user owned topics handler and validators

handler: listTopicsOwnedByUserHandler

validators:

listTopicsSubscribedByOrganization

listTopicsSubscribedByOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    userCanSeeReadStatus: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user subscribed topics handler and validators

handler: listTopicsSubscribedByUserHandler

validators:

listTopicsSubscribedByUser

listTopicsSubscribedByUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user subscribed topics handler and validators

handler: listTopicsSubscribedByUserHandler

validators:

updateMessage

updateMessage: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    messageExists: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update a message handler and validators

handler: updateMessageHandler

validators:

updateMessageReadStatus

updateMessageReadStatus: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isSubscribedToTopic: undefined | Predicate;
    messageExists: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Mark message read handler and validators

handler: updateMessageReadStatusHandler

validators:

updateMessageTemplate

updateMessageTemplate: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    checkMessageTemplatePermission: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update a message template handler and validators

handler: updateMessageTemplateHandler

validators:

updateTopic

updateTopic: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isChannelTopic: undefined | Predicate;
    topicExists: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update a topic handler and validators

handler: updateTopicHandler

validators:

Properties

adapterName

adapterName: string = ADAPTER_NAME

authSecrets

authSecrets: AuthSecrets

dataServices

dataServices: {
    attachment: AttachmentDefaultService;
    chat: ChatDataService;
}

Type declaration

dependencies

dependencies: ChatDefaultAdapterDependencies

opts

opts: Required<Omit<ChatDefaultAdapterOptions, "customFields" | (keyof AuthSecrets)> & {
    customFields: Required<{
        message?: CustomField[];
        subscription?: CustomField[];
        topic?: CustomField[];
    }>;
}>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc