Index | Laravel Facebook Messenger API

A

BaseCollection::add() — Method in class BaseCollection: Add item to collection
ButtonCollection::addPostBackButton() — Method in class ButtonCollection: Add postback button
ButtonCollection::addWebButton() — Method in class ButtonCollection: Add web url button
ButtonCollection::addAccountLinkButton() — Method in class ButtonCollection: Add account link button
ButtonCollection::addCallButton() — Method in class ButtonCollection: Add phone call button
ButtonCollection::addShareButton() — Method in class ButtonCollection: Add share button
ElementCollection::addElement() — Method in class ElementCollection: Add element
AutoTypingHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class AutoTypingHandler
$Bot#apiUrl — Property in class Bot: FB Messenger API Url
Attachment — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Class Attachment
Template::add() — Method in class Template: Add elements
Audio — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Audio
Quickable::addQuick() — Method in class Quickable

B

BaseCollection — Class in namespace Casperlaitw\LaravelFbMessenger\Collections: Class BaseCollection
ButtonCollection — Class in namespace Casperlaitw\LaravelFbMessenger\Collections: Class ButtonCollection
BaseCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class BaseCommand
BaseHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class BaseHandler
$BaseHandler#bot — Property in class BaseHandler
Bot — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class Bot
Debug::broadcast() — Method in class Debug
WebhookHandler::boot() — Method in class WebhookHandler: Boot to initialize process
Broadcast — Class in namespace Casperlaitw\LaravelFbMessenger\Events
Broadcast::broadcastWith() — Method in class Broadcast: Get the data to broadcast.
Broadcast::broadcastOn() — Method in class Broadcast: Get the channels the event should broadcast on.
LaravelFbMessengerServiceProvider::boot() — Method in class LaravelFbMessengerServiceProvider: Perform post-registration booting of services.
Button — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Button
ButtonTemplate — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class ButtonTemplate
Element::buttons() — Method in class Element: Get button collection
Quickable::bootQuick() — Method in class Quickable: Boot quick
MenuServiceProvider::boot() — Method in class MenuServiceProvider
RouteServiceProvider::boot() — Method in class RouteServiceProvider: Register the webhook to router
ButtonTransformer — Class in namespace Casperlaitw\LaravelFbMessenger\Transformers: Class ButtonTransformer

C

BaseHandler::createBot() — Method in class BaseHandler: Create bot to send API
Bot::call() — Method in class Bot: Request to API
CommandHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class CommandHandler
Debug::clear() — Method in class Debug: Clear all.
CodeInterface — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Interface CodeInterface
$Template#collections — Property in class Template
Template::collection() — Method in class Template: Collection class name
WebhookHandler::createBot() — Method in class WebhookHandler: Create bot
$LaravelFbMessengerServiceProvider#configPath — Property in class LaravelFbMessengerServiceProvider: Config path
ButtonTemplate::collection() — Method in class ButtonTemplate: Get button collection
GenericTemplate::collection() — Method in class GenericTemplate
ListTemplate::collection() — Method in class ListTemplate: Collection class name
Menu::createMenu() — Method in class Menu: Create menu

D

DomainWhitelistingCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class DomainWhitelistingCommand
$DomainWhitelistingCommand#description — Property in class DomainWhitelistingCommand: The console command description.
$GetStartButtonCommand#description — Property in class GetStartButtonCommand: The console command description.
$GreetingTextCommand#description — Property in class GreetingTextCommand: The console command description.
$HomeUrlCommand#description — Property in class HomeUrlCommand: The console command description.
$MessengerCodeCommand#description — Property in class MessengerCodeCommand: The console command description.
$PersistentMenuCommand#description — Property in class PersistentMenuCommand: The console command description.
BaseHandler::debug() — Method in class BaseHandler
Bot::debug() — Method in class Bot
Debug — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Debug: Class Debug
DefaultHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class DefaultHandler
Attachment::disableReuse() — Method in class Attachment: Disable reuse
Template::disableShare() — Method in class Template: Disable share
DebugController — Class in namespace Casperlaitw\LaravelFbMessenger\Controllers: Class DebugController
DefaultActionInvalidTypeException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class DefaultActionInvalidTypeException
DomainWhitelisting — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class DomainWhitelisting
UrlButton::disableShare() — Method in class UrlButton: Disable share
Menu::disableInput() — Method in class Menu: Disable input

