Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-40535

Add User API methods for ContextualUserDisplayService

    XMLWordPrintable

    Details

    • Type: Task
    • Status: RESOLVED
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 12.3
    • Fix Version/s: 19.0
    • Component/s: Chat, Kernel
    • Labels:
      None
    • Test Plan:
      Hide

      Test for no regressions in user display names in the Chat tool specifically and elsewhere in Sakai. Display names are of the form "Firstname Lastname" rather than contexts where a name is displayed as "Lastname, Firstname".

      This can be tested on custom builds with an implementation of ContextualUserDisplayService, for example here https://github.com/cilt-uct/roleplay/tree/12.x which adds the User Alias tool. In that case, adding the tool to a site and defining an alias for a user should result in that user showing as the aliased display name in the chat tool, both on first access and when the aliased user posts new messages.

      Show
      Test for no regressions in user display names in the Chat tool specifically and elsewhere in Sakai. Display names are of the form "Firstname Lastname" rather than contexts where a name is displayed as "Lastname, Firstname". This can be tested on custom builds with an implementation of ContextualUserDisplayService, for example here https://github.com/cilt-uct/roleplay/tree/12.x which adds the User Alias tool. In that case, adding the tool to a site and defining an alias for a user should result in that user showing as the aliased display name in the chat tool, both on first access and when the aliased user posts new messages.

      Description

      SAK-10868 and SAK-39642 added support for context-specific user aliases, that is a display name for a user that can be different in a specific site context.

      This supports the "role play" or "user alias" use case, for example for simulation games (. There is a contrib implementation for this (https://confluence.sakaiproject.org/display/RPLAY/Home) in use by UCT and possibly others.

      When implemented, it was sufficient to resolve the site context from the tool context, but as more tools have moved to using /direct/ or other REST endpoints for tool data, this no longer works as the tool placement is not available, specifically for chatData in the Chat Tool.

      This task adds methods to the User API so that tool- and service endpoints can get a display name for a user for a specific site context explicitly.

      This also allows us to remove explicit use of ContextualUserDisplayService in various tool code.

        Gliffy Diagrams

          Zeplin

            Attachments

              Activity

                People

                Assignee:
                smarquard Stephen Marquard
                Reporter:
                smarquard Stephen Marquard
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    Git Integration