com.github.messenger4j.send.MessengerSendClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of messenger4j Show documentation
The ultimate Java library for building Chatbots on the Facebook Messenger Platform
There is a newer version: 1.1.0
package com.github.messenger4j.send;

import com.github.messenger4j.exceptions.MessengerApiException;
import com.github.messenger4j.exceptions.MessengerIOException;
import com.github.messenger4j.send.templates.Template;
import java.util.List;

/**
 * @author Max Grabenhorst
 * @since 0.6.0
 */
public interface MessengerSendClient {

    /*
        SENDER_ACTION
     */
    MessengerResponse sendSenderAction(String recipientId, SenderAction senderAction)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendSenderAction(Recipient recipient, NotificationType notificationType, SenderAction senderAction)
            throws MessengerApiException, MessengerIOException;

    /*
        TEXT_MESSAGE
     */
    MessengerResponse sendTextMessage(String recipientId, String text)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTextMessage(String recipientId, String text, List quickReplies)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTextMessage(Recipient recipient, NotificationType notificationType, String text)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTextMessage(Recipient recipient, NotificationType notificationType, String text,
                                      List quickReplies)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTextMessage(Recipient recipient, NotificationType notificationType, String text,
                                      String metadata)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTextMessage(Recipient recipient, NotificationType notificationType, String text,
                                      List quickReplies, String metadata)
            throws MessengerApiException, MessengerIOException;

    /*
        IMAGE_ATTACHMENT
     */
    MessengerResponse sendImageAttachment(String recipientId, String imageUrl)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendImageAttachment(String recipientId, String imageUrl, List quickReplies)
            throws MessengerApiException, MessengerIOException;

    /*
        AUDIO_ATTACHMENT
     */
    MessengerResponse sendAudioAttachment(String recipientId, String audioUrl)
            throws MessengerApiException, MessengerIOException;

    /*
        VIDEO_ATTACHMENT
     */
    MessengerResponse sendVideoAttachment(String recipientId, String videoUrl)
            throws MessengerApiException, MessengerIOException;

    /*
        FILE_ATTACHMENT
     */
    MessengerResponse sendFileAttachment(String recipientId, String fileUrl)
            throws MessengerApiException, MessengerIOException;

    /*
        BINARY_ATTACHMENT
    */
    MessengerResponse sendBinaryAttachment(String recipientId, BinaryAttachment binaryAttachment)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendBinaryAttachment(Recipient recipient, NotificationType notificationType,
                                           BinaryAttachment binaryAttachment)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendBinaryAttachment(Recipient recipient, NotificationType notificationType,
                                           BinaryAttachment binaryAttachment, List quickReplies)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendBinaryAttachment(Recipient recipient, NotificationType notificationType,
                                           BinaryAttachment binaryAttachment, String metadata)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendBinaryAttachment(Recipient recipient, NotificationType notificationType,
                                           BinaryAttachment binaryAttachment, List quickReplies,
                                           String metadata)
            throws MessengerApiException, MessengerIOException;

    /*
        TEMPLATE
     */
    MessengerResponse sendTemplate(String recipientId, Template template)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTemplate(Recipient recipient, NotificationType notificationType, Template template)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTemplate(Recipient recipient, NotificationType notificationType, Template template,
                                   List quickReplies)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTemplate(Recipient recipient, NotificationType notificationType, Template template,
                                   String metadata)
            throws MessengerApiException, MessengerIOException;

    MessengerResponse sendTemplate(Recipient recipient, NotificationType notificationType, Template template,
                                   List quickReplies, String metadata)
            throws MessengerApiException, MessengerIOException;
}