| Modifier and Type | Method and Description |
|---|---|
TemplatePreview |
NotificationClientApi.generateTemplatePreview(String templateId,
Map<String,Object> personalisation)
The generateTemplatePreview returns a template with the placeholders replaced with the given personalisation.
|
TemplatePreview |
NotificationClient.generateTemplatePreview(String templateId,
Map<String,Object> personalisation) |
TemplateList |
NotificationClientApi.getAllTemplates(String templateType)
Returns all the templates for your service.
|
TemplateList |
NotificationClient.getAllTemplates(String templateType) |
Notification |
NotificationClientApi.getNotificationById(String notificationId)
The getNotificationById method will return a
Notification for a given notification id. |
Notification |
NotificationClient.getNotificationById(String notificationId) |
NotificationList |
NotificationClientApi.getNotifications(String status,
String notification_type,
String reference,
String olderThanId)
The getNotifications method will create a GET HTTPS request to retrieve all the notifications.
|
NotificationList |
NotificationClient.getNotifications(String status,
String notification_type,
String reference,
String olderThanId) |
byte[] |
NotificationClientApi.getPdfForLetter(String notificationId)
The getPdfForLetter method will return a
byte[] containing the PDF contents of a given letter notification. |
byte[] |
NotificationClient.getPdfForLetter(String notificationId) |
ReceivedTextMessageList |
NotificationClientApi.getReceivedTextMessages(String olderThanId)
The getReceivedTextMessages returns a list of
ReceivedTextMessage, the list is sorted by createdAt descending. |
ReceivedTextMessageList |
NotificationClient.getReceivedTextMessages(String olderThanId) |
Template |
NotificationClientApi.getTemplateById(String templateId)
The getTemplateById returns a
Template given the template id. |
Template |
NotificationClient.getTemplateById(String templateId) |
Template |
NotificationClientApi.getTemplateVersion(String templateId,
int version)
The getTemplateVersion returns a
Template given the template id and version. |
Template |
NotificationClient.getTemplateVersion(String templateId,
int version) |
static org.json.JSONObject |
NotificationClient.prepareUpload(byte[] documentContents)
Use the prepareUpload method when uploading a document via sendEmail.
|
SendEmailResponse |
NotificationClientApi.sendEmail(String templateId,
String emailAddress,
Map<String,?> personalisation,
String reference)
The sendEmail method will create an HTTPS POST request.
|
SendEmailResponse |
NotificationClient.sendEmail(String templateId,
String emailAddress,
Map<String,?> personalisation,
String reference) |
SendEmailResponse |
NotificationClientApi.sendEmail(String templateId,
String emailAddress,
Map<String,?> personalisation,
String reference,
String emailReplyToId)
The sendEmail method will create an HTTPS POST request.
|
SendEmailResponse |
NotificationClient.sendEmail(String templateId,
String emailAddress,
Map<String,?> personalisation,
String reference,
String emailReplyToId) |
SendLetterResponse |
NotificationClientApi.sendLetter(String templateId,
Map<String,?> personalisation,
String reference)
The sendLetter method will create an HTTPS POST request.
|
SendLetterResponse |
NotificationClient.sendLetter(String templateId,
Map<String,?> personalisation,
String reference) |
LetterResponse |
NotificationClientApi.sendPrecompiledLetter(String reference,
File precompiledPDF)
The sendPrecompiledLetter method will create an HTTPS POST request.
|
LetterResponse |
NotificationClient.sendPrecompiledLetter(String reference,
File precompiledPDF) |
LetterResponse |
NotificationClientApi.sendPrecompiledLetter(String reference,
File precompiledPDF,
String postage)
The sendPrecompiledLetter method will create an HTTPS POST request.
|
LetterResponse |
NotificationClient.sendPrecompiledLetter(String reference,
File precompiledPDF,
String postage) |
LetterResponse |
NotificationClientApi.sendPrecompiledLetterWithInputStream(String reference,
InputStream stream)
The sendPrecompiledLetterWithInputStream method will create an HTTPS POST request.
|
LetterResponse |
NotificationClient.sendPrecompiledLetterWithInputStream(String reference,
InputStream stream) |
LetterResponse |
NotificationClientApi.sendPrecompiledLetterWithInputStream(String reference,
InputStream stream,
String postage)
The sendPrecompiledLetterWithInputStream method will create an HTTPS POST request.
|
LetterResponse |
NotificationClient.sendPrecompiledLetterWithInputStream(String reference,
InputStream stream,
String postage) |
SendSmsResponse |
NotificationClientApi.sendSms(String templateId,
String phoneNumber,
Map<String,?> personalisation,
String reference)
The sendSms method will create an HTTPS POST request.
|
SendSmsResponse |
NotificationClient.sendSms(String templateId,
String phoneNumber,
Map<String,?> personalisation,
String reference) |
SendSmsResponse |
NotificationClientApi.sendSms(String templateId,
String phoneNumber,
Map<String,?> personalisation,
String reference,
String smsSenderId)
The sendSms method will create an HTTPS POST request.
|
SendSmsResponse |
NotificationClient.sendSms(String templateId,
String phoneNumber,
Map<String,?> personalisation,
String reference,
String smsSenderId) |
Copyright © 2019. All rights reserved.