Package com.restfb.types.webhook.messaging

Class PostbackReferral

java.lang.Object

com.restfb.types.webhook.messaging.PostbackReferral

Direct Known Subclasses:

ReferralItem

public class PostbackReferral
extends Object

Represents the referral sub object described here: https://developers.facebook.com/docs/messenger-platform/referral-params

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostbackReferral.AdsContextData

Constructor Summary

Constructors

Constructor	Description
PostbackReferral()

Method Summary

Modifier and Type	Method	Description
String	getAdId()
PostbackReferral.AdsContextData	getAdsContextData()	The data contaning information about the CTM ad, the user initiated the thread from.
Boolean	getIsGuestUser()	A flag indicating whether the user is a guest user from Facebook Chat Plugin
String	getRef()	The arbitrary data that was originally passed in the ref param added to the m.me link.
String	getRefererUri()	The URI of the site where the message was sent in the Facebook chat plugin.
String	getSource()	The source of this referral.
String	getType()	The identifier for the referral.
void	setAdId(String adId)
void	setAdsContextData(PostbackReferral.AdsContextData adsContextData)	The data contaning information about the CTM ad, the user initiated the thread from.
void	setIsGuestUser(Boolean isGuestUser)	A flag indicating whether the user is a guest user from Facebook Chat Plugin
void	setRef(String ref)	The arbitrary data that was originally passed in the ref param added to the m.me link.
void	setRefererUri(String refererUri)	The URI of the site where the message was sent in the Facebook chat plugin.
void	setSource(String source)	The source of this referral.
void	setType(String type)	The identifier for the referral.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PostbackReferral

public PostbackReferral()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getRef

public String getRef()

The arbitrary data that was originally passed in the ref param added to the m.me link.

setRef

public void setRef(String ref)

The arbitrary data that was originally passed in the ref param added to the m.me link.

getAdId

public String getAdId()

setAdId

public void setAdId(String adId)

getSource

public String getSource()

The source of this referral. Currently, the only possible value is “SHORTLINK”.

setSource

public void setSource(String source)

The source of this referral. Currently, the only possible value is “SHORTLINK”.

getType

public String getType()

The identifier for the referral. For referrals coming from m.me links, it will always be "OPEN_THREAD".

setType

public void setType(String type)

The identifier for the referral. For referrals coming from m.me links, it will always be "OPEN_THREAD".

getRefererUri

public String getRefererUri()

The URI of the site where the message was sent in the Facebook chat plugin.

setRefererUri

public void setRefererUri(String refererUri)

The URI of the site where the message was sent in the Facebook chat plugin.

getIsGuestUser

public Boolean getIsGuestUser()

A flag indicating whether the user is a guest user from Facebook Chat Plugin

setIsGuestUser

public void setIsGuestUser(Boolean isGuestUser)

A flag indicating whether the user is a guest user from Facebook Chat Plugin

getAdsContextData

public PostbackReferral.AdsContextData getAdsContextData()

The data contaning information about the CTM ad, the user initiated the thread from.

setAdsContextData

public void setAdsContextData(PostbackReferral.AdsContextData adsContextData)

The data contaning information about the CTM ad, the user initiated the thread from.