Export (0) Print
Expand All

ChatRoomSession Members

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.

  NameDescription
Public methodChatRoomSessionInitializes a new instance of the ChatRoomSession class.
Top

  NameDescription
Public propertyAddInGets the current add-in which applies to this chat room.
Public propertyCanChatGets or sets a value indicating whether the current user can chat. If IsAuditorium, the user must have Presenter permission to chat.
Public propertyCanManageGets or sets a value indicating whether the current user can manage this chat room.
Public propertyChatRoomUriGets the URI of the chat room to which this session is joined. If the session is not joined, this property is null.
Public propertyEndpointGets the endpoint on which this session was established.
Public propertyIsAuditoriumGets 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.
Public propertyNameGets the name of the chat room to which this session is joined. If the session is not joined, this property is null.
Public propertyParentCategoryUriGets 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 propertyParticipantsGets the participant list of the chat room to which this session is joined. If the session is not joined, this property returns null.
Public propertyStateGets a value indicating whether this session is joined.
Public propertyTopicGets the topic of the chat room to which this session is joined. If the session is not joined, this property is null.
Top

  NameDescription
Public methodBeginDownloadFileDownloads a file from the chat room.
Public methodBeginGetHiddenParticipantListGet the current list of participants for a "Large" chat room.
Public methodBeginGetRecentChatHistoryReturns the requested number of recent chat messages for this chat room, up to the server limit.
Public methodBeginJoin(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.
Public methodBeginJoin(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.
Public methodBeginJoin(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.
Public methodBeginLeaveLeave the chat room. This method ends a user's current session which was initiated by a Join operation.
Public methodBeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object)Query the history of chat on this chat room.
Public methodBeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object)Query the history of chat on this chat room.
Public methodBeginSendChatMessage(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.
Public methodBeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object)Sends a formatted chat message to a chat room. A formatted message can be composed of hyperlinks, emoticons, and other parts.
Public methodBeginSendChatMessage(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.
Public methodBeginSendChatMessage(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.
Public methodBeginUploadFileUploads a file to the chat room.
Public methodEndDownloadFileCompletes the asynchronous request initiated by BeginDownloadFile(ChatRoomFileDownloadJob, AsyncCallback, Object).
Public methodEndGetHiddenParticipantListCompletes the asynchronous request initiated by BeginGetHiddenParticipantList(AsyncCallback, Object).
Public methodEndGetRecentChatHistoryCompletes the asynchronous request initiated by BeginGetRecentChatHistory(Int32, AsyncCallback, Object).
Public methodEndJoinCompletes the asynchronous request initiated by BeginJoin(ChatRoomSummary, AsyncCallback, Object), BeginJoin(String, AsyncCallback, Object), or BeginJoin(Uri, AsyncCallback, Object).
Public methodEndLeaveCompletes the asynchronous request initiated by BeginLeave(AsyncCallback, Object)
Public methodEndQueryChatHistoryCompletes the asynchronous request initiated by BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object) or BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object).
Public methodEndSendChatMessageCompletes the asynchronous request initiated by BeginSendChatMessage(String, AsyncCallback, Object), BeginSendChatMessage(String, Boolean, AsyncCallback, Object), or BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object).
Public methodEndUploadFileCompletes the asynchronous request initiated by BeginUploadFile(ChatRoomFileUploadJob, AsyncCallback, Object).
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Public eventChatMessageReceivedRaised when a chat message is received. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public eventChatRoomPropertiesChangedRaised when the properties of the chat room change. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public eventChatRoomSessionStateChangedRaised 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.
Public eventParticipantAttendanceChangedRaised when a participant joins the chat room. For best results, register for this event before invoking BeginJoin(ChatRoomSummary, AsyncCallback, Object) on the session.
Public eventParticipantPrivilegeChangedRaised 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.
Top

  NameDescription
Public operatorStatic memberImplicit(ChatRoomSession to ChatRoomSummary)Performs an implicit conversion from ChatRoomSession to ChatRoomSummary.
Top
Show:
© 2015 Microsoft