Skip to content

Latest commit

 

History

History
281 lines (205 loc) · 4.6 KB

USAGE.md

File metadata and controls

281 lines (205 loc) · 4.6 KB
Raw

Features

Initializing your client

client = guildr.Client()

This initializes a client for Portal usage.

Parameters:

  • log - Defaults to False

Returns:

  • A guildr client

Logging in

client.login(email = 'Your email', password = 'Your password')

This logs you into a given account.

Parameters:

  • email
  • password

Returns:

  • True - If login was successful
  • False - If login was unsuccessful
  • Json response

Logging out

client.logout()

This logs you out of the current account. When logging out, Guilded relys on the current cookies to log out an account. To have a successful log out, make sure your cookies and updated.

Parameters:

  • None

Returns:

  • True - If logout was successful
  • False - If logout was unsuccessful
  • Json response

Get the users ID

client.getUserID()

This gets the user ID of the current account.

Parameters:

  • None

Returns:

  • The user's ID if successful
  • The Json response if unsuccessful

Get the users team role IDs

client.getTeamRoleIDs()

This gets the team role IDs of the current account.

Parameters:

  • None

Returns:

  • The user's team role ID if successful
  • The Json response if unsuccessful

Get the users home server ID

client.getHomeServerID()

This gets the home server ID of the current account.

Parameters:

  • None

Returns:

  • The user's home server ID if successful
  • The Json response if unsuccessful

Create a guild

client.createGuild(serverName = 'Name of server', isPublic = True)

This creates a guild.

Parameters:

  • serverName - The name of the server
  • isPublic - If the guild should be public or not (Defaults to True)

Returns:

  • Json response

Leave a guild

client.leaveGuild(guildID = 'ID of guild')

This leaves a guild.

Parameters:

  • guildID - ID of the guild to leave

Returns:

  • Json response

Archive a guild

client.archiveGuild(guildID = 'ID of guild')

This archives a guild.

Parameters:

  • guildID - ID of the guild to archive

Returns:

  • Json response

Delete a guild

client.deleteGuild(guildID = 'ID of guild')

This deletes a guild.

Parameters:

  • guildID - ID of the guild to delete

Returns:

  • Json response

Change name

client.changeName(name = 'New username')

This changes the current accounts username.

Parameters:

  • name - New username to change to

Returns:

  • Json response

Change tag line

client.changeTagLine(tagline = 'New tagline')

This changes the current accounts tagline.

Parameters:

  • tagline - New tagline to change to

Returns:

  • Json response

Change profile picture

client.changePFP(pfp = 'location/of/image')

This changes the current accounts profile picture.

Parameters:

  • pfp - New picture to change to

Returns:

  • Json response

Change status

client.changeStatus(status = 'New status')

This changes the current accounts status.

Parameters:

  • status - New status to change to

Returns:

  • Json response

Use legacy mode

client.useLegacyMode(use = True)

This changes the accounts layout to legacy mode.

Parameters:

  • use - True of False (Defaults to False)

Returns:

  • Json response

Send friend request

client.sendFriendRequest(userID = 'ID of user to request')

This sends a friend request to a given user ID.

Parameters:

  • userID - ID of the user to send a friend request to

Returns:

  • Json response

Send a channel message

client.sendMessage(channelID = 'ID of channel', message = 'Message to send', isSilent = False, isPrivate = False)

This sends a message to a given channel.

Parameters:

  • channelID - ID of the channel to send a message in
  • message - Message to send in channel
  • isSilent - If the message sent should ping the user (Defaults to False)
  • isPrivate - If the message sent should be sent privately (Defaults to False)

Returns:

  • Json response

Send a DM

client.sendDM(targetID = 'ID of user to send DM to', message = 'Message to DM')

This sends a DM to a given user.

Parameters:

  • targetID - ID of a user to send the dm to
  • message - Message to send to the user

Returns:

  • Json response

Create an account - soon

client.register(username = 'Username', email = 'Email', password = 'Password')

This creates an account.

Parameters:

  • username - Username of the account
  • email - Email of the account
  • password - Password of the account

Returns:

  • Json response