Producer Endpoints: - 6.3

Talend ESB Mediation Developer Guide

EnrichVersion
6.3
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend ESB

Producer endpoints can use endpoint names and options from the table below. Endpoints can also use the short name without the get or search prefix, except checkin due to ambiguity between getCheckin and searchCheckin. Endpoint options that are not mandatory are denoted by [].

Producer endpoints can also use a special option *inBody* that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message. For example, the facebook endpoint in the following route retrieves activities for the user id value in the incoming message body.

from("direct:test").to("facebook://activities?inBody=userId")...

Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelFacebook.option. For example, the userId option value in the previous route could alternately be provided in the message header CamelFacebook.userId. Note that the inBody option overrides message header, e.g. the endpoint option inBody=user would override a CamelFacebook.userId header.

Endpoints that return a String return an Id for the created or modified entity, e.g. addAlbumPhoto returns the new album Id. Endpoints that return a boolean, return true for success and false otherwise. In case of Facebook API errors the endpoint will throw a RuntimeCamelException with a facebook4j.FacebookException cause.

Endpoint

Short Name

Options

Body Type

Accounts

getAccounts

accounts

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Account>

Activities

getActivities

activities

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Activity>

Albums

addAlbumPhoto

addAlbumPhoto

albumId,source,[message]

String

commentAlbum

commentAlbum

albumId,message

String

createAlbum

createAlbum

albumCreate,[userId]

String

getAlbum

album

albumId,[reading]

facebook.Album

getAlbumComments

albumComments

albumId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getAlbumCoverPhoto

albumCoverPhoto

albumId

java.net.URL

getAlbumLikes

albumLikes

albumId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

getAlbumPhotos

albumPhotos

albumId,[reading]

facebook4j.ResponseList

<facebook4j.Photos>

getAlbums

albums

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Album>

likeAlbum

likeAlbum

albumId

boolean

unlikeAlbum

unlikeAlbum

albumId

boolean

Checkins

checkin

checkin

checkinCreate, [userId]

String

commentCheckin

commentCheckin

checkinId, message

String

getCheckin

checkin

checkinId, [reading]

facebook4j.Checkin

getCheckinComments

checkinComments

checkinId, [reading]

facebook4j.ResponseList

<facebook4j.Comment>

getCheckinLikes

checkinLikes

checkinId, [reading]

facebook4j.ResponseList

<facebook4j.Like>

getCheckins

checkins

[reading], [userId]

facebook4j.ResponseList

<facebook4j.Checkin>

likeCheckin

likeCheckin

checkinId

boolean

unlikeCheckin

unlikeCheckin

checkinId

boolean

Comments

deleteComment

deleteComment

commentId

boolean

getComment

comment

commentId

facebook4j.Comment

getCommentLikes

commentLikes

commentId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

likeComment

likeComment

commentId

boolean

unlikeComment

unlikeComment

commentId

boolean

Domains

getDomain

domain

domainId

facebook4j.Domain

getDomainByName

domainByName

domainName

facebook4j.Domain

getDomainsByName

domainsByName

domainNames

java.util.List

<facebook4j.Domain>

Events

createEvent

createEvent

eventUpdate,[userId]

String

deleteEvent

deleteEvent

eventId

boolean

deleteEventPicture

deleteEventPicture

eventId

boolean

editEvent

editEvent

eventId, eventUpdate

boolean

getEvent

event

eventId,[reading]

facebook4j.Event

getEventFeed

eventFeed

eventId,[reading]

facebook4j.ResponseList

<facebook4j.Post>

getEventPhotos

eventPhotos

eventId,[reading]

facebook4j.ResponseList

<facebook4j.Photo>

getEventPictureURL

eventPictureURL

eventId,[size]

java.net.URL

getEvents

events

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Event>

getEventVideos

eventVideos

eventId,[reading]

facebook4j.ResponseList

<facebook4j.Video>

getRSVPStatusAsInvited

rSVPStatusAsInvited

eventId,[userId]

facebook4j.ResponseList

<facebook4j.RSVPStatus>

getRSVPStatusAsNoreply

rSVPStatusAsNoreply

eventId,[userId]

facebook4j.ResponseList

<facebook4j.RSVPStatus>

getRSVPStatusInAttending

rSVPStatusInAttending

eventId,[userId]

facebook4j.ResponseList

<facebook4j.RSVPStatus>

getRSVPStatusInDeclined

rSVPStatusInDeclined

eventId,[userId]

facebook4j.ResponseList

<facebook4j.RSVPStatus>

getRSVPStatusInMaybe

rSVPStatusInMaybe

eventId,[userId]

facebook4j.ResponseList

<facebook4j.RSVPStatus>

inviteToEvent

inviteToEvent

eventId,[userId],[userIds]

