Skip to content

Client Actions

Dominique Debergue edited this page Jan 12, 2019 · 19 revisions

The gopherClient.connect() function is one of many actions the client can send to the server. Here, I will list all client actions linked to the section that describes it's usage:

  • connect(): Connects the client to the server
  • disconnect(): Disconnects the client from the server
  • login(): Logs the client in as a User
  • logout(): Logs the client out of a User
  • signup(): Creates a User account
  • changePassword(): Changes the client User's account password
  • changeAccountInfo(): Changes one or more client User's custom account info columns
  • deleteAccount(): Deletes a User account
  • joinRoom(): Makes the client User join an existing room
  • leaveRoom(): Makes the client User leave their current room
  • createRoom(): Creates a room
  • deleteRoom(): Deletes a room created by the client User
  • sendInvite(): Sends an invite to another User to the client's private room
  • revokeInvite(): Revokes a previously sent invite to the client's private room
  • chatMessage(): Sends a chat message to the client User's current room
  • privateMessage(): Sends a private message from the client User to another User
  • requestFriend(): Sends a friend request from the client User to another User
  • acceptFriend(): Accepts a friend request to the client User from another User
  • declineFriend(): Declines a friend request to the client User from another User
  • removeFriend(): Removes a friend from the client User's friend list
  • changeStatus(): Changes the client User's status and sends update to their friends
  • setUserVariable(): Sets a single client User's variable
  • setUserVariables(): Sets multiple client User's variables
  • getUserVariable(): Gets a single client User's variable (API retrieves from RAM, not server)
  • customClientAction(): Executes a custom client action on the server

Login & Logout

Logging the client in and out is easy. Just use the gopherClient.login() and gopherClient.logout() functions:

gopherClient.login("name", "", false, false);
gopherClient.logout();

If you notice there is lacking information, missing features, or bad explanations, please open an issue. All requests are acceptable and will be taken into consideration, so don't be afraid to ask or report something!

Clone this wiki locally