A C E G I J K L N P R S T U

A

Authentication - Class in uk.gov.service.notify

Authentication() - Constructor for class uk.gov.service.notify.Authentication

C

create(String, String) - Method in class uk.gov.service.notify.Authentication

E

ENCODING - Static variable in class uk.gov.service.notify.Authentication

G

generateTemplatePreview(String, Map<String, Object>) - Method in class uk.gov.service.notify.NotificationClient

generateTemplatePreview(String, Map<String, Object>) - Method in interface uk.gov.service.notify.NotificationClientApi

The generateTemplatePreview returns a template with the placeholders replaced with the given personalisation.

getAllTemplates(String) - Method in class uk.gov.service.notify.NotificationClient

getAllTemplates(String) - Method in interface uk.gov.service.notify.NotificationClientApi

Returns all the templates for your service.

getApiKey() - Method in class uk.gov.service.notify.NotificationClient

getBaseUrl() - Method in class uk.gov.service.notify.NotificationClient

getBody() - Method in class uk.gov.service.notify.Notification

getBody() - Method in class uk.gov.service.notify.SendEmailResponse

getBody() - Method in class uk.gov.service.notify.SendLetterResponse

getBody() - Method in class uk.gov.service.notify.SendSmsResponse

getBody() - Method in class uk.gov.service.notify.Template

getBody() - Method in class uk.gov.service.notify.TemplatePreview

getCompletedAt() - Method in class uk.gov.service.notify.Notification

getContent() - Method in class uk.gov.service.notify.ReceivedTextMessage

getCreatedAt() - Method in class uk.gov.service.notify.Notification

getCreatedAt() - Method in class uk.gov.service.notify.ReceivedTextMessage

getCreatedAt() - Method in class uk.gov.service.notify.Template

getCreatedBy() - Method in class uk.gov.service.notify.Template

getCreatedByName() - Method in class uk.gov.service.notify.Notification

getCurrentPageLink() - Method in class uk.gov.service.notify.NotificationList

getCurrentPageLink() - Method in class uk.gov.service.notify.ReceivedTextMessageList

getData() - Method in class uk.gov.service.notify.LetterResponse

getEmailAddress() - Method in class uk.gov.service.notify.Notification

getEstimatedDelivery() - Method in class uk.gov.service.notify.Notification

estimatedDelivery is only present on letters

getFromEmail() - Method in class uk.gov.service.notify.SendEmailResponse

getFromNumber() - Method in class uk.gov.service.notify.SendSmsResponse

getHtml() - Method in class uk.gov.service.notify.TemplatePreview

getHttpResult() - Method in exception uk.gov.service.notify.NotificationClientException

getId() - Method in class uk.gov.service.notify.Notification

getId() - Method in class uk.gov.service.notify.ReceivedTextMessage

getId() - Method in class uk.gov.service.notify.Template

getId() - Method in class uk.gov.service.notify.TemplatePreview

getLine1() - Method in class uk.gov.service.notify.Notification

getLine2() - Method in class uk.gov.service.notify.Notification

getLine3() - Method in class uk.gov.service.notify.Notification

getLine4() - Method in class uk.gov.service.notify.Notification

getLine5() - Method in class uk.gov.service.notify.Notification

getLine6() - Method in class uk.gov.service.notify.Notification

getName() - Method in class uk.gov.service.notify.Template

getNextPageLink() - Method in class uk.gov.service.notify.NotificationList

getNextPageLink() - Method in class uk.gov.service.notify.ReceivedTextMessageList

getNotificationById(String) - Method in class uk.gov.service.notify.NotificationClient

getNotificationById(String) - Method in interface uk.gov.service.notify.NotificationClientApi

The getNotificationById method will return a Notification for a given notification id.

getNotificationId() - Method in class uk.gov.service.notify.LetterResponse

getNotificationId() - Method in class uk.gov.service.notify.SendEmailResponse

getNotificationId() - Method in class uk.gov.service.notify.SendSmsResponse

getNotifications(String, String, String, String) - Method in class uk.gov.service.notify.NotificationClient

