Edit

Get-CsPersistentChatAddin

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2013, Skype for Business Server 2015

Returns information about all the Persistent Chat add-ins configured for use in the organization. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. This cmdlet was introduced in Lync Server 2013.

Syntax

Get-CsPersistentChatAddin
   [-Identity] <String>
   [<CommonParameters>]
Get-CsPersistentChatAddin
   [-PersistentChatPoolFqdn <String>]
   [<CommonParameters>]

Description

The Persistent Chat service provides organizations with messaging and collaboration capabilities similar to those found in Internet discussion forums: users can exchange messages in real-time, yet can also revisit and restart those conversations at any time. Conversations can be based around specific topics, and these conversations can be made available to everyone or to only a selected set of users. Likewise, individual chat rooms can be configured so that anyone can post a message or configured so that only designated presenters can post messages.

Add-ins serve as extensions to a Persistent Chat chat room. Add-ins are external applications (that is, items not built into Persistent Chat itself) that are associated with a particular chat room. For example, a help desk chat room might include a URL that links to a Web page or to an application that shows the status of the day's help requests. The Skype for Business Server Windows PowerShell command-line interface cmdlets do not provide the ability to create these add-ins. Instead, the CsPersistentChatAddin cmdlets are used to associate (or disassociate) an add-in from a chat room.

To view Persistent Chat add-in information in Skype for Business Server Control Panel, click Persistent Chat and then click Add-in.

Examples

-------------------------- Example 1 --------------------------

Get-CsPersistentChatAddin

Example 1 returns information about all the Persistent Chat add-ins configured for use in the organization.

-------------------------- Example 2 --------------------------

Get-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin"

In Example 2, information is returned for a specific Persistent Chat add-in: the add-in with the Identity atl-cs-001.litwareinc.com\ITPersistentChatAddin.

-------------------------- Example 3 --------------------------

Get-CsPersistentChatAddin -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com"

Example 3 returns information for all the Persistent Chat add-ins configured for use on the pool atl-cs-001.litwareinc.com.

Parameters

-Identity

Unique identifier for the Persistent Chat add-in to be returned. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "" character, and the add-in name. For example:

-Identity "atl-gc-001.litwareincom\ITPersistentChatAddin"

If this parameter is not specified then the Get-CsPersistentChatAddin cmdlet returns information about all your Persistent Chat add-ins.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015

-PersistentChatPoolFqdn

Fully qualified domain name for the Persistent Chat pool. If this parameter is used then only Persistent Chat add-ins found on the specified pool will be returned. If this parameter is not used then the Get-CsPersistentChatAddin cmdlet will return add-ins from all your Persistent Chat pools. For example:

-PoolFqdn "atl-cs-001.litwareinc.com"

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015

Inputs

None

Outputs

Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject