Function getUserPreferenceHandler

  • getUserPreferenceHandler(preferenceService, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get user preference by id handler

    Parameters

    • preferenceService: PreferenceDataService

      injected service use to handle the preference related operations

      • getPreferenceById
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

      • params.preferenceId is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status OK

    • data: Preference

    Description

    This handler will get user preference by id by applying the following steps in sequence:

    1. Get preferenceId from context.params

    2. Get user preference by id (preferenceService.getPreferenceById)

    3. Return user preference

    Throws

    Error

    • preferenceId not defined

    Throws

    404 NBError Not Found

    • preference not found

Settings

Member Visibility

Theme

Generated using TypeDoc