co.aurasphere.botmill.fb.model.incoming.callback

Class Referral

java.lang.Object

co.aurasphere.botmill.fb.model.incoming.callback.Referral

All Implemented Interfaces:

Serializable

public class Referral
extends Object
implements Serializable

Model for the Referral Callback.

This callback will occur when an m.me link is used with a referral param and only in a case this user already has a thread with this bot (for new threads see Postback Event). See also the full guide on m. me links.

To start receiving these events you need to subscribe to messaging_referral in the webhook settings for your app.

An m.me link with an an added parameter looks like this: http://m.me/mybot?ref=myparam. The value of the ref parameter will be passed to the server via webhook.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Referral Callback Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Referral()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getRef() Gets the ref.
ReferralSource	getSource() Gets the source.
ReferralType	getType() Gets the type.
int	hashCode()
void	setRef(String ref) Sets the ref.
void	setSource(ReferralSource source) Sets the source.
void	setType(ReferralType type) Sets the type.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Referral

public Referral()

Method Detail

getRef

public String getRef()

Gets the ref.

Returns:

the ref.

setRef

public void setRef(String ref)

Sets the ref.

Parameters:

ref - the ref to set.

getSource

public ReferralSource getSource()

Gets the source.

Returns:

the source.

setSource

public void setSource(ReferralSource source)

Sets the source.

Parameters:

source - the source to set.

getType

public ReferralType getType()

Gets the type.

Returns:

the type.

setType

public void setType(ReferralType type)

Sets the type.

Parameters:

type - the type to set.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object