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

Class AddLinkifierApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.AddLinkifierApiRequest

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class AddLinkifierApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for adding a linkifier.

See Also:

• https://zulip.com/api/add-linkifier

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATTERN
static final String	URL_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
AddLinkifierApiRequest(ZulipHttpClient client, String pattern, String urlTemplate)	Constrtucts a AddLinkifierApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for adding a linkifier.

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

PATTERN

public static final String PATTERN

See Also:

• Constant Field Values

URL_TEMPLATE

public static final String URL_TEMPLATE

See Also:

• Constant Field Values

Constructor Details

AddLinkifierApiRequest

public AddLinkifierApiRequest(ZulipHttpClient client,
 String pattern,
 String urlTemplate)

Constrtucts a AddLinkifierApiRequest.

Parameters:

client - The Zulip HTTP client

pattern - The The regular expression that should trigger the linkifier

urlTemplate - The RFC 6570 compliant URL template used for the link

Method Details

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for adding a linkifier.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The id of the created linkifier

Throws:

ZulipClientException - if the request was not successful