getNotifications(String, String, String, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The getNotifications method will create a GET HTTPS request to retrieve all the notifications.

getNotifications() - Method in class uk.gov.service.notify.NotificationList

getNotificationType() - Method in class uk.gov.service.notify.Notification

getNotifyNumber() - Method in class uk.gov.service.notify.ReceivedTextMessage

getPdfForLetter(String) - Method in class uk.gov.service.notify.NotificationClient

getPdfForLetter(String) - Method in interface uk.gov.service.notify.NotificationClientApi

The getPdfForLetter method will return a byte[] containing the PDF contents of a given letter notification.

getPersonalisation() - Method in class uk.gov.service.notify.Template

getPhoneNumber() - Method in class uk.gov.service.notify.Notification

getPostage() - Method in class uk.gov.service.notify.LetterResponse

getPostage() - Method in class uk.gov.service.notify.Notification

getPostcode() - Method in class uk.gov.service.notify.Notification

getProxy() - Method in class uk.gov.service.notify.NotificationClient

getReceivedTextMessages(String) - Method in class uk.gov.service.notify.NotificationClient

getReceivedTextMessages(String) - Method in interface uk.gov.service.notify.NotificationClientApi

The getReceivedTextMessages returns a list of ReceivedTextMessage, the list is sorted by createdAt descending.

getReceivedTextMessages() - Method in class uk.gov.service.notify.ReceivedTextMessageList

getReference() - Method in class uk.gov.service.notify.LetterResponse

getReference() - Method in class uk.gov.service.notify.Notification

getReference() - Method in class uk.gov.service.notify.SendEmailResponse

getReference() - Method in class uk.gov.service.notify.SendSmsResponse

getSentAt() - Method in class uk.gov.service.notify.Notification

getServiceId() - Method in class uk.gov.service.notify.NotificationClient

getServiceId() - Method in class uk.gov.service.notify.ReceivedTextMessage

getStatus() - Method in class uk.gov.service.notify.Notification

getSubject() - Method in class uk.gov.service.notify.Notification

getSubject() - Method in class uk.gov.service.notify.SendEmailResponse

getSubject() - Method in class uk.gov.service.notify.SendLetterResponse

getSubject() - Method in class uk.gov.service.notify.Template

getSubject() - Method in class uk.gov.service.notify.TemplatePreview

getTemplateById(String) - Method in class uk.gov.service.notify.NotificationClient

getTemplateById(String) - Method in interface uk.gov.service.notify.NotificationClientApi

The getTemplateById returns a Template given the template id.

getTemplateId() - Method in class uk.gov.service.notify.Notification

getTemplateId() - Method in class uk.gov.service.notify.SendEmailResponse

getTemplateId() - Method in class uk.gov.service.notify.SendLetterResponse

getTemplateId() - Method in class uk.gov.service.notify.SendSmsResponse

getTemplates() - Method in class uk.gov.service.notify.TemplateList

getTemplateType() - Method in class uk.gov.service.notify.Template

getTemplateType() - Method in class uk.gov.service.notify.TemplatePreview

getTemplateUri() - Method in class uk.gov.service.notify.Notification

getTemplateUri() - Method in class uk.gov.service.notify.SendEmailResponse

getTemplateUri() - Method in class uk.gov.service.notify.SendLetterResponse

getTemplateUri() - Method in class uk.gov.service.notify.SendSmsResponse

getTemplateVersion() - Method in class uk.gov.service.notify.Notification

getTemplateVersion(String, int) - Method in class uk.gov.service.notify.NotificationClient

getTemplateVersion(String, int) - Method in interface uk.gov.service.notify.NotificationClientApi

The getTemplateVersion returns a Template given the template id and version.

getTemplateVersion() - Method in class uk.gov.service.notify.SendEmailResponse

getTemplateVersion() - Method in class uk.gov.service.notify.SendLetterResponse

getTemplateVersion() - Method in class uk.gov.service.notify.SendSmsResponse

getUpdatedAt() - Method in class uk.gov.service.notify.Template

getUserAgent() - Method in class uk.gov.service.notify.NotificationClient

getUserNumber() - Method in class uk.gov.service.notify.ReceivedTextMessage

getVersion() - Method in class uk.gov.service.notify.Template

getVersion() - Method in class uk.gov.service.notify.TemplatePreview

I

isBase64StringPDF(String) - Static method in class uk.gov.service.notify.PdfUtils

A method to determine if a file is a pdf file

J

jsonToList(JSONArray) - Static method in class uk.gov.service.notify.JsonUtils

jsonToMap(JSONObject) - Static method in class uk.gov.service.notify.JsonUtils

JsonUtils - Class in uk.gov.service.notify

JsonUtils() - Constructor for class uk.gov.service.notify.JsonUtils

K

keyFromString(String) - Static method in class uk.gov.service.notify.Authentication

L

LetterResponse - Class in uk.gov.service.notify

LetterResponse(String) - Constructor for class uk.gov.service.notify.LetterResponse

N

Notification - Class in uk.gov.service.notify

Notification(String) - Constructor for class uk.gov.service.notify.Notification

Notification(JSONObject) - Constructor for class uk.gov.service.notify.Notification

NotificationClient - Class in uk.gov.service.notify

NotificationClient(String) - Constructor for class uk.gov.service.notify.NotificationClient

This client constructor given the api key.

NotificationClient(String, Proxy) - Constructor for class uk.gov.service.notify.NotificationClient

Use this client constructor if you require a proxy for https requests.

NotificationClient(String, String) - Constructor for class uk.gov.service.notify.NotificationClient

This client constructor is used for testing on other environments, used by the GOV.UK Notify team.

NotificationClient(String, String, Proxy) - Constructor for class uk.gov.service.notify.NotificationClient

NotificationClient(String, String, Proxy, SSLContext) - Constructor for class uk.gov.service.notify.NotificationClient

NotificationClientApi - Interface in uk.gov.service.notify

NotificationClientException - Exception in uk.gov.service.notify

NotificationClientException(Exception) - Constructor for exception uk.gov.service.notify.NotificationClientException

NotificationClientException(String) - Constructor for exception uk.gov.service.notify.NotificationClientException

NotificationClientException(String, Throwable) - Constructor for exception uk.gov.service.notify.NotificationClientException

NotificationList - Class in uk.gov.service.notify

NotificationList(String) - Constructor for class uk.gov.service.notify.NotificationList

P

PdfUtils - Class in uk.gov.service.notify

PdfUtils() - Constructor for class uk.gov.service.notify.PdfUtils

prepareUpload(byte[]) - Static method in class uk.gov.service.notify.NotificationClient

Use the prepareUpload method when uploading a document via sendEmail.

R

ReceivedTextMessage - Class in uk.gov.service.notify

ReceivedTextMessage(String) - Constructor for class uk.gov.service.notify.ReceivedTextMessage

ReceivedTextMessage(JSONObject) - Constructor for class uk.gov.service.notify.ReceivedTextMessage

ReceivedTextMessageList - Class in uk.gov.service.notify

ReceivedTextMessageList(String) - Constructor for class uk.gov.service.notify.ReceivedTextMessageList

S

sendEmail(String, String, Map<String, ?>, String) - Method in class uk.gov.service.notify.NotificationClient

sendEmail(String, String, Map<String, ?>, String, String) - Method in class uk.gov.service.notify.NotificationClient

sendEmail(String, String, Map<String, ?>, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendEmail method will create an HTTPS POST request.

sendEmail(String, String, Map<String, ?>, String, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendEmail method will create an HTTPS POST request.

SendEmailResponse - Class in uk.gov.service.notify

SendEmailResponse(String) - Constructor for class uk.gov.service.notify.SendEmailResponse

sendLetter(String, Map<String, ?>, String) - Method in class uk.gov.service.notify.NotificationClient

sendLetter(String, Map<String, ?>, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendLetter method will create an HTTPS POST request.

SendLetterResponse - Class in uk.gov.service.notify

SendLetterResponse(String) - Constructor for class uk.gov.service.notify.SendLetterResponse

sendPrecompiledLetter(String, File) - Method in class uk.gov.service.notify.NotificationClient

sendPrecompiledLetter(String, File, String) - Method in class uk.gov.service.notify.NotificationClient

sendPrecompiledLetter(String, File) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendPrecompiledLetter method will create an HTTPS POST request.

sendPrecompiledLetter(String, File, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendPrecompiledLetter method will create an HTTPS POST request.

sendPrecompiledLetterWithInputStream(String, InputStream) - Method in class uk.gov.service.notify.NotificationClient

sendPrecompiledLetterWithInputStream(String, InputStream, String) - Method in class uk.gov.service.notify.NotificationClient

sendPrecompiledLetterWithInputStream(String, InputStream) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendPrecompiledLetterWithInputStream method will create an HTTPS POST request.

sendPrecompiledLetterWithInputStream(String, InputStream, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendPrecompiledLetterWithInputStream method will create an HTTPS POST request.

sendSms(String, String, Map<String, ?>, String) - Method in class uk.gov.service.notify.NotificationClient

sendSms(String, String, Map<String, ?>, String, String) - Method in class uk.gov.service.notify.NotificationClient

sendSms(String, String, Map<String, ?>, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendSms method will create an HTTPS POST request.

sendSms(String, String, Map<String, ?>, String, String) - Method in interface uk.gov.service.notify.NotificationClientApi

The sendSms method will create an HTTPS POST request.

SendSmsResponse - Class in uk.gov.service.notify

SendSmsResponse(String) - Constructor for class uk.gov.service.notify.SendSmsResponse

setBody(String) - Method in class uk.gov.service.notify.Template

setBody(String) - Method in class uk.gov.service.notify.TemplatePreview

setCreatedAt(DateTime) - Method in class uk.gov.service.notify.Template

setCreatedBy(String) - Method in class uk.gov.service.notify.Template

setHtml(String) - Method in class uk.gov.service.notify.TemplatePreview

setId(UUID) - Method in class uk.gov.service.notify.Template

setId(UUID) - Method in class uk.gov.service.notify.TemplatePreview

setName(String) - Method in class uk.gov.service.notify.Template

setPersonalisation(Map<String, Object>) - Method in class uk.gov.service.notify.Template

setSubject(String) - Method in class uk.gov.service.notify.Template

setSubject(String) - Method in class uk.gov.service.notify.TemplatePreview

setTemplateType(String) - Method in class uk.gov.service.notify.Template

setTemplateType(String) - Method in class uk.gov.service.notify.TemplatePreview

setUpdatedAt(DateTime) - Method in class uk.gov.service.notify.Template

setVersion(int) - Method in class uk.gov.service.notify.Template

setVersion(int) - Method in class uk.gov.service.notify.TemplatePreview

T

Template - Class in uk.gov.service.notify

Template(String) - Constructor for class uk.gov.service.notify.Template

Template(JSONObject) - Constructor for class uk.gov.service.notify.Template

TemplateList - Class in uk.gov.service.notify

TemplateList(String) - Constructor for class uk.gov.service.notify.TemplateList

TemplatePreview - Class in uk.gov.service.notify

TemplatePreview(String) - Constructor for class uk.gov.service.notify.TemplatePreview

TemplatePreview(JSONObject) - Constructor for class uk.gov.service.notify.TemplatePreview

toString() - Method in class uk.gov.service.notify.LetterResponse

toString() - Method in class uk.gov.service.notify.Notification

toString() - Method in class uk.gov.service.notify.NotificationList

toString() - Method in class uk.gov.service.notify.SendEmailResponse

toString() - Method in class uk.gov.service.notify.SendLetterResponse

toString() - Method in class uk.gov.service.notify.SendSmsResponse

toString() - Method in class uk.gov.service.notify.Template

toString() - Method in class uk.gov.service.notify.TemplateList

toString() - Method in class uk.gov.service.notify.TemplatePreview

tryToGetString(JSONObject, String) - Method in class uk.gov.service.notify.LetterResponse

U

uk.gov.service.notify - package uk.gov.service.notify

A C E G I J K L N P R S T U