ChatRoomSession members

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.

  Name Description
Public method ChatRoomSession Initializes a new instance of the ChatRoomSession class.
Top

  Name Description
Public property AddIn Gets the current add-in that applies to this chat room.
Public property CanChat Gets a Boolean value indicating whether the current user can chat. If IsAuditorium is true, the user must have the Presenter permission to chat.
Public property CanManage Gets a Boolean value indicating whether the current user can manage this chat room.
Public property ChatRoomUri Gets the URI of the chat room to which this session is joined. If the session is not joined, this property is null.
Public property Description Gets the description of the chat room to which this session is joined. If the session is not joined, this property is null.
Public property Endpoint Gets the endpoint on which this session was established.
Public property IsAuditorium Gets the value indicating if the chat room is an auditorium chat room. In an auditorium chat room, only those members who have been granted Presenter privileges may post messages.
Public property IsFilePostAllowed Gets a Boolean value indicating whether file posting is allowed in the chat room.
Public property IsInvite Gets a Boolean value indicating if members are invited to the chat room.
Public property IsLogged Gets a Boolean value indicating if the chat room is logged.
Public property Name Gets the name of the chat room to which this session is joined. If the session is not joined, this property is null.
Public property 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.
Public property Participants Gets the participant list of the chat room to which this session is joined.
Public property State Gets a value indicating the state of this chat room session.
Public property VisibleOnlyToMembers Gets a Boolean value indicating if the room is private and visible only to members.
Top

  Name Description
Public method BeginDownloadFile Downloads a file from the chat room.
Public method BeginGetHiddenParticipantList Get the current list of participants for a large chat room.
Public method BeginGetRecentChatHistory Returns the requested number of recent chat messages for this chat room, up to the server limit.
Public method BeginJoin(String, AsyncCallback, Object) Joins the chat room with the given name.
Public method BeginJoin(Uri, AsyncCallback, Object) Joins the chat room indicated by the given URI.
Public method BeginJoin(ChatRoomSummary, AsyncCallback, Object) Joins the chat room indicated by the given ChatRoomSummary.
Public method BeginLeave Leaves the chat room and ends a user's current session which was initiated by a joining operation.
Public method BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) Queries the chat history of this chat room.
Public method BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object) Query the chat history of this chat room.
Public method BeginSendChatMessage(String, AsyncCallback, Object) Sends a chat message to a joined chat room.
Public method BeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object) Sends a formatted chat message to a joined chat room.
Public method BeginSendChatMessage(String, Boolean, AsyncCallback, Object) Sends a high priority alert message to the joined chat room.
Public method BeginSendChatMessage(String, String, AsyncCallback, Object) Sends an RTF-formatted chat message to the joined chat room.
Public method BeginSendChatMessage(FormattedOutboundChatMessage, String, AsyncCallback, Object) Sends a formatted chat message with RTF-formatted content to a chat room.
Public method BeginSendChatMessage(String, Boolean, String, AsyncCallback, Object) Send a RTF-formatted high priority alert message to the joined chat room.
Public method BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object) Send a story message to the joined chat room.
Public method BeginSendChatMessage(String, String, String, Boolean, AsyncCallback, Object) Send a RTF-formatted story message to the joined chat room.
Public method BeginUploadFile Uploads a file to the chat room.
Public method EndDownloadFile Completes the asynchronous request initiated by BeginDownloadFile(ChatRoomFileDownloadJob, AsyncCallback, Object)
Public method EndGetHiddenParticipantList Completes the asynchronous request initiated by BeginGetHiddenParticipantList(AsyncCallback, Object)
Public method EndGetRecentChatHistory Completes the asynchronous request initiated by BeginGetRecentChatHistory(Int32, AsyncCallback, Object)
Public method EndJoin Completes the asynchronous request initiated by BeginJoin(ChatRoomSummary, AsyncCallback, Object), BeginJoin(String, AsyncCallback, Object), or BeginJoin(Uri, AsyncCallback, Object)
Public method EndLeave Completes the asynchronous request initiated by BeginLeave(AsyncCallback, Object)
Public method EndQueryChatHistory Completes the asynchronous request initiated by BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) or BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object)
Public method EndSendChatMessage Completes the asynchronous request initiated by BeginSendChatMessage(String, AsyncCallback, Object), BeginSendChatMessage(String, Boolean, AsyncCallback, Object), or BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object).
Public method EndUploadFile Completes the asynchronous request initiated by BeginUploadFile(ChatRoomFileUploadJob, AsyncCallback, Object)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Top

  Name Description
Public event ChatMessageReceived Raised when a chat message is received. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ChatRoomPropertiesChanged Raised when the properties of the chat room change. To catch the events, an application must register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ChatRoomSessionStateChanged Raised when the state of this chat room 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 PersistentChatEndpoint is disconnected. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ParticipantAttendanceChanged Raised when a participant joins or leaves the chat room. To catch the events, an application must register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public event ParticipantPrivilegeChanged Raised when the privileges of an active user in this chat room change. Privileges monitored by this event include Manager and Presenter. To catch the events, an application must register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Top

  Name Description
Public operator Static member Implicit(ChatRoomSession to ChatRoomSummary) Performs an implicit conversion from ChatRoomSession to ChatRoomSummary.
Top

Community Additions

ADD
Show:
© 2014 Microsoft