Function doesUserHaveAnyTopicPermission

  • doesUserHaveAnyTopicPermission(chatService, options, logger, context): Promise<number>

  • Does user have any topic permission validator

    Parameters

    • chatService: ChatDataService

      injected service use to handle the chat related operations

      • getOneTopic
      • getSubscriptions
    • options: {
          authSecrets: AuthSecrets;
          authenticate: AuthenticationFunction;
          permissions: string[];
          topicIdField: TargetField;
      }

      Options

      • authSecrets authenticate secret
      • authenticate injected authenticate function
      • permissions which permissions to check
      • targetField which field to get the message template id from
      • topicIdField which field to get the topic id from
      • authSecrets: AuthSecrets
      • authenticate: AuthenticationFunction
      • permissions: string[]
      • topicIdField: TargetField
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<number>

    200 Status OK

    Description

    This validator checks if the user has any topic permission by applying the following steps in sequence:

    1. Authenticate the user (authenticate)

    2. Get topic by id (chatService.getOneTopic)

    3. Get subscriptions by topicId, userId and permissions (chatService.getSubscriptions)

    4. Return 200 if the user has any topic permission

    Throws

    403 NBError Forbidden

    • check user subscription validator need token type to be user token
    • user not subscribed to the topic: ${topicId}

    Throws

    404 NBError Not Found

    • topic: ${topicId} not found.

Settings

Member Visibility

Theme

Generated using TypeDoc