Class: Services_Facebook_Notifications

Source Location: /Services_Facebook-0.2.14/Services/Facebook/Notifications.php

Class Overview

Services_Facebook_Common
   |
   --Services_Facebook_Notifications

Facebook Notifications Interface

Author(s):

Joe Stump <joe at joestump.net>

Version:

Release: 0.2.14

Methods

Inherited Variables

Class: Services_Facebook_Common

Services_Facebook_Common::$api
Services_Facebook_Common::$sessionKey
Services_Facebook_Common::$useSessionSecret
Services_Facebook_Common::$version

Inherited Methods

Class: Services_Facebook_Common

Services_Facebook_Common::__construct(): Construct
Services_Facebook_Common::callMethod(): Call method
Services_Facebook_Common::checkRequest(): Check if request resulted in an error
Services_Facebook_Common::getAPI(): Get API
Services_Facebook_Common::parseResponse(): parseResponse
Services_Facebook_Common::sendRequest(): Send a request to the API
Services_Facebook_Common::setAPI(): Set API
Services_Facebook_Common::signRequest(): Sign the request
Services_Facebook_Common::updateArgs(): Update arguments

Class Details

[line 36]
Facebook Notifications Interface

Author: Joe Stump <joe@joestump.net>
Version: Release: 0.2.14
Link: http://wiki.developers.facebook.com
License: New BSD License

[ Top ]

Method Detail

get [line 62]

object Instance get(
)

Get notifications for current user

Returns all of the outstanding notifications for the given user, which include messages, pokes, shares, friend requests, group invites, and event invites.

Return: of SimpleXmlElement
Link: http://wiki.developers.facebook.com/index.php/Notifications.get
Access: public

[ Top ]

send [line 92]

mixed send(
array
$to, string
$notification, [string
$type = self::TYPE_USER_TO_USER])

Send a notification

When you send a notification you can send it to an array of Facebook uids. The notification should be valid FBML. Optionally, you can pass

Optionally, you can pass a type parameter. 'general' (default) notifications require an active user session, while 'announcement' does not.

The result value can either be true or a string. The string is a valid URI that you should redirect the user to for confirmation.

Return: Confirmation URI or true
See: self::TYPE_GENERAL, self::TYPE_ANNOUNCEMENT
Link: http://wiki.developers.facebook.com/index.php/Notifications.send
Access: public

Parameters:

array	`$to`	—	Facebook uids to send note to
string	`$notification`	—	FBML of notification
string	`$type`	—	Type of notification

[ Top ]

sendEmail [line 135]

array sendEmail(
array
$recipients, string
$subject, [mixed
$text = null])

Send an email out to application users

Return: An array of success uids the email went out too
Author: Jeff Hodsdon <jeffhodsdon@gmail.com>
Link: http://wiki.developers.facebook.com/index.php/Notifications.sendEmail
Access: public

Parameters:

array	`$recipients`	—	An array of Facebook uids to send too
string	`$subject`	—	Subject of the email
mixed	`$text`	—	Text or FBML and text for the body of the email

[ Top ]