Working with the Persistent Chat Platform in Lync 2013

Session Objectives

• Persistent Chat in the Lync API

• Persistent Chat Add-Ins

• Working with the Persistent Chat Server SDK

Agenda

Persistent Chat Server SDK

Persistent Chat Add-Ins

Persistent Chat in the Lync APIOverview

Working with the Persistent Chat Platform in Lync 2013

Overview

Persistent Chat Platform Components

Persistent Chat support added to client-side Lync 2013 SDK• Delivered as managed APIs• New in Lync 2013

Lync 2013 Persistent Chat PowerShell® interfaces• PowerShell cmdlets to administer and manage Persistent Chat

Lync 2013 Persistent Chat Server SDK• Introduced with OCS 2007 R2; was the only API available for Persistent

Chat• Lync 2013 continues supporting and enhancing this SDK• Separate install• Delivered as managed APIs that build on UCMA• Applications run on Lync Server (e.g., BOTs)

Persistent Chat in Lync 2013

• Consistent user experience

• Message history is persisted in the

room

• Stories

• Rich permissions structure

• Extensible using the Lync Managed API

• Interact with rooms and their events

• Build an add-in that runs in the room

Room Management

ManagementPowerShell cmdlets or using the Lync Server Control Panel

Management FuturesEnd-user interface for managing rooms

Room Add-InsExtend the room’s functionality using an add-in; e.g. display relevant news items sent by a bot

Category• Set options for rooms in

the category

• Set Allowed Members

• Set Denied Members

• Set Creators

Room• Inherit settings defined

in the category

• Set room type

• Associate an add-in

• Set Managers

• Set Members

• Room types

• Normal

• Auditorium

Add-In• Extend the functionality

of a room

• Web application hosted

in IIS

• Interact with the room

using the Lync API

demo

Persistent Chat in the Lync Client

Persistent Chat Server SDK

Persistent Chat Add-Ins

Persistent Chat in the Lync APIOverview

Working with the Persistent Chat Platform in Lync 2013

Agenda

Persistent Chat in the Lync API

Working with Persistent Chat using the Lync APIRoomManager

Accessible through LyncClient class

Get a room by its URI

Search for rooms

Follow and un-follow rooms

Subscribe to room events

Participant Added / Removed

Messages Received

Unread Message Count Changed

Working with Persistent Chat using the Lync APISend Messages to a Room

Message types

Regular

Alert

Story

Plain text or RTF

Filter Messages

Call Room.EnableOutgoingMessageFilter()

Take action on messages before they are sent to the room

Persistent Chat PowerShell cmdlets – Categories# Create a Persistent Chat CategoryNew-CsPersistentChatCategory –Name <String>

# Set the allowed members of the CategorySet-CsPersistentChatCategory -Identity <Identity>

-AllowedMembers @("<Active Directory Container">)

# Set users who are allowed to create Rooms in the CategorySet-CsPersistentChatCategory -Identity <Identity>

-Creators sip:username@contoso.com

# Indicate if users are notified when invited to a Room in the CategorySet-CsPersistentChatCategory –Identity <Identity>

-Invitations <Boolean>

Persistent Chat PowerShell cmdlets – Rooms

# Create a Room in a CategoryNew-CsPersistentChatRoom –Name <String>

-Category <String> -Description <String>

# Set the Managers of the RoomSet-CsPersistentChatRoom

-Identity <Identity> -Managers <Managers>

# Set the Members of the RoomSet-CsPersistentChatRoom

-Identity <Identity> -Members <Members>

demo

Working with Persistent Chat in the Lync API

Persistent Chat Server SDK

Persistent Chat Add-Ins

Persistent Chat in the Lync APIOverview

Working with the Persistent Chat Platform in Lync 2013

Agenda

Persistent Chat Add-Ins

Persistent Chat Add-Ins

Extend the Functionality of a Room

Add-ins run in the extension pane of the conversation

window

Can access the room

Can retrieve messages from the room

Can send messages to the room and apply filters to

messages

Scenarios

Display messages from a bot

Show grouped message history of the room

Provide companion LOB application in room

Add-In Development and Deployment

Development Experience

Build in Silverlight

Call LyncClient.GetHostingRoom() method to get

handle to room

Management

Deploy to IIS

Associate an add-in with a room

PowerShell cmdlets, Lync Server Control Panel, or

Persistent Chat Server SDK

Persistent Chat PowerShell cmdlets – Addins

# Create a new AddinNew-CsPersistentChatAddin

-Name <String> -PersistentChatPoolFqdn <String>-Url <String>

# Associate the Addin with a RoomSet-CsPersistentChatRoom

-Identity <String> -Addin <String>

demo

Persistent Chat Message History Add-In

Persistent Chat Server SDK

Persistent Chat Add-Ins

Persistent Chat in the Lync APIOverview

Working with the Persistent Chat Platform in Lync 2013

Agenda

Persistent Chat Server SDK

Persistent Chat Server SDK Scenarios

Room Participation

Post messages, query room directory and content, chat

history

Upload/download files

Throttling participant list updates

BOTs in a Room

Automated participants posting content to a room

Persistent Chat Server SDK Scenarios

Associate Add-Ins to a Room

Associate add-ins with Persistent Chat rooms to extend the

in-room experience

End User Room Creation and Management

Customize room creation and management workflows

Hook into Lync client entry point

Persistent Chat PowerShell cmdlets – Endpoints

# Create a new Persistent Chat EndpointNew-CsPersistentChatEndpoint

-SipAddress <String> -PersistentChatPoolFqdn <String>

demo

Working with the Persistent Chat Server SDK

Persistent Chat Server SDK

Persistent Chat Add-Ins

Persistent Chat in the Lync APIOverview

Working with the Persistent Chat Platform in Lync 2013

Agenda

Key takeaways

• Interact with Persistent Chat using the Lync API

• Build Persistent Chat add-ins using the Lync API

• Manage Persistent Chat using PowerShell cmdlets, and Lync Server

Control Panel

• Interact with and manage Persistent Chat using the Persistent Chat

Server SDK

thank you

© 2011 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S.

and/or other countries.

The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond

to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after

the date of this presentation.

MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.