social / pragma.account / AccountService / updateDisplayNameV1 /

updateDisplayNameV1 #

@ExperimentalCoroutinesApi

suspend fun updateDisplayNameV1(playerSession: PlayerSession, request: AccountRpc.UpdateDisplayNameV1Request): AccountRpc.UpdateDisplayNameV1Response

Updates a user’s display name By default player display name updates are disabled in the DefaultAccountPlugin. Implement your own plugin to enable player display name updates AccountService.updateDisplayNameV1.

Plugins

  • AccountPlugin.updateDisplayName - Called whenever a user updates their email. Can be used to customize display name update behavior

PragmaApplicationErrors

  • pragma.ValidationFailedApplicationError when display name is blank.
  • AccountRpc.DisplayNameUpdateNotAllowedApplicationError when the AccountPlugin prevents a display name update.

PragmaResultErrors

  • PragmaError.Database_Error when failing to update the display name in the db.