Function listUserPreferencesHandler

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

  • List user preferences handler

    Parameters

    • preferenceService: PreferenceDataService

      injected service use to handle the preference related operations

      • getPreferences
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

      • params.userId is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status OK

    • data: user preferences with pagination

    Description

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

    1. Get userId from context.params

    2. Add userId to filter expression and concat query.$filter (if any)

    3. Parse paginated list query (util.parsePaginatedListQuery)

    4. Get user preferences (preferenceService.getPreferences)

    5. Return user preferences

    Throws

    Error

    • userId not defined

    Throws

    400 NBError Bad Request

    • error when parse paginated list query
    • pagination must be set
    • page size is too large, must less than MAXIMUM_PAGE_SIZE

Settings

Member Visibility

Theme

Generated using TypeDoc