Room - ArcticEcho/ChatExchange.Net GitHub Wiki
- Type:
bool. - Default:
false.
If true, removes mentions and pings ("@Username") and the message reply prefixes (":012345") from all messages.
- Type:
bool. - Default:
false.
If true, all Message instances will not initialise (and update) their StarCount and PinCount properties. Setting this property to true can help increase the responsiveness of the library.
- Type:
HashSet<User>.
Returns a list of all users that are currently able to receive "ping"s.
-Type: HashSet<User>.
Returns a list of users who are currently in the room.
- Type:
HashSet<User>.
Returns a list of the room's current owners.
- Type:
User.
Returns the current user.
- Type:
RoomMetaInfo.
Returns an object (RoomMetaInfo) containing meta data regarding the room (ID, Name, etc.).
- Type:
EventManager.
Returns the EventManager instance responsible for handling incoming chat events for the room.
Returns a Message for a given message ID (int). (This basically wraps the GetMessage method.)
-
Returns:
void. -
Parameters: N/A.
Leaves the room and disposes of the Room instance.
-
Returns:
Message, the requested message. -
Parameters:
int, the message ID.
Returns a Message for a given message ID.
-
Returns:
User, the requested user. -
Parameters:
int, the user ID.
Returns a User for the given user ID.
-
Returns:
Message, the message you have just posted. -
Parameters:
objectthe message to post (.ToString()is called).
Posts a new message in the room.
-
Returns:
bool,trueif the message was posted successfully, otherwisefalse. -
Parameters:
object, the message to post (.ToString()is called).
Posts a new message in the room (faster than PostMessage).
-
Returns:
Message, the message you have just posted. -
Parameters:
-
Message, the target message. Or;int, the target message's ID. -
object, the message to post (.ToString()is called).
Posts a message in the room in reply to another message.
-
Returns:
bool,trueif the message was posted successfully, otherwisefalse. -
Parameters:
-
Message, the target message. Or;int, the target message's ID. -
object, the message to post (.ToString()is called).
Posts a message in the room in reply to another message (faster than PostReply).
-
Returns:
bool,trueif the edit was successful, otherwisefalse. -
Parameters:
-
Message, the message to edit. Or;int, the ID of the message to edit. -
object, the text to which the message should be edited to (.ToString()is called).
Edits a message's text.
-
Returns:
bool,trueif the deletion was successful, otherwisefalse. -
Parameters:
Message, the message to delete. Or;int, the ID of the message.
Deletes a message.
-
Returns:
bool,trueif toggling the message's star was successful, otherwisefalse. -
Parameters:
Message, the message to star/unstar. Or;int, the ID of the message.
Stars or unstars a message.
-
Returns:
bool,trueif clearing the message's stars was successful, otherwisefalse. -
Parameters:
Message, the message to clear stars from. Or;int, the ID of the message.
Removes all stars from a message.
-
Returns:
bool,trueif toggling the message's pin was successful, otherwisefalse. -
Parameters:
Message, the message to pin/unpin. Or;int, the ID of the message.
Pins a message to the top of the room's starboard for 14 days (unless manually unpinned).
-
Returns:
bool,trueif kicking the user was successful, otherwisefalse. -
Parameters:
User, the user to kick. Or;int, the ID of the user.
Kicks a user out of the room for a certain period of time (the period increases with each successive kick). A moderator will be informed after kicking a user three times.
-
Returns:
bool,trueif setting the user's new access level was successful, otherwisefalse. -
Parameters:
-
UserRoomAccess, the new access level to be assigned. -
User, the target user to which the new access level should be applied to. Or;int, the ID of the target user.
Changes a user's room access level.