How to: Join a Lync conversation
Learn how to use Microsoft Lync 2013 SDK to let a user join a Microsoft Lync 2013 conversation after receiving an invitation from another Lync 2013 user or a federated user.
Applies to: Lync 2013 | Lync Server 2013
In this article |
|
.png "Code samples"){kind=icon}
Prerequisites
The prerequisites for joining a Microsoft Lync 2013 conversation are as follow:
Microsoft Lync 2013 must be installed and running on the development computer.
You must have sign-in credentials for Microsoft Lync Server 2013.
Microsoft Lync 2013 SDK must be installed on the development computer.
Prepare for conversation invitations
Conversation invitations are only sent when the user is signed in to Lync 2013. Read about How to: Sign a user in to Lync and be sure that your application logic provides this capability before adding an IM feature to your UI.
To prepare for conversation invitations
Create a method called using the System.EventHandler<ConversationManagerEventArgs> delegate to handle the ConversationAdded event that is raised on an incoming invitation.
You accept or reject a conversation invitation in this method. The details of this delegate method are described in the following steps.
Get the Microsoft.Lync.Model.LyncClient and make sure the State is ConversationState.SignedIn.
For information about signing in to Microsoft Lync Server 2013, see How to: Sign a user in to Lync.
Get the Microsoft.Lync.Model.Conversation.ConversationManager class instance by reading the ConversationManager property of Microsoft.Lync.Model.LyncClient.
Register for the ConversationManager.ConversationAdded event on ConversationManager.
Get the Contact instance representing the local user from the signed-in Microsoft.Lync.Model.LyncClient instance, and then verify that this contact can participate in conversations using the conversation's modalities.
Handle a conversation invitation
You execute the following steps within a method that handles ConversationAdded.
.gif "Important note") Important |
|---|
A conversation whose only notified modality is the InstantMessageModality should be accepted but the modality is automatically connected. You can send and receive messages as soon as the IM conversation is active. |
To handle a conversation invitation
Check the state of the Microsoft.Lync.Model.Conversation.InstantMessageModality of the added conversation.
If the state is ModalityState.Notified, the added conversation is the result of an invitation and must be accepted or rejected. If accepted, the AVModality must be connected as shown in step 5.
ImportantConversationAdded is also raised when your application creates a new conversation and generates an invitation to a remote user. In this case, the conversation modality state is ModalityState.Disconnected when the new conversation is obtained in the ConversationAdded event.
Verify that there is an active audio device configured on the local machine by reading the ActiveAudioDevice property.
If the property returns a null value, an audio device is not configured on the local computer.
Reject the incoming call if the previous step shows that there is no active audio device and then call Reject on the conversation Microsoft.Lync.Model.Conversation.AudioVideo.AVModality.
Accept the conversation modality notification by calling Modality.Accept on the Modality instance.
Connect to the audio/video modality to activate the audio portion of the conversation.
Code examples: Lync conversations
The following example accepts or rejects an incoming conversation invitation based on the modalities specified for the conversation.
/// <summary>
/// Handles ConversationAdded state change event raised on ConversationsManager
/// </summary>
/// <param name="source">ConversationsManager The source of the event.</param>
/// <param name="data">ConversationsManagerEventArgs The event data. The incoming Conversation is obtained here.</param>
void ConversationManager_ConversationAdded(object sender, ConversationManagerEventArgs data)
{
Boolean IncomingAV = false;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
//Is this an audio/video invitation?
if (data.Conversation.Modalities[ModalityTypes.AudioVideo].State == ModalityState.Notified)
{
if (_LyncClient.DeviceManager.ActiveAudioDevice != null)
{
sb.Append("Incoming call from ");
IncomingAV = true;
}
else
{
data.Conversation.Modalities[ModalityTypes.AudioVideo].Reject(ModalityDisconnectReason.NotAcceptableHere);
}
}
if (data.Conversation.Modalities[ModalityTypes.InstantMessage].State == ModalityState.Connected)
{
sb.Append("Incoming IM from ");
}
string callerName = data.Conversation.Participants[1].Contact.GetContactInformation(ContactInformationType.DisplayName).ToString();
sb.Append(callerName);
sb.Append(System.Environment.NewLine);
sb.Append("Do you want to accept the invitiation?");
if (System.Windows.Forms.MessageBox.Show(
sb.ToString()
, "Incoming Invitation"
, System.Windows.Forms.MessageBoxButtons.YesNo
, System.Windows.Forms.MessageBoxIcon.Question) == System.Windows.Forms.DialogResult.Yes)
{
data.Conversation.ParticipantAdded += Conversation_ParticipantAdded;
data.Conversation.StateChanged += Conversation_ConversationChangedEvent;
data.Conversation.ActionAvailabilityChanged += Conversation_ActionAvailabilityChanged;
if (IncomingAV == true)
{
InitiateAVStream(data.Conversation);
}
}
}
The following example registers for participant events on the new conversation, accepts the conversation notification, and then connects to the conversation modality.
/// <summary>
/// Registers for events on a new conversation and connects to audio/video modality if call is incoming.
/// </summary>
/// <param name="pConversation">Conversation. New conversation.</param>
private void InitiateAVStream(Conversation pConversation)
{
if (pConversation.State == ConversationState.Terminated)
{
return;
}
if (pConversation.Modalities[ModalityTypes.AudioVideo].CanInvoke(ModalityAction.Connect))
{
pConversation.Modalities[ModalityTypes.AudioVideo].ModalityStateChanged += _AVModality_ModalityStateChanged;
pConversation.Modalities[ModalityTypes.AudioVideo].ActionAvailabilityChanged += _AVModality_ActionAvailabilityChanged;
//Accept the notification. If Lync UI is enabled, incoming call notification is closed.
pConversation.Modalities[ModalityTypes.AudioVideo].Accept();
//Connect the AV modality and begin to send and received AV stream.
object[] asyncState = { pConversation.Modalities[ModalityTypes.AudioVideo], "CONNECT" };
pConversation.Modalities[ModalityTypes.AudioVideo].BeginConnect(ModalityCallback, asyncState);
}
}
/// <summary>
/// Called on the LyncClient worker thread when an audio/video modality action completes.
/// </summary>
/// <param name="ar">IAsyncResult. The state of the asynchronous operation.</param>
private void ModalityCallback(IAsyncResult ar)
{
Object[] asyncState = (Object[])ar.AsyncState;
try
{
if (ar.IsCompleted == true)
{
if (asyncState[1].ToString() == "RETRIEVE")
{
((AVModality)asyncState[0]).EndRetrieve(ar);
}
if (asyncState[1].ToString() == "HOLD")
{
((AVModality)asyncState[0]).EndHold(ar);
}
if (asyncState[1].ToString() == "CONNECT")
{
((AVModality)asyncState[0]).EndConnect(ar);
}
if (asyncState[1].ToString() == "FORWARD")
{
((AVModality)asyncState[0]).EndForward(ar);
}
}
}
catch (LyncClientExceptions)
{ }
}
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for