Add Custom Commands to Lync Menus

Use custom commands embedded in the Microsoft Lync 2010 UI to launch applications on the Microsoft Windows desktop. Custom commands are menu items added by the developer to the Lync 2010 UI. To add a custom command for an application, add a registry subkey and the registry entries described in this topic.

Registry Subkey
The subkey is the application GUID, added at one of the following locations:

For 64-bit operating systems:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Communicator\Sessi onManager\Apps

For 32-bit operating systems:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Communicator\SessionManager\Apps

Registry Entries
Under each GUID subkey, add the entries described in the following table. Entry Name Path Type REG_SZ REG_SZ Description Name of the application as it appears in the Lync 2010 UI. Full path of the application along with parameters, including the default parameters of %user-id% and %contact-id%. The parameters pass a String representing the SIP URI of the user signed into Lync 2010 and the selected contact or contacts, to the application launched. The following examples show usage for HTML and .exe paths.
c:\\ext_menu.exe /userId=%user-id% /contactId=%contact-id% http://localhost/Test/Sample1.html?userId=%userid%;contactId=%contact-id%

ApplicationType DWORD 0 = Executable, 1 = Protocol. ApplicationInstallPath REG_SZ Full path of the executable. Required if ApplicationType is 0.

SessionType

DWORD

0 = local session. The application is launched on this computer. 1 = two-party session. Microsoft Lync 2010 SDK launches the application locally and prompts the other user to launch the application on their computer. 2 = multi-party session. Lync SDK launches the application locally and prompts the other users to launch the application on their computers.

ExtensibleMenu

REG_SZ

A semicolon-delimited list of places where the command appears. Possible values: MainWindowActions, MainWindowRightClick, ConversationWindowActions, ConversationWindowRightClick, ContactCardMenu. If ExtensibleMenu is not defined, the default values of MainWindowRightClick and ConversationWindowActions are used.

For example, see the following Registry Editor (.reg) file results.
Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Communicator\SessionManager\Apps\{3E0352E8-21F34E00-AA46-2ADA7085C9AD}] "Name"="Contoso Custom Application" "ApplicationType"=dword:00000000 "ApplicationInstallPath"="C:\\ExtApp1.exe" "Path"="C:\\ExtApp1.exe /userId=%user-id% /contactId=%contact-id%" "SessionType"=dword:00000000 "ExtensibleMenu"="ConversationWindowRightClick;ContactCardMenu;MainWindowRightClick"

Custom Parameters for the Path Registry Entry Custom parameters %param1% through %param7% may be set for each application.
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Communicator\SessionManager\Apps\{9 6DC330B-0A57-4A26-963B-75A109CD3C30}] "Name"="Your Application Name " "Path"="C:\\Program Files (x86)\\YourApplication\\ps.exe %param1%" "ToolTip"="tooltip text" "ApplicationType"=dword:00000000 "SessionType"=dword:00000002 "Extensiblemenu"="MainWindowActions;MainWindowRightClick;ConversationWindowActions;Conversation WindowContextual;ConversationWindowRightClick;ConversationWindowButton"

These parameters will be replaced by values added in a separate key under HKEY_CURRENT_USER as shown in the following example, and passed to the recipient in the appINVITE message.
[HKEY_CURRENT_USER\Software\Microsoft\Communicator\SessionManager\Apps\Parameters\{96DC330 B-0A57-4A26-963B-75A109CD3C30}] "param1"="256341"

Using custom command

The following table describes how to launch an application with a given ExtensibleMenu value. ExtensibleMenu value MainWindowActions Action In the upper-right corner of the Lync 2010 conversation window, click the Show menu button, point to Tools, and then click the custom command. MainWindowRightClick In the conversation window, right-click a contact in the Contact List or Search Results pane, and then click the custom command. ConversationWindowActions In the upper-right corner of the conversation window, click the Show menu button, point to Actions, and then click the custom command. ConversationWindowRightClick In the conversation window, click the View more layout options button, select People Options, activate Show Participant List, right-click a contact name, and then click the custom command. ContactCardMenu Click the custom command in the contact card Options menu.

Retrieving SIP URIs in the Custom Application

To retrieve the %user-id% and %contact-id% arguments, add code to the application launched by the custom command.

Source Searched from MSDN