jenkins.plugins.rocketchatnotifier.rocket

Enum RocketChatRestApiV1

java.lang.Object

java.lang.Enum<RocketChatRestApiV1>

jenkins.plugins.rocketchatnotifier.rocket.RocketChatRestApiV1

All Implemented Interfaces:

Serializable, Comparable<RocketChatRestApiV1>

public enum RocketChatRestApiV1
extends Enum<RocketChatRestApiV1>

Enumeration of the available REST API methods.

Since:

0.1.0

Version:

0.0.1

Author:

Bradley Hilton (graywolf336)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ChannelsInfo Retrieves a list of all the channels in the server.
ChannelsList Retrieves a list of all the channels in the server.
PostMessage Retrieves a list of all the channels in the server.
UsersInfo Retrieves the user information from the server.
UsersList Retrieves a list of all the users in the server.

Method Summary

Modifier and Type	Method and Description
HttpMethods	getHttpMethod() Gets the http method which should be used.
String	getMethodName() Gets the method name to be called to the server.
boolean	requiresAuth() Check whether the method requires authentication or not.
static RocketChatRestApiV1	valueOf(String name) Returns the enum constant of this type with the specified name.
static RocketChatRestApiV1[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UsersList

public static final RocketChatRestApiV1 UsersList

Retrieves a list of all the users in the server.

UsersInfo

public static final RocketChatRestApiV1 UsersInfo

Retrieves the user information from the server.

ChannelsList

public static final RocketChatRestApiV1 ChannelsList

Retrieves a list of all the channels in the server.

ChannelsInfo

public static final RocketChatRestApiV1 ChannelsInfo

Retrieves a list of all the channels in the server.

PostMessage

public static final RocketChatRestApiV1 PostMessage

Retrieves a list of all the channels in the server.

Method Detail

values

public static RocketChatRestApiV1[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RocketChatRestApiV1 c : RocketChatRestApiV1.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RocketChatRestApiV1 valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMethodName

public String getMethodName()

Gets the method name to be called to the server.

Returns:

the method name plus "v1/" at the start

getHttpMethod

public HttpMethods getHttpMethod()

Gets the http method which should be used.

Returns:

http method to be used

requiresAuth

public boolean requiresAuth()

Check whether the method requires authentication or not.

Returns:

whether this requires authentication or not