E

$BaseCollection#elements — Property in class BaseCollection: Elements
ElementCollection — Class in namespace Casperlaitw\LaravelFbMessenger\Collections: Class ElementCollection
Attachment::enableReuse() — Method in class Attachment: Enable reuse
Element — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Element

F

ReceiveMessageCollection::filterSkip() — Method in class ReceiveMessageCollection: Filter messages
File — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class File

G

BaseCollection::getElements() — Method in class BaseCollection: Get elements
GetStartButtonCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class GetStartButtonCommand
GreetingTextCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class SetGreetingTextCommand
Debug::getResponse() — Method in class Debug
Debug::getStatus() — Method in class Debug
HandleMessageResponse::getResponse() — Method in class HandleMessageResponse: Get API response message
Attachment::getPayload() — Method in class Attachment: Get payload
Message::getSender() — Method in class Message: Get sender id
Template::getCollections() — Method in class Template: Get collection
PostbackHandler::getPayload() — Method in class PostbackHandler: Get payload
RequestType::getCurlType() — Method in class RequestType: Get request type
MessengerMenu::getFacadeAccessor() — Method in class MessengerMenu: The name of the binding in the IoC container.
Button::getType() — Method in class Button: Get button type.
ButtonTemplate::getText() — Method in class ButtonTemplate: Get text
GenericTemplate — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class GenericTemplate
GenericTemplate::getImageRatio() — Method in class GenericTemplate: Get image ratio
Greeting — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Greeting
ListTemplate::getButton() — Method in class ListTemplate
ListTemplate::getTopStyle() — Method in class ListTemplate: Get top style
ReceiveMessage::getSender() — Method in class ReceiveMessage: Get sender
ReceiveMessage::getMessage() — Method in class ReceiveMessage: Get message
ReceiveMessage::getPostback() — Method in class ReceiveMessage: Get postback payload
ReceiveMessage::getRecipient() — Method in class ReceiveMessage: Get recipient id
ReceiveMessage::getAttachments() — Method in class ReceiveMessage: Get attachments
ReceiveMessage::getReferral() — Method in class ReceiveMessage: Get referral
ReceiveMessage::getNlp() — Method in class ReceiveMessage: Get NLP
Receiver::getMessages() — Method in class Receiver: Get message collection
Menu::getMenus() — Method in class Menu: Get all menus
GenericTransformer — Class in namespace Casperlaitw\LaravelFbMessenger\Transformers: Class GenericTransformer

H

$BaseCommand#handler — Property in class BaseCommand
DomainWhitelistingCommand::handle() — Method in class DomainWhitelistingCommand: Execute command
GetStartButtonCommand::handle() — Method in class GetStartButtonCommand: Execute command
GreetingTextCommand::handle() — Method in class GreetingTextCommand: Execute command
HomeUrlCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class HomeUrlCommand
HomeUrlCommand::handle() — Method in class HomeUrlCommand: Execute command
MessengerCodeCommand::handle() — Method in class MessengerCodeCommand: Execute command
PersistentMenuCommand::handle() — Method in class PersistentMenuCommand: Execute command
AutoTypingHandler::handle() — Method in class AutoTypingHandler: Handle the chatbot message
BaseHandler::handle() — Method in class BaseHandler: Handle the chatbot message
CommandHandler::handle() — Method in class CommandHandler: Handle the chatbot message
Handler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Debug
DefaultHandler::handle() — Method in class DefaultHandler: Handle the chatbot message
HandleMessageResponse — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class HandleMessageResponse
HandlerInterface — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Interface Receiver
HandlerInterface::handle() — Method in class HandlerInterface: Handle the chatbot message
WebhookHandler::handle() — Method in class WebhookHandler: Handle webhook
HomeUrl — Class in namespace Casperlaitw\LaravelFbMessenger\Messages
ReceiveMessage::hasAttachments() — Method in class ReceiveMessage: Has attachments
RequestReceived::handle() — Method in class RequestReceived

I

BaseCollection::isEmpty() — Method in class BaseCollection: Collection is empty
QuickReplyCollection::isEmpty() — Method in class QuickReplyCollection
DebugController::index() — Method in class DebugController
WebhookController::index() — Method in class WebhookController: Webhook verify request
Image — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class ImageMessage
Quickable::isEmpty() — Method in class Quickable
ReceiveMessage::isSkip() — Method in class ReceiveMessage: Is skip the message
ReceiveMessage::isPayload() — Method in class ReceiveMessage: Is playload message
Menu::isEmpty() — Method in class Menu: Menu is empty

