Edit

Get started with Persistent Chat

  • Article

Learn about the programming concepts and Microsoft Lync 2013 SDK object model that you use to add Lync 2013 Persistent Chat features to your application.

Applies to: Lync 2013 | Lync Server 2013

What is Persistent Chat?

The classes in the Persistent Chat Microsoft.Lync.Model.Room namespace are the building blocks for features that range from chat room activity feeds, through chat room extensions called "add-on" applications, and to complete Persistent Chat room client applications. You can get chat rooms, join chat rooms, read chat room messages, and post chat room messages. You can also catch posts from the local user before they are posted if you need to filter, format, or cancel them.

A chat room add-in allows you to create features such as a bot feed that automatically formats and posts messages to a chat room. It's also possible to create an add-in application that can read the complete history of posts in a room and parse the posts for interesting keywords and concepts.

Get started with Persistent Chat

The prerequisites for working with Persistent Chat are as follows:

  • Microsoft Lync 2013

  • Sign-in credentials for Microsoft Lync Server 2013

  • Microsoft Lync 2013 SDK

Persistent Chat essentials

To understand how to work with Persistent Chat, it's important to become familiar with the concepts in the following table.

Concept

Description

Core concepts: Persistent Chat

Lync 2013 implements a set of Persistent Chat features that replace the Lync Server 2010 Group Chat client. Lync 2013 SDK gives you programmatic access to those features through its API.

Chat rooms

Learn about the Microsoft Lync Server 2013 Persistent Chat room feature as it's implemented in Lync 2013 SDK.

Room manager

Learn about the Persistent Chat room manager class, which is part of Lync 2013 SDK.

Chat room messages

Learn about the programming pattern used with the four Lync 2013 SDK types to read messages posted in a Lync 2013 Persistent Chat room.

What can you do with Persistent Chat?

The following table lists basic tasks for working with Persistent Chat.

Task

Description

How to: Read messages sent to a chat room

Shows the Lync 2013 SDK code that you add to an application window so that a user can read messages as they are posted to a Microsoft Lync 2013 chat room.

How to: Send a message to a chat room

Describes how to post regular and story messages to a Microsoft Lync 2013 Persistent Chat room by using methods in Lync 2013 SDK.

How to: Find a chat room

Shows how to query for a Microsoft Lync 2013 Persistent Chat room by using methods in Lync 2013 SDK.

How to: View chat room participants

Shows how to display and maintain a roster of users who have joined a Lync 2013 chat room.

How to: Filter an outgoing message from a local user to a chat room

Shows how to create a client-side ethical/security filter for messages that Microsoft Lync 2013 is posting to a Lync 2013 Persistent Chat room.

Beyond the basics: Learn more about Persistent Chat

The following table lists advanced concepts for working with Persistent Chat.

Concept

Description

Create an add-in for the Persistent Chat window

Learn how to design a Persistent Chat room add-in that displays messages that a Microsoft Unified Communications Managed API (UCMA) bot has posted to the hosting chat room and then filters the pending message posts of the local user.

Create a custom Persistent Chat client

Learn about the components of a typical custom Microsoft Lync 2013 Persistent Chat window.

See also