Browse Source

add the new docs pages maybe?

tags/docs-0.9
Christopher F 9 years ago
parent
commit
3e3ae203a7
2 changed files with 75 additions and 0 deletions
  1. +53
    -0
      docs/features/server-management.rst
  2. +22
    -0
      docs/features/user-management.rst

+ 53
- 0
docs/features/server-management.rst View File

@@ -0,0 +1,53 @@
Server Management
=================

Discord.Net will allow you to manage most settings of a Discord server.

Usage
-----

You can create Channels, Invites, and Roles on a server using the CreateChannel, CreateInvite, and CreateRole function of a Server, respectively.

You may also edit a server's name, icon, and region.

.. code-block:: c#

// Create a Channel and retrieve the Channel object
var _channel = await _server.CreateChannel("announcements", ChannelType.Text);

// Create an Invite and retrieve the Invite object
var _invite = await _server.CreateInvite(maxAge: null, maxUses: 25, tempMembership: false, withXkcd: false);

// Create a Role and retrieve the Role object
var _role = await _server.CreateRole(name: "Bots", permissions: null, color: Color.DarkMagenta, isHoisted: false);

// Edit a server
var _ioStream = new System.IO.StreamReader("clock-0500-1952.png").BaseStream
_server.Edit(name: "19:52 | UTC-05:00", region: "east", icon: _ioStream, iconType: ImageType.Png);

// Prune Users
var _pruneCount = await _server.PruneUsers(30, true);

Invite Parameters
-----------------

maxAge: The time (in seconds) until the invite expires. Use null for infinite.
maxUses: The maximum amount of uses the invite has before it expires.
tempMembership: Whether or not to kick a user when they disconnect.
withXkcd: Generate the invite with an XKCD 936 style URL

Role Parameters
---------------

name: The name of the role
permissions: A set of ServerPermissions for the role to use by default
color: The color of the role, recommended to use Discord.Color
isHoisted: Whether a role's users should be displayed separately from other users in the user list.

Edit Parameters
---------------

name: The server's name
region: The region the voice server is hosted in
icon: A System.IO.Stream that will read an image file
iconType: The type of image being sent (png/jpeg).

+ 22
- 0
docs/features/user-management.rst View File

@@ -0,0 +1,22 @@
User Management
===============

Banning
-------

To ban a user, invoke the Ban function on a Server object.

.. code-block:: c#

_server.Ban(_user, 30);

The pruneDays parameter, which defaults to 0, will remove all messages from a user dating back to the specified amount of days.

Kicking
-------

To kick a user, invoke the Kick function on the User.

.. code-block:: c#

_user.Kick();

Loading…
Cancel
Save