jenkins.plugins.rocketchatnotifier.rocket

Interface RocketChatClient

All Known Implementing Classes:

LegacyRocketChatClient, RocketChatClientImpl

public interface RocketChatClient

API used by this Jenkins plugin to communicate to RocketChat server backend

Author:

Martin Reinhardt (hypery2k)

Method Summary

Modifier and Type	Method and Description
Room[]	getChannels()
User	getUser(String userId) Retrieves a User from the Rocket.Chat server.
User[]	getUsers() Gets all of the users from a Rocket.Chat server, if you have a ton this will take some time.
void	send(Room room, String message) sends a message to a channel
void	send(String channelName, String message) sends a message to a channel

Method Detail

getUsers

User[] getUsers()
         throws IOException

Gets all of the users from a Rocket.Chat server, if you have a ton this will take some time.

Returns:

an array of Users

Throws:

IOException - is thrown if there was a problem connecting, including if the result wasn't successful

getUser

User getUser(String userId)
      throws IOException

Retrieves a User from the Rocket.Chat server.

Parameters:

userId - of the user to retrieve

Returns:

an instance of the User

Throws:

IOException - is thrown if there was a problem connecting, including if the result wasn't successful or there is no user

getChannels

Room[] getChannels()
            throws IOException

Returns:

an array of channels as room object

Throws:

IOException - in case of communication errors with the RocketChat server backend

send

void send(Room room,
          String message)
   throws sun.security.validator.ValidatorException,
          IOException

sends a message to a channel

Parameters:

room - to use (aka channel)

message - to send

Throws:

sun.security.validator.ValidatorException - in case of SSL errors

IOException - in case of communication errors with the RocketChat server backend

send

void send(String channelName,
          String message)
   throws sun.security.validator.ValidatorException,
          IOException

sends a message to a channel

Parameters:

channelName - to use

message - to send

Throws:

sun.security.validator.ValidatorException - in case of SSL errors

IOException - in case of communication errors with the RocketChat server backend