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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionGetStreamEmailAddressApiRequest(ZulipHttpClient client, long streamId) Constructs aGetStreamEmailAddressApiRequest. -
Method Summary
Modifier and TypeMethodDescriptionexecute()Invokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.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 ZulipApiRequest
client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject
-
Field Details
-
SENDER_ID
- See Also:
-
-
Constructor Details
-
GetStreamEmailAddressApiRequest
Constructs aGetStreamEmailAddressApiRequest.- Parameters:
client- The Zulip HTTP clientstreamId- The id of the stream to get the email address for
-
-
Method Details
-
withSenderId
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
GetStreamEmailAddressApiRequestinstance
-
execute
Description copied from interface:ExecutableApiRequestInvokes the HTTP client to send the request to the Zulip REST API and returns a response as type T.- Specified by:
executein interfaceExecutableApiRequest<String>- Returns:
- The response for type T
- Throws:
ZulipClientException- if an error occurs for the API request
-