org.ow2.proactive.notification.client.api

Class ChannelRestApi

java.lang.Object

org.ow2.proactive.notification.client.api.ChannelRestApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-02-12T14:56:03.264844-05:00[America/New_York]")
public class ChannelRestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ChannelRestApi()
ChannelRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Channel	createChannel(String sessionid, ChannelRequest channelRequest) Creates a new channel
ApiResponse<Channel>	createChannelWithHttpInfo(String sessionid, ChannelRequest channelRequest) Creates a new channel
Channel	deleteChannel(String sessionid, Long id) Deletes a channels
ApiResponse<Channel>	deleteChannelWithHttpInfo(String sessionid, Long id) Deletes a channels
ApiClient	getApiClient() Get the API client
List<Channel>	getUserAvailableChannels(String sessionid) Gets channels that user can subscribe to
ApiResponse<List<Channel>>	getUserAvailableChannelsWithHttpInfo(String sessionid) Gets channels that user can subscribe to
List<Channel>	getUserManageableChannels(String sessionid) Gets channels that user can update and delete
ApiResponse<List<Channel>>	getUserManageableChannelsWithHttpInfo(String sessionid) Gets channels that user can update and delete
void	setApiClient(ApiClient apiClient) Set the API client
Channel	updateChannel(String sessionid, ChannelUpdate channelUpdate) Updates a channels
ApiResponse<Channel>	updateChannelWithHttpInfo(String sessionid, ChannelUpdate channelUpdate) Updates a channels

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelRestApi

public ChannelRestApi()

ChannelRestApi

public ChannelRestApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

createChannel

public Channel createChannel(String sessionid,
                             ChannelRequest channelRequest)
                      throws ApiException

Creates a new channel

Parameters:

sessionid - (required)

channelRequest - (required)

Returns:

Channel

Throws:

ApiException - if fails to make API call

createChannelWithHttpInfo

public ApiResponse<Channel> createChannelWithHttpInfo(String sessionid,
                                                      ChannelRequest channelRequest)
                                               throws ApiException

Creates a new channel

Parameters:

sessionid - (required)

channelRequest - (required)

Returns:

ApiResponse<Channel>

Throws:

ApiException - if fails to make API call

deleteChannel

public Channel deleteChannel(String sessionid,
                             Long id)
                      throws ApiException

Deletes a channels

Parameters:

sessionid - (required)

id - (required)

Returns:

Channel

Throws:

ApiException - if fails to make API call

deleteChannelWithHttpInfo

public ApiResponse<Channel> deleteChannelWithHttpInfo(String sessionid,
                                                      Long id)
                                               throws ApiException

Deletes a channels

Parameters:

sessionid - (required)

id - (required)

Returns:

ApiResponse<Channel>

Throws:

ApiException - if fails to make API call

getUserAvailableChannels

public List<Channel> getUserAvailableChannels(String sessionid)
                                       throws ApiException

Gets channels that user can subscribe to

Parameters:

sessionid - (required)

Returns:

List<Channel>

Throws:

ApiException - if fails to make API call

getUserAvailableChannelsWithHttpInfo

public ApiResponse<List<Channel>> getUserAvailableChannelsWithHttpInfo(String sessionid)
                                                                throws ApiException

Gets channels that user can subscribe to

Parameters:

sessionid - (required)

Returns:

ApiResponse<List<Channel>>

Throws:

ApiException - if fails to make API call

getUserManageableChannels

public List<Channel> getUserManageableChannels(String sessionid)
                                        throws ApiException

Gets channels that user can update and delete

Parameters:

sessionid - (required)

Returns:

List<Channel>

Throws:

ApiException - if fails to make API call

getUserManageableChannelsWithHttpInfo

public ApiResponse<List<Channel>> getUserManageableChannelsWithHttpInfo(String sessionid)
                                                                 throws ApiException

Gets channels that user can update and delete

Parameters:

sessionid - (required)

Returns:

ApiResponse<List<Channel>>

Throws:

ApiException - if fails to make API call

updateChannel

public Channel updateChannel(String sessionid,
                             ChannelUpdate channelUpdate)
                      throws ApiException

Updates a channels

Parameters:

sessionid - (required)

channelUpdate - (required)

Returns:

Channel

Throws:

ApiException - if fails to make API call

updateChannelWithHttpInfo

public ApiResponse<Channel> updateChannelWithHttpInfo(String sessionid,
                                                      ChannelUpdate channelUpdate)
                                               throws ApiException

Updates a channels

Parameters:

sessionid - (required)

channelUpdate - (required)

Returns:

ApiResponse<Channel>

Throws:

ApiException - if fails to make API call