Skip to content
This repository was archived by the owner on May 18, 2018. It is now read-only.

Room

Jump to bottom
Sam edited this page Dec 1, 2017 · 3 revisions

Properties

StripMention

  • Type: bool.
  • Default: false.

If true, removes mentions and pings ("@Username") and the message reply prefixes (":012345") from all messages.

InitialisePrimaryContentOnly

  • 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.

PingableUsers

  • Type: HashSet<User>.

Returns a list of all users that are currently able to receive "ping"s.

CurrentUsers

-Type: HashSet<User>.

Returns a list of users who are currently in the room.

RoomOwners

  • Type: HashSet<User>.

Returns a list of the room's current owners.

Me

  • Type: User.

Returns the current user.

Meta

  • Type: RoomMetaInfo.

Returns an object (RoomMetaInfo) containing meta data regarding the room (ID, Name, etc.).

EventManager EventManager

  • Type: EventManager.

Returns the EventManager instance responsible for handling incoming chat events for the room.

Indexer

Returns a Message for a given message ID (int). (This basically wraps the GetMessage method.)

Methods

Leave

  • Returns: void.

  • Parameters: N/A.

Leaves the room and disposes of the Room instance.

GetMessage

  • Returns: Message, the requested message.

  • Parameters: int, the message ID.

Returns a Message for a given message ID.

GetUser

  • Returns: User, the requested user.

  • Parameters: int, the user ID.

Returns a User for the given user ID.

PostMessage

  • Returns: Message, the message you have just posted.

  • Parameters: object the message to post (.ToString() is called).

Posts a new message in the room.

PostMessageLight

  • Returns: bool, true if the message was posted successfully, otherwise false.

  • Parameters: object, the message to post (.ToString() is called).

Posts a new message in the room (faster than PostMessage).

PostReply

  • Returns: Message, the message you have just posted.

  • Parameters:

  1. Message, the target message. Or; int, the target message's ID.

  2. object, the message to post (.ToString() is called).

Posts a message in the room in reply to another message.

PostReplyLight

  • Returns: bool, true if the message was posted successfully, otherwise false.

  • Parameters:

  1. Message, the target message. Or; int, the target message's ID.

  2. object, the message to post (.ToString() is called).

Posts a message in the room in reply to another message (faster than PostReply).

EditMessage

  • Returns: bool, true if the edit was successful, otherwise false.

  • Parameters:

  1. Message, the message to edit. Or; int, the ID of the message to edit.

  2. object, the text to which the message should be edited to (.ToString() is called).

Edits a message's text.

DeleteMessage

  • Returns: bool, true if the deletion was successful, otherwise false.

  • Parameters: Message, the message to delete. Or; int, the ID of the message.

Deletes a message.

ToggleStar

  • Returns: bool, true if toggling the message's star was successful, otherwise false.

  • Parameters: Message, the message to star/unstar. Or; int, the ID of the message.

Stars or unstars a message.

ClearMessageStars

  • Returns: bool, true if clearing the message's stars was successful, otherwise false.

  • Parameters: Message, the message to clear stars from. Or; int, the ID of the message.

Removes all stars from a message.

TogglePin

  • Returns: bool, true if toggling the message's pin was successful, otherwise false.

  • 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).

KickMute

  • Returns: bool, true if kicking the user was successful, otherwise false.

  • 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.

SetUserRoomAccess

  • Returns: bool, true if setting the user's new access level was successful, otherwise false.

  • Parameters:

  1. UserRoomAccess, the new access level to be assigned.

  2. 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.

Clone this wiki locally