org.mozilla.taskcluster.client.notify

Class Notify

java.lang.Object

org.mozilla.taskcluster.client.TaskclusterRequestHandler

org.mozilla.taskcluster.client.notify.Notify

public class Notify
extends TaskclusterRequestHandler

The notification service, typically available at notify.taskcluster.net listens for tasks with associated notifications and handles requests to send emails and post pulse messages.

See Also:

Notify API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Notify()
Notify(Credentials credentials)
Notify(Credentials credentials, String baseURL)
Notify(String baseURL)
Notify(String clientId, String accessToken)
Notify(String clientId, String accessToken, String certificate)

Method Summary

Modifier and Type	Method and Description
CallSummary<SendEmailRequest,EmptyPayload>	email(SendEmailRequest payload) Send an email to address.
CallSummary<Object,EmptyPayload>	irc(Object payload) Post a message on IRC to a specific channel or user, or a specific user on a specific channel.
CallSummary<EmptyPayload,EmptyPayload>	ping() Respond without doing anything.
CallSummary<PostPulseMessageRequest,EmptyPayload>	pulse(PostPulseMessageRequest payload) Publish a message on pulse with the given routingKey.

Methods inherited from class org.mozilla.taskcluster.client.TaskclusterRequestHandler

apiCall, setBaseURL, uriEncode

Methods inherited from class java.lang.Object

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

Field Detail

defaultBaseURL

protected static final String defaultBaseURL

See Also:

Constant Field Values

Constructor Detail

Notify

public Notify(Credentials credentials)

Notify

public Notify(Credentials credentials,
              String baseURL)

Notify

public Notify(String clientId,
              String accessToken)

Notify

public Notify(String clientId,
              String accessToken,
              String certificate)

Notify

public Notify(String baseURL)

Notify

public Notify()

Method Detail

ping

public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure

Respond without doing anything. This endpoint is used to check that the service is up.

Throws:

APICallFailure

See Also:

Ping Server API Documentation

email

public CallSummary<SendEmailRequest,EmptyPayload> email(SendEmailRequest payload)
                                                 throws APICallFailure

Send an email to address. The content is markdown and will be rendered to HTML, but both the HTML and raw markdown text will be sent in the email. If a link is included, it will be rendered to a nice button in the HTML version of the email

Required scopes: notify:email:

Throws:

APICallFailure

See Also:

Send an Email API Documentation

pulse

public CallSummary<PostPulseMessageRequest,EmptyPayload> pulse(PostPulseMessageRequest payload)
                                                        throws APICallFailure

Publish a message on pulse with the given routingKey.

Required scopes: notify:pulse:

Throws:

APICallFailure

See Also:

Publish a Pulse Message API Documentation

irc

public CallSummary<Object,EmptyPayload> irc(Object payload)
                                     throws APICallFailure

Post a message on IRC to a specific channel or user, or a specific user on a specific channel.

Success of this API method does not imply the message was successfully posted. This API method merely inserts the IRC message into a queue that will be processed by a background process. This allows us to re-send the message in face of connection issues.

However, if the user isn’t online the message will be dropped without error. We maybe improve this behavior in the future. For now just keep in mind that IRC is a best-effort service.

Required scopes: If channelRequest: notify:irc-channel:

Throws:

APICallFailure

See Also:

Post IRC Message API Documentation