boolean

postEventFeed

postEventFeed

eventId, postUpdate

String

postEventLink

postEventLink

eventId,link,[message]

String

postEventPhoto

postEventPhoto

eventId,source,[message]

String

postEventStatusMessage

postEventStatusMessage

eventId,message

String

postEventVideo

postEventVideo

eventId,source,[title,description]

String

rsvpEventAsAttending

rsvpEventAsAttending

eventId

boolean

rsvpEventAsDeclined

rsvpEventAsDeclined

eventId

boolean

rsvpEventAsMaybe

rsvpEventAsMaybe

eventId

boolean

uninviteFromEvent

uninviteFromEvent

eventId,userId

boolean

updateEventPicture

updateEventPicture

eventId,source

boolean

Family

getFamily

family

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Family>

Favorites

getBooks

books

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Book>

getGames

games

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Game>

getInterests

interests

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Interest>

getMovies

movies

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Movie>

getMusic

music

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Music>

getTelevision

television

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Television>

Facebook Query Language (FQL)

executeFQL

executeFQL

query,[locale]

facebook4j.internal.org.

json.JSONArray

executeMultiFQL

executeMultiFQL

queries,[locale]

java.util.Map<String,facebook4j.

internal.org.json.JSONArray>

Friends

addFriendlistMember

addFriendlistMember

friendlistId, userId

boolean

createFriendlist

createFriendlist

friendlistName,[userId]

String

deleteFriendlist

deleteFriendlist

friendlistId

boolean

getBelongsFriend

belongsFriend

friendId,[reading],[userId]

facebook4j.ResponseList

<facebook4j.Friend>

getFriendlist

friendlist

friendlistId,[reading]

facebook4j.FriendList

getFriendlistMembers

friendlistMembers

friendlistId

facebook4j.ResponseList

<facebook4j.Friend>

getFriendlists

friendlists

[reading],[userId]

facebook4j.ResponseList

<facebook4j.FriendList>

getFriendRequests

friendRequests

[reading],[userId]

facebook4j.ResponseList

<facebook4j.FriendRequest>

getFriends

friends

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Friend>

getMutualFriends

mutualFriends

[friendUserId],[reading],[userId1,userId2]

facebook4j.ResponseList

<facebook4j.Friend>

removeFriendlistMember

removeFriendlistMember

friendlistId, userId

boolean

Games

deleteAchievement

deleteAchievement

achievementURL,[userId]

boolean

deleteScore

deleteScore

[userId]

boolean

getAchievements

achievements

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Achievement>

getScores

scores

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Score>

postAchievement

postAchievement

achievementURL,[userId]

String

postScore

postScore

scoreValue,[userId]

String

Groups

getGroup

group

groupId,[reading]

facebook4j.Group

getGroupDocs

groupDocs

groupId,[reading]

facebook4j.ResponseList

<facebook4j.GroupDoc>

getGroupFeed

groupFeed

groupId,[reading]

facebook4j.ResponseList

<facebook4j.Post>

getGroupMembers

groupMembers

groupId,[reading]

facebook4j.ResponseList

<facebook4j.GroupMember>

getGroupPictureURL

groupPictureURL

groupId

java.net.URL

getGroups

groups

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Group>

postGroupFeed

postGroupFeed

groupId, postUpdate

String

postGroupLink

postGroupLink

groupId,link,[message]

String

postGroupStatusMessage

postGroupStatusMessage

groupId, message

String

Insights

getInsights

insights

objectId,metric,[reading]

facebook4j.ResponseList

<facebook4j.Insight>

Likes

getUserLikes

userLikes

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Like>

Links

commentLink

commentLink

linkId,message

String

getLink

link

linkId,[reading]

facebook4j.Link

getLinkComments

linkComments

linkId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getLinkLikes

linkLikes

linkId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

likeLink

likeLink

linkId

boolean

unlikeLink

unlikeLink

linkId

boolean

Locations

getLocations

locations

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Location>

Messages

getInbox

inbox

[reading],[userId]

facebook4j.InboxResponseList

<facebook4j.Inbox>

getMessage

message

messageId,[reading]

facebook4j.Message

getOutbox

outbox

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Message>

getUpdates

updates

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Message>

Notes

commentNote

commentNote

noteId,message

String

createNote

createNote

subject,message,[userId]

String

getNote

note

noteId,[reading]

facebook4j.Note

getNoteComments

noteComments

noteId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getNoteLikes

noteLikes

noteId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

getNotes

notes

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Note>

likeNote

likeNote

noteId

boolean

unlikeNote

unlikeNote

noteId

boolean

Notifications

getNotifications

notifications

[includeRead],[reading],[userId]

facebook4j.ResponseList

<facebook4j.Notification>

markNotificationAsRead