L

ListElementCountException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class ListElementCountException
LaravelFbMessengerServiceProvider — Class in namespace Casperlaitw\LaravelFbMessenger: Class LaravelFbMessengerServiceProvider
ListElement — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class ListElement
ListTemplate — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class ListTemplate
Menu::locale() — Method in class Menu: Set locale menu
Menu::loadMenus() — Method in class Menu: Load menu
ListTransformer — Class in namespace Casperlaitw\LaravelFbMessenger\Transformers: Class ListTransformer

M

MessengerCodeCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands
Message — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Class Message
MessageInterface — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Interface MessageInterface
MessengerMenu — Class in namespace Casperlaitw\LaravelFbMessenger\Facades: Class MessengerMenu
$LaravelFbMessengerServiceProvider#menuPath — Property in class LaravelFbMessengerServiceProvider: Menu path
MessengerCode — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class MessengerCode
Quickable::makeQuickReply() — Method in class Quickable
Menu — Class in namespace Casperlaitw\LaravelFbMessenger\PersistentMenu: Class Menu
$Menu#menus — Property in class Menu
Menu::mergeWithLastStack() — Method in class Menu: Merge menus to last menu stack
MenuServiceProvider — Class in namespace Casperlaitw\LaravelFbMessenger\Providers: Class MenuServiceProvider
MenuServiceProvider::map() — Method in class MenuServiceProvider

N

NotCreateBotException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class NotCreateBotException
NotOptionsException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class NotOptionsException
Menu::nested() — Method in class Menu: Nested menu
$RouteServiceProvider#namespace — Property in class RouteServiceProvider: Controller namespace

O

OptionNotComparedException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class OptionNotComparedException

P

PersistentMenuCommand — Class in namespace Casperlaitw\LaravelFbMessenger\Commands: Class PersistentMenuCommand
ProfileInterface — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Interface ProfileInterface
PostbackHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class PostbackHandler
$PostbackHandler#payload — Property in class PostbackHandler
PersistentMenuMessage — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class PersistentMenuMessage
Menu::postback() — Method in class Menu: Create postback menu

Q

QuickReplyCollection — Class in namespace Casperlaitw\LaravelFbMessenger\Collections: Class QuickReplyCollection
QuickReply — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class QuickReply
Quickable — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Quickable
$Quickable#quicks — Property in class Quickable

R

ReceiveMessageCollection — Class in namespace Casperlaitw\LaravelFbMessenger\Collections: Class ReceiveMessageCollection
Handler::report() — Method in class Handler: Report or log an exception.
Handler::render() — Method in class Handler: Render an exception into an HTTP response.
Handler::renderForConsole() — Method in class Handler: Render an exception to the console.
$HandleMessageResponse#response — Property in class HandleMessageResponse
RequestType — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class RequestType
WebhookController::receive() — Method in class WebhookController: Receive the webhook request
RequiredArgumentException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class RequiredArgumentException
LaravelFbMessengerServiceProvider::register() — Method in class LaravelFbMessengerServiceProvider: Register any package services.
ReceiveMessage — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class ReceiveMessage
Receiver — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Receiver
RequestReceived — Class in namespace Casperlaitw\LaravelFbMessenger\Middleware: Class RequestReceived
MenuServiceProvider::register() — Method in class MenuServiceProvider
RouteServiceProvider — Class in namespace Casperlaitw\LaravelFbMessenger\Providers: Class RouteServiceProvider
RouteServiceProvider::register() — Method in class RouteServiceProvider: Stub required to satisfy Laravel 5.1's ServiceProvider

S

