Class FBFlashBridge

Version 0.1.
Facebook Connect Flash Bridge
Defined in: FBFlashBridge-0.1.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	FBFlashBridge(appName, appKey, appURL, flashObject)

Method Summary
Method Attributes	Method Name and Description
<inner>	addEventListener(eventType, func) Listen for event
<inner>	askPermissions(permissions) Ask for permissions.
<inner>	checkLogin() Check logged in status for first call in Flash
<inner>	createAlbum(name, location, description) Create album for the current user
<inner>	dispatchEvent(eventType, data) Dispatch Event
<inner>	dispatchFlashEvent(func) Dispatch Event to Flash Object.
<inner>	getAlbumPhotos(albumId) Get all photos for a given album (albumid)
<inner>	getAlbums(uid) Get albums for a user or logged in user (if left blank)
<inner>	getAppUsers() Get all users of the application
<inner>	getFriends() Get friends of the logged in user
<inner>	getNotifications() Get all notification messages of current user (includes group invites, event invites, .
<inner>	getSession() Get current sessions
<inner>	getStream(uid) Get stream of a user (uid)
<inner>	getStreamComments(post_id) Get comments of a streal story (post_id)
<inner>	getUserInfo(fields) Get info of the logged in user
<inner>	getUsersInfo(uids, fields) Get info of array of users (can contain 1 element)
<inner>	init() Initialize class
<inner>	isLoggedIn() Is user logged in?
<inner>	login() Log In
<inner>	logout() Log Out
<inner>	onFlashLoaded() Only called from Flash
<inner>	publish(user_message, attachment, action_links, target_id, user_message_prompt) Publish something to the wall of the current logged in user or to the target user (target_id)
<inner>	sendEmail(recipients, subject, text, fbml) Send e-mail to recipients.
<inner>	sendNotification(to_ids, notification) Send notification to an arrays of uids.

Class Detail

FBFlashBridge(appName, appKey, appURL, flashObject)

Author: Pieter Michels.

Parameters:
{String} appName: Application Name
{String} appKey: Application key
{String} appURL: Url to the xd_receiver.htm file
{String} flashObject: Reference to the Flash object

Requires:: jQuery library (> 1.2.6)

Method Detail

<inner> addEventListener(eventType, func)

Listen for event

Parameters:
{String} eventType: Type of event you are listening to
{String} func: Function that will be triggered when the event is fired

<inner> askPermissions(permissions)

Ask for permissions. http://wiki.developers.facebook.com/index.php/Extended_permissions

Parameters:
{String} permissions: The permission you want to ask, can be more than one (comma separated)

<inner> checkLogin()

Check logged in status for first call in Flash

<inner> createAlbum(name, location, description)

Create album for the current user

Parameters:
{String} name: Name of album
{String} location: Location of album
{String} description: Description of album

<inner> dispatchEvent(eventType, data)

Dispatch Event


Usage: dispatchEvent("flashFunction", parameter);

Parameters:
{String} eventType: Type of event
{String} data: Data passed as arguments to the functions that are listening

<inner> dispatchFlashEvent(func)

Dispatch Event to Flash Object.


Usage: dispatchFlashEvent("flashFunction", parameter1, parameter2, ...);

Parameters:
{String} func: Function to call in flash. Arguments can be passed as well as extra parameters

<inner> getAlbumPhotos(albumId)

Get all photos for a given album (albumid)

Parameters:
{String} albumId: Album id

<inner> getAlbums(uid)

Get albums for a user or logged in user (if left blank)

Parameters:
{String} uid: User id

<inner> getAppUsers()

Get all users of the application

<inner> getFriends()

Get friends of the logged in user

<inner> getNotifications()

Get all notification messages of current user (includes group invites, event invites, ...)

<inner> getSession()

Get current sessions

<inner> getStream(uid)

Get stream of a user (uid)

Parameters:
{String} uid: User id

<inner> getStreamComments(post_id)

Get comments of a streal story (post_id)

Parameters:
{String} post_id: Post id

<inner> getUserInfo(fields)

Get info of the logged in user

Parameters:
{Array} fields: List of fields

<inner> getUsersInfo(uids, fields)

Get info of array of users (can contain 1 element)

Parameters:
{Array} uids: List of uids you want to access
{Array} fields: List of fields

<inner> init()

Initialize class

<inner> isLoggedIn()

Is user logged in?

<inner> login()

<inner> logout()

Log Out

<inner> onFlashLoaded()

Only called from Flash

<inner> publish(user_message, attachment, action_links, target_id, user_message_prompt)

Publish something to the wall of the current logged in user or to the target user (target_id)

Parameters:
user_message
attachment
action_links
target_id
user_message_prompt

<inner> sendEmail(recipients, subject, text, fbml)

Send e-mail to recipients.

Parameters:
{String} recipients: Comma separated list of user ids
{String} subject: The subject
{String} text: The e-mail message
{String} fbml: FBML included in e-mail

<inner> sendNotification(to_ids, notification)

Send notification to an arrays of uids. Notification can contain html.

Parameters:
{String} to_ids: List of user ids
{String} notification: Notification message

Classes

Class FBFlashBridge