class public FB.ApiClient

This is the main object for using the Facebook REST API.

Base Class

System.Object

Follow the base class link to learn inherited methods and properties

Constructor

public FB.ApiClient (string apiKey)

Description

Constructor

Parameters

Name

Type

Definition

apiKey

string

Application API key, seehttp://www.facebook.com/developers to create one.

Public Methods

public FB.PendingResult connect_getUnconnectedFriendsCount (SequencerBase sequencer)

Getting the # of friends who have pending accounts on a connect site.

public FB.PendingResult events_get (string uid, array eids, int startTime, int endTime, string rsvpStatus, SequencerBase sequencer)

public FB.PendingResult events_getMembers (int eid, SequencerBase sequencer)

public FB.PendingResult fbml_refreshImgSrc (string url, SequencerBase sequencer)

public FB.PendingResult fbml_refreshRefUrl (string url, SequencerBase sequencer)

public FB.PendingResult fbml_setRefHandle (string handle, string fbml, SequencerBase sequencer)

public FB.PendingResult feed_publishUserAction (int template_bundle_id, object template_data, array target_ids, string body_general, int story_size, SequencerBase sequencer)

public void feed_registerTemplateBundle ()

This is just a stub function, since this call should be done server side.

public FB.PendingResult fql_query (string query, SequencerBase sequencer)

public FB.PendingResult friends_areFriends (array uids1, array uids2, SequencerBase sequencer)

public FB.PendingResult friends_get (string flid, SequencerBase sequencer)

Return a array of friends

public FB.PendingResult friends_getAppUsers (SequencerBase sequencer)

public FB.PendingResult friends_getLists (SequencerBase sequencer)

public FB.PendingResult groups_get (string uid, array gids, SequencerBase sequencer)

public FB.PendingResult groups_getMembers (int gid, SequencerBase sequencer)

public FB.PendingResult marketplace_createListing (string listing_id, bool show_on_profile, object listing_attrs, SequencerBase sequencer)

public FB.PendingResult marketplace_getCategories (SequencerBase sequencer)

public FB.PendingResult marketplace_getListings (array listing_ids, array uids, SequencerBase sequencer)

public FB.PendingResult marketplace_getSubCategories (string category, SequencerBase sequencer)

public FB.PendingResult marketplace_RemoveListing (string listing_id, string status, SequencerBase sequencer)

public FB.PendingResult marketplace_Search (string category, string subcategory, string query, SequencerBase sequencer)

public FB.PendingResult notifications_get (SequencerBase sequencer)

public FB.PendingResult notifications_send (array to_ids, string notification, SequencerBase sequencer)

public FB.PendingResult notifications_sendEmail (array recipients, string subject, string text, string fbml, SequencerBase sequencer)

public FB.PendingResult pages_getInfo (array fields, array page_ids, string uid, SequencerBase sequencer)

public FB.PendingResult pages_isAdmin (int page_id, SequencerBase sequencer)

public FB.PendingResult pages_isAppAdded (int page_id, SequencerBase sequencer)

public FB.PendingResult pages_isFan (int page_id, string uid, SequencerBase sequencer)

public FB.PendingResult photos_addTag (string pid, string tag_uid, string tag_text, int x, int y, object tags, SequencerBase sequencer)

public FB.PendingResult photos_createAlbum (string name, string location, string description, SequencerBase sequencer)

public FB.PendingResult photos_get (object subj_id, object aid, array pids, SequencerBase sequencer)

public FB.PendingResult photos_getAlbums (string uid, array aids, SequencerBase sequencer)

public FB.PendingResult photos_getTags (array pids, SequencerBase sequencer)

public bool preloadFQL_get (OnRequestCompleted callback)

Uses callback on any preload fql data

public FB.PendingResult privacy_canSee (array uids, array whats, SequencerBase sequencer)

public FB.PendingResult profile_getFBML (string uid, SequencerBase sequencer)

public FB.PendingResult profile_setFBML (string uid, string profile, string profile_action, string mobile_profile, string profile_main, SequencerBase sequencer)

public void requireLogin (CallbackWithException callback)

Ensure user is logged in and has granted application permission.This method needs to be called before any other API calls.You can only proceeds to make other Facebook API call afterthe callback functionis invoked with no exception.

public FB.PendingResult users_getInfo (array uids, array fields, SequencerBase sequencer)

public FB.PendingResult users_getLoggedInUser (SequencerBase sequencer)

public FB.PendingResult users_hasAppPermission (string ext_perm, SequencerBase sequencer)

public FB.PendingResult users_isAppAdded (SequencerBase sequencer)

public FB.PendingResult users_isAppUser (SequencerBase sequencer)

Determine if the user has authorized this application.

public FB.PendingResult users_setStatus (string status, bool clear, bool status_includes_verb, SequencerBase sequencer)

Note: An extended permission is necessary to successfully call thismethod. SeeExtended Permissions for details.

Public Static Methods

public static void defaultCreateSession (ApiClient apiClient, CreateSessionCallbackCompleted callback)

Most basic method to call in order to get a session for thecurrent user; redirect to the Facebook login screen, and havethe user login if necessary, then be redirected back.

public static bool sessionIsExpired (SessionRecord record)

Determine if a particular session is expired yet. Note thatin the event that the SessionRecord came from a cookie, it ispossible that it was invalidated in a manner other than typicalexpiration.

Properties

public apiKey

API key of your application

Getter

public string get_apiKey()

public session

Session information for current session

Getter

public SessionRecord get_session()

Setter

public void set_session(SessionRecord value)

public sessionWaitable

Getter

public Waitable get_sessionWaitable()

Fields

public static CreateSessionDelegate createSessionDelegate

The delegate to call when we don't currently have a session forthe user, and need to obtain one.

Back to namespace FB