$DomainWhitelistingCommand#signature — Property in class DomainWhitelistingCommand: The name and signature of the console command.
$GetStartButtonCommand#signature — Property in class GetStartButtonCommand: The name and signature of the console command.
$GreetingTextCommand#signature — Property in class GreetingTextCommand: The name and signature of the console command.
$HomeUrlCommand#signature — Property in class HomeUrlCommand: The name and signature of the console command.
$MessengerCodeCommand#signature — Property in class MessengerCodeCommand: The name and signature of the console command.
$PersistentMenuCommand#signature — Property in class PersistentMenuCommand: The name and signature of the console command.
BaseHandler::send() — Method in class BaseHandler: Send message to api
Bot::setDebug() — Method in class Bot
Bot::setSecret() — Method in class Bot
Bot::send() — Method in class Bot: Send message to API
Bot::sendMessage() — Method in class Bot
Bot::sendProfile() — Method in class Bot: Send messenger profile endpoint
Bot::sendUserApi() — Method in class Bot: Send user endpoint
Debug::setWebhook() — Method in class Debug
Debug::setRequest() — Method in class Debug
Debug::setResponse() — Method in class Debug
Debug::setStatus() — Method in class Debug
Debug::setError() — Method in class Debug: Set error message.
Attachment::setPayload() — Method in class Attachment: Set Payload
Attachment::setAttachmentId() — Method in class Attachment: Set attachment id
Button::setExtra() — Method in class Button: Set button extra
ButtonTemplate::setText() — Method in class ButtonTemplate: Set text
DomainWhitelisting::setAction() — Method in class DomainWhitelisting: Set domain whitelisting action
DomainWhitelisting::setDomains() — Method in class DomainWhitelisting: Set domains
Element::setDefaultAction() — Method in class Element: Set default action button
GenericTemplate::setImageRatio() — Method in class GenericTemplate: Set image aspect ratio
HomeUrl::setAction() — Method in class HomeUrl: Set domain whitelisting action
ListTemplate::setButton() — Method in class ListTemplate
ListTemplate::setTopStyle() — Method in class ListTemplate: Set top style
MessengerCode::setImageSize() — Method in class MessengerCode
MessengerCode::setRef() — Method in class MessengerCode
QuickReply::setLocation() — Method in class QuickReply: Set location quick reply
QuickReply::setImage() — Method in class QuickReply: Set image url
ReceiveMessage::setSkip() — Method in class ReceiveMessage: Set skip
ReceiveMessage::setMessage() — Method in class ReceiveMessage
ReceiveMessage::setPostback() — Method in class ReceiveMessage: Set postback
ReceiveMessage::setPayload() — Method in class ReceiveMessage: Set payload
ReceiveMessage::setAttachments() — Method in class ReceiveMessage: Set attachments
ReceiveMessage::setReferral() — Method in class ReceiveMessage: Set referral
ReceiveMessage::setNlp() — Method in class ReceiveMessage: Set NLP
StartButton — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class StartButton
UrlButton::setWebviewHeightRatio() — Method in class UrlButton: Set webview height ratio
UrlButton::setFallbackUrl() — Method in class UrlButton: Set fallback url
$Menu#stack — Property in class Menu
StructuredTransformer — Class in namespace Casperlaitw\LaravelFbMessenger\Transformers: Interface StructuredTransformer

T

BaseCollection::toData() — Method in class BaseCollection: Get all elements array data
$Bot#token — Property in class Bot
Attachment::toData() — Method in class Attachment: To array for send api
Message::toData() — Method in class Message: To array for send api
MessageInterface::toData() — Method in class MessageInterface: To array for send api
Template — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Class Structured
Template::toData() — Method in class Template: To array for send api
Button::toData() — Method in class Button: To array for send api
ButtonTemplate::toData() — Method in class ButtonTemplate: To array for send api
DomainWhitelisting::toData() — Method in class DomainWhitelisting: To array for send api
Element::toData() — Method in class Element: To array for send api
GenericTemplate::toData() — Method in class GenericTemplate: To array for send api
Greeting::toData() — Method in class Greeting: Message to send
HomeUrl::toData() — Method in class HomeUrl: To array for send api
Image::toData() — Method in class Image: To array for send api
ListTemplate::toData() — Method in class ListTemplate
MessengerCode::toData() — Method in class MessengerCode: To array for send api
PersistentMenuMessage::toData() — Method in class PersistentMenuMessage: Message to send
QuickReply::toData() — Method in class QuickReply: To array for send api
StartButton::toData() — Method in class StartButton: Message to send
Text — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class TextMessage
Text::toData() — Method in class Text: To array for send api
Typing — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Typing
Typing::toData() — Method in class Typing: To array for send api
UrlButton::toData() — Method in class UrlButton: To array for send api
User::toData() — Method in class User: To array for send api
ButtonTransformer::transform() — Method in class ButtonTransformer: Transform payload
GenericTransformer::transform() — Method in class GenericTransformer: Transform payload
ListTransformer::transform() — Method in class ListTransformer: Transform payload
StructuredTransformer::transform() — Method in class StructuredTransformer: Transform payload

