Deep links in Virola client app

A deep link is a specific type of link that directs users to a particular location or piece of content within the Virola client app. By using Virola deep links, your users can save time and effort during onboarding and while communicating later on.

Virola deep links start with virola:// and can either execute a command or lead directly to a specific message, group chat room, or user profile.

Commands supported by Virola deep links

All commands are executed by the link virola://command?action={command-name} followed by a parameter string if needed.

There are three commands currently supported in Virola:

Virola client app activation

The command virola://command?action=activate

  • Starts the Virola client app if it's not running
  • Restores the Virola client app window if it is minimized
  • Makes Virola blink in the taskbar if its window is already restored but hidden behind other windows

This command doesn't require any parameters.

User password reset

The command virola://command?action=reset-password helps users to create a new password during the password reset process. It starts or restores the Virola client app, automatically logs the user in with a temporary password, and opens the "Force reset password" form to enter a new password.

To work properly, reset-password command requires the following parameters:

  • host - the server host name
  • port - the server port
  • user-name - username of the user whose password is being reset
  • temp-password - temporal user password

Example: virola://command?action=reset-password&host=127.0.0.1&port=7777&user-name=admin&temp-password=admin

Normally, the URL with reset-password command is generated automatically when the server аdmin resets a user password. To get a password reset link Virola admin needs to do the following:

  1. Follow Administration / Manage Users
  2. Find the user whose password should be reset
  3. Right click on the user and select "Reset user password"
  4. Copy the reset password link and provide it to a user

It is very convenient to use reset password command if you want your users to create their passwords themselves. In this case you will need to provide them with password reset links which they will use to specify their own user passwords.

User self-registration

The command virola://command?action=self-registration allows users to create their own profiles on a server. It only works if user self-registration is enabled in the server settings. The command starts or restores the Virola client app with the self-registration wizard open, prompting the user to define their username and password for registration.

To work properly, self-registration command requires the following parameters:

  • host - the server host name
  • port - the server port

Example: virola://command?action=self-registration&host=127.0.0.1&port=7777

Optional parameters

A set of optional parameters can be passed to reset-password and self-registration commands:

  • profile-name - the name for a new application profile. It will be used when the command execution includes a new application profile creation. It won't be used if the profile with this name already exists
  • Proxy parameters:
    • proxy-host - required for correct proxy setup
    • proxy-port - required for correct proxy setup
    • proxy-user-name - optional for correct proxy setup
    • proxy-user-password - optional for correct proxy setup

Navigational deep links

Navigational deep links allow to easily get to the needed message, group chat room, or user profile. They only work when clicked within Vrola client app.

Group chat room link

This link has the following look virola:///room/{room-id}. It is used to invite users to a group chat. To do this:

  1. Right click the group room tab
  2. Select "Copy Room Link" menu item
  3. Send the copied link to the user you want to invite

After clicking such a link, a user will be automatically added to the group chat room.

However, an option to allow users to add themselves to a group chat room should be enabled in the Chat Room Options for the group chat room where you would like to invite new users. Otherwise, these users will get an error that the chat room was not found.

User profile link

A user profile link has the following look virola:///user/{room-id} and opens a user profile. To get a user profile link you need to:

  1. Right click on the user
  2. Select "Copy link to user" menu item

However, if the permission "See other users' personal details" is restricted, it will be impossible to get a user profile link.

The ability to share links to user profiles is useful if you need to introduce a new team member or share information about an expert in your company with your co-workers.

Message link

A message link has the following look virola:///message/{room-id} and navigates to the specified message. To get a message link you need to:

  1. Right click on the message
  2. Select "Copy Message Link" menu item

You can share this link in other chats, both private and group. However, if a user has no access to the chat room where the message was sent, that user will get "Message not found" error.