Package com.github.jamesnetherton.zulip.client.api.stream.request

Class GetStreamEmailAddressApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.stream.request.GetStreamEmailAddressApiRequest

All Implemented Interfaces:

ExecutableApiRequest<String>

public class GetStreamEmailAddressApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for getting the email address of a stream.

See Also:

• https://zulip.com/api/get-subscribers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SENDER_ID

Constructor Summary

Constructors

Constructor	Description
GetStreamEmailAddressApiRequest(ZulipHttpClient client, long streamId)	Constructs a GetStreamEmailAddressApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.
GetStreamEmailAddressApiRequest	withSenderId(long senderId)	Sets the ID of a user or bot which should appear as the sender when messages are sent to the channel using the returned channel email address.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

SENDER_ID

public static final String SENDER_ID

See Also:

• Constant Field Values

Constructor Details

GetStreamEmailAddressApiRequest

public GetStreamEmailAddressApiRequest(ZulipHttpClient client,
 long streamId)

Constructs a GetStreamEmailAddressApiRequest.

Parameters:

client - The Zulip HTTP client

streamId - The id of the stream to get the email address for

Method Details

withSenderId

public GetStreamEmailAddressApiRequest withSenderId(long senderId)

Sets the ID of a user or bot which should appear as the sender when messages are sent to the channel using the returned channel email address.

Parameters:

senderId - The ID of the user

Returns:

This GetStreamEmailAddressApiRequest instance

execute

public String execute()
               throws ZulipClientException

Description copied from interface: ExecutableApiRequest

Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The response for type T

Throws:

ZulipClientException - if an error occurs for the API request