U

UserInterface — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts\Messages: Interface UserInterface
RequestType::usePost() — Method in class RequestType: Use post type
RequestType::useGet() — Method in class RequestType: Use get type
RequestType::useDelete() — Method in class RequestType: Use delete type
UnknownTypeException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class UnknownTypeException
UrlButton — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class UrlButton
UrlButton::useMessengerExtensions() — Method in class UrlButton: Use messenger extensions
User — Class in namespace Casperlaitw\LaravelFbMessenger\Messages

V

BaseCollection::validator() — Method in class BaseCollection: Validate collection item
ButtonCollection::validator() — Method in class ButtonCollection: Valid the added element
ElementCollection::validator() — Method in class ElementCollection: Valid the added element
QuickReplyCollection::validator() — Method in class QuickReplyCollection: Validate collection item
ValidatorStructureException — Class in namespace Casperlaitw\LaravelFbMessenger\Exceptions: Class ValidatorStructureException
Video — Class in namespace Casperlaitw\LaravelFbMessenger\Messages: Class Video

W

WebhookHandler — Class in namespace Casperlaitw\LaravelFbMessenger\Contracts: Class WebhookHandler
WebhookController — Class in namespace Casperlaitw\LaravelFbMessenger\Controllers: Class WebhookController
Menu::webUrl() — Method in class Menu

_

ButtonCollection::__construct() — Method in class ButtonCollection: ButtonCollection constructor.
ElementCollection::__construct() — Method in class ElementCollection: ElementCollection constructor.
BaseCommand::__construct() — Method in class BaseCommand: BaseCommand constructor.
Bot::__construct() — Method in class Bot: FbBotApp constructor.
Debug::__construct() — Method in class Debug: Debug constructor.
Handler::__construct() — Method in class Handler: Handler constructor.
HandleMessageResponse::__construct() — Method in class HandleMessageResponse: HandleMessageResponse constructor.
Attachment::__construct() — Method in class Attachment: Attachment constructor.
Message::__construct() — Method in class Message: Message constructor.
Template::__construct() — Method in class Template: Structured constructor.
Template::__call() — Method in class Template
WebhookHandler::__construct() — Method in class WebhookHandler: WebhookHandler constructor.
WebhookController::__construct() — Method in class WebhookController: WebhookController constructor.
Broadcast::__construct() — Method in class Broadcast: RequestReceived constructor.
Audio::__construct() — Method in class Audio: Audio constructor.
Button::__construct() — Method in class Button: Button constructor.
ButtonTemplate::__construct() — Method in class ButtonTemplate: Button constructor.
DomainWhitelisting::__construct() — Method in class DomainWhitelisting: DomainWhitelisting constructor.
Element::__construct() — Method in class Element: Element constructor.
File::__construct() — Method in class File: File constructor.
GenericTemplate::__construct() — Method in class GenericTemplate: Generic constructor.
Greeting::__construct() — Method in class Greeting: Greeting constructor.
HomeUrl::__construct() — Method in class HomeUrl: HomeUrl constructor.
Image::__construct() — Method in class Image: ImageMessage constructor.
ListTemplate::__construct() — Method in class ListTemplate: ListTemplate constructor.
MessengerCode::__construct() — Method in class MessengerCode: MessengerCode constructor.
PersistentMenuMessage::__construct() — Method in class PersistentMenuMessage: PersistentMenuMessage constructor.
QuickReply::__construct() — Method in class QuickReply: QuickReply constructor.
ReceiveMessage::__construct() — Method in class ReceiveMessage: Receive constructor.
Receiver::__construct() — Method in class Receiver: Receiver constructor.
StartButton::__construct() — Method in class StartButton: StartButton constructor.
Text::__construct() — Method in class Text: TextMessage constructor.
Typing::__construct() — Method in class Typing: Typing constructor.
UrlButton::__construct() — Method in class UrlButton: UrlButton constructor.
Video::__construct() — Method in class Video: Video constructor.
RequestReceived::__construct() — Method in class RequestReceived: RequestReceived constructor.