Share via


ChatRoomCategory.LogChatHistory Property

Gets the default behavior of chat rooms in this category for logging chat history.

Namespace:  Microsoft.Rtc.Collaboration.GroupChat
Assembly:  Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)

Syntax

'Declaration
Public Property LogChatHistory As InheritedChatRoomProperty
    Get
    Private Set
'Usage
Dim instance As ChatRoomCategory
Dim value As InheritedChatRoomProperty

value = instance.LogChatHistory
public InheritedChatRoomProperty LogChatHistory { get; private set; }

Property Value

Type: Microsoft.Rtc.Collaboration.GroupChat.InheritedChatRoomProperty
A data structure which conveys the value set on this category (if any), the value which is inherited from the parent category, and the effective value which is used.

Remarks

The value of this property is derived by combining the value set on this instance (if any) with the value that is inherited from the parent category. The default value is null, which causes the category to inherit the value set by the parent category. Initially, the value of this property is set to true on the root category.

Logging chat history is useful for providing context, in the form of recent chat history, which users can request upon joining. It is also useful for searching past messages, to provide a record of what has been said. This value will be used to set the initial value of any chat room created in this category. Each chat room manager can choose to inherit the category value, or override it for that specific chat room.

See Also

Reference

ChatRoomCategory Class

ChatRoomCategory Members

Microsoft.Rtc.Collaboration.GroupChat Namespace