markNotificationAsRead

notificationId

boolean

Permissions

getPermissions

permissions

[userId]

java.util.List

<facebook4j.Permission>

revokePermission

revokePermission

permissionName,[userId]

boolean

Photos

addTagToPhoto

addTagToPhoto

photoId,[toUserId],[toUserIds],[tagUpdate]

boolean

commentPhoto

commentPhoto

photoId,message

String

deletePhoto

deletePhoto

photoId

boolean

getPhoto

photo

photoId,[reading]

facebook4j.Photo

getPhotoComments

photoComments

photoId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getPhotoLikes

photoLikes

photoId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

getPhotos

photos

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Photo>

getPhotoURL

photoURL

photoId

java.net.URL

getTagsOnPhoto

tagsOnPhoto

photoId,[reading]

facebook4j.ResponseList

<facebook4j.Tag>

likePhoto

likePhoto

photoId

boolean

postPhoto

postPhoto

source,[message],[place],[noStory],[userId]

String

unlikePhoto

unlikePhoto

photoId

boolean

updateTagOnPhoto

updateTagOnPhoto

photoId,[toUserId],[tagUpdate]

boolean

Pokes

getPokes

pokes

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Poke>

Posts

commentPost

commentPost

postId,message

String

deletePost

deletePost

postId

boolean

getFeed

feed

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Post>

getHome

home

[reading]

facebook4j.ResponseList

<facebook4j.Post>

getLinks

links

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Link>

getPost

post

postId,[reading]

facebook4j.Post

getPostComments

postComments

postId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getPostLikes

postLikes

postId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

getPosts

posts

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Post>

getStatuses

statuses

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Post>

getTagged

tagged

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Post>

likePost

likePost

postId

boolean

postFeed

postFeed

postUpdate,[userId]

String

postLink

postLink

link,[message],[userId]

String

postStatusMessage

postStatusMessage

message,[userId]

String

unlikePost

unlikePost

postId

boolean

Questions

addQuestionOption

addQuestionOption

questionId, optionDescription

String

createQuestion

createQuestion

question,[options],[allowNewOptions],[userId]

String

deleteQuestion

deleteQuestion

questionId

boolean

getQuestion

question

questionId,[reading]

facebook4j.Question

getQuestionOptions

questionOptions

questionId,[reading]

facebook4j.ResponseList

<facebook4j.Question.Option>

getQuestionOptionVotes

questionOptionVotes

questionId

facebook4j.ResponseList

<facebook4j.QuestionVotes>

getQuestions

questions

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Question>

getSubscribedto

subscribedto

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Subscribedto>

getSubscribers

subscribers

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Subscriber>

Test Users

createTestUser

createTestUser

appId,[name],[userLocale],[permissions]

facebook4j.TestUser

deleteTestUser

deleteTestUser

testUserId

boolean

getTestUsers

testUsers

appId

java.util.List

<facebook4j.TestUser>

makeFriendTestUser

makeFriendTestUser

testUser1, testUser2

boolean

Users

getMe

me

[reading]

facebook4j.User

getPictureURL

pictureURL

[size],[userId]

java.net.URL

getUser

user

userId,[reading]

facebook4j.User

getUsers

users

ids

java.util.List

<facebook4j.User>

Videos

commentVideo

commentVideo

videoId,message

String

getVideo

video

videoId,[reading]

facebook4j.Video

getVideoComments

videoComments

videoId,[reading]

facebook4j.ResponseList

<facebook4j.Comment>

getVideoCover

videoCover

videoId

java.net.URL

getVideoLikes

videoLikes

videoId,[reading]

facebook4j.ResponseList

<facebook4j.Like>

getVideos

videos

[reading],[userId]

facebook4j.ResponseList

<facebook4j.Video>

likeVideo

likeVideo

videoId

boolean

postVideo

postVideo

source,[title,description],[userId]

String

unlikeVideo

unlikeVideo

videoId

boolean

Search

search

search

query,[reading]

facebook4j.ResponseList<facebook

4j.internal.org.json.JSONObject>

searchCheckins

checkins

[reading]

facebook4j.ResponseList

<facebook4j.Checkin>

searchEvents

events

query,[reading]

facebook4j.ResponseList

<facebook4j.Event>

searchGroups

groups

query,[reading]

facebook4j.ResponseList

<facebook4j.Group>

searchLocations

locations

[center,distance],[reading],[placeId]

facebook4j.ResponseList

<facebook4j.Location>

searchPlaces

places

query,[reading],[center,distance]

facebook4j.ResponseList

<facebook4j.Place>

searchPosts

posts

query,[reading]

facebook4j.ResponseList

<facebook4j.Post>

searchUsers

users

query,[reading]

facebook4j.ResponseList

<facebook4j.User>