ChatRoomSession Members

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Enables a user to join a chat room. When joined to a chat room, a user can send and receive chat messages in real time.

The ChatRoomSession type exposes the following members.

Constructors

	Name	Description
	ChatRoomSession	Initializes a new instance of the ChatRoomSession class.

Top

Properties

	Name	Description
	AddIn	Gets the current add-in which applies to this chat room.
	CanChat	Gets or sets a value indicating whether the current user can chat. If IsAuditorium, the user must have Presenter permission to chat.
	CanManage	Gets or sets a value indicating whether the current user can manage this chat room.
	ChatRoomUri	Gets the URI of the chat room to which this session is joined. If the session is not joined, this property is null.
	Endpoint	Gets the endpoint on which this session was established.
	IsAuditorium	Gets the value indicating if the chat room is an auditorium chat room. When true, only those members who have been granted Presenter privileges may post messages. If the session is not joined, this property returns false.
	Name	Gets the name of the chat room to which this session is joined. If the session is not joined, this property is null.
	ParentCategoryUri	Gets the URI of the category for the chat room to which this session is joined. If the session is not joined, this property is null.
	Participants	Gets the participant list of the chat room to which this session is joined. If the session is not joined, this property returns null.
	State	Gets a value indicating whether this session is joined.
	Topic	Gets the topic of the chat room to which this session is joined. If the session is not joined, this property is null.

Top

Methods

	Name	Description
	BeginDownloadFile	Downloads a file from the chat room.
	BeginGetHiddenParticipantList	Get the current list of participants for a "Large" chat room.
	BeginGetRecentChatHistory	Returns the requested number of recent chat messages for this chat room, up to the server limit.
	BeginJoin(String, AsyncCallback, Object)	Join the chat room with the given name. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
	BeginJoin(Uri, AsyncCallback, Object)	Join the chat room indicated by the given URI. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
	BeginJoin(ChatRoomSummary, AsyncCallback, Object)	Join the chat room indicated by the given ChatRoomSession. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
	BeginLeave	Leave the chat room. This method ends a user's current session which was initiated by a Join operation.
	BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object)	Query the history of chat on this chat room.
	BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object)	Query the history of chat on this chat room.
	BeginSendChatMessage(String, AsyncCallback, Object)	Send a chat message to the chat room. Users must first successfully join a chat room to initiate the session before a message can be sent.
	BeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object)	Sends a formatted chat message to a chat room. A formatted message can be composed of hyperlinks, emoticons, and other parts.
	BeginSendChatMessage(String, Boolean, AsyncCallback, Object)	Send a high priority message to the chat room. An alert message will be displayed within the group chat client using a different color (usually red) for emphasis. It will also, depending up on the users preferences, be announce by a bell, chime, or other sound effect. Users must first successfully join a chat room to initiate the session before a message can be sent.
	BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object)	Send a story message to the chat room. Story messages are generally used for sending long-format chat messages. They are displayed in the group chat client as a one-line message, on which the title of the story appears as a clickable link. When selected, the entire content of the message is displayed in a dialog box. Users must first successfully join a chat room to initiate the session before a message can be sent.
	BeginUploadFile	Uploads a file to the chat room.
	EndDownloadFile	Completes the asynchronous request initiated by BeginDownloadFile(ChatRoomFileDownloadJob, AsyncCallback, Object).
	EndGetHiddenParticipantList	Completes the asynchronous request initiated by BeginGetHiddenParticipantList(AsyncCallback, Object).
	EndGetRecentChatHistory	Completes the asynchronous request initiated by BeginGetRecentChatHistory(Int32, AsyncCallback, Object).
	EndJoin	Completes the asynchronous request initiated by BeginJoin(ChatRoomSummary, AsyncCallback, Object), BeginJoin(String, AsyncCallback, Object), or BeginJoin(Uri, AsyncCallback, Object).
	EndLeave	Completes the asynchronous request initiated by BeginLeave(AsyncCallback, Object)
	EndQueryChatHistory	Completes the asynchronous request initiated by BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) or BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object).
	EndSendChatMessage	Completes the asynchronous request initiated by BeginSendChatMessage(String, AsyncCallback, Object), BeginSendChatMessage(String, Boolean, AsyncCallback, Object), or BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object).
	EndUploadFile	Completes the asynchronous request initiated by BeginUploadFile(ChatRoomFileUploadJob, AsyncCallback, Object).
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	ChatMessageReceived	Raised when a chat message is received. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
	ChatRoomPropertiesChanged	Raised when the properties of the chat room change. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
	ChatRoomSessionStateChanged	Raised when the joined state of this session changes. This event will fire when invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) or BeginLeave(AsyncCallback, Object) on the session. It will also be fired if the membership privileges of the currently logged in user change, or if the GroupChatEndpoint is disconnected. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
	ParticipantAttendanceChanged	Raised when a participant joins the chat room. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
	ParticipantPrivilegeChanged	Raised when a participant joins the chat room. Privileges monitored by this event include Manager and Presenter. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.