Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.FacebookIntegration


00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146
00147
00148
00149
00150
00151
00152
00153
00154
00155
00156
00157
00158
00159
00160
00161
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171
00172
00173
00174
00175
00176
00177
00178
00179
00180
00181
00182
00183
00184
00185
00186
00187
00188
00189
00190
00191
00192
00193
00194
00195
00196
00197
00198
00199
00200
00201
00202
00203
00204
00205
00206
00207
00208
00209
00210
00211
00212
00213
00214
00215
00216
00217
00218
00219
00220
00221
00222
00223
00224
00225
00226
00227
00228
00229
00230
00231
/**
 * Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.
 *
 * This is the base class for Facebook integration (each platform has a subclass
 */
class FacebookIntegration extends Object
	native
	config(Engine)
	transient;


cpptext
{
	// the exec functions will call these virtual functions to allow intrinsic subclasses to handle
	// the actual functionality
	virtual UBOOL NativeInit()
	{
		return FALSE;
	}
	virtual UBOOL NativeAuthorize()
	{
		return FALSE;
	}
	virtual UBOOL NativeIsAuthorized()
	{
		return FALSE;
	}
	virtual void NativeDisconnect()
	{
	}
	virtual void NativeWebRequest(const FString& URL, const FString& POSTPayload)
	{
	}
	virtual void NativeFacebookRequest(const FString& GraphRequest)
	{
	}

	/**
	 * Perform any per-frame actions
	 */
	virtual void Tick(FLOAT DeltaSeconds)
	{

	}

	/**
	 * Called by platform when authorization has completed
	 */
	void OnAuthorizationComplete(UBOOL bSucceeded);

	/**
	 * Called by platform when FB request has completed
	 */
	void OnFacebookRequestComplete(const FString& JsonString);

	/**
	 * Called by platform when web request has completed
	 */
	void OnWebRequestComplete(const FString& Response);
}


/** The application ID to link to */
var config string AppID;

/** Username of the current user */
var string Username;

/** Id of the current user */
var string UserId;

/** Access token as retrieved from FB */
var string AccessToken;

/** Delegates to call when all async initialization and authorization has completed */
var protected array<delegate<OnAuthorizationComplete> > AuthorizationDelegates;

/** Delegates to call when a facebook request has completed */
var protected array<delegate<OnFacebookRequestComplete> > FacebookRequestCompleteDelegates;

/** Delegates to call when a web request has completed */
var protected array<delegate<OnWebRequestComplete> > WebRequestCompleteDelegates;



/**
 * Perform any needed initialization
 */
native event bool Init();

/**
 * Starts the process of allowing the app to use Facebook
 */
native event bool Authorize();

/**
 * @return true if the app has been authorized by the current user
 */
native event bool IsAuthorized();

/**
 * Kicks off a generic web request (response will come via delegate call)
 *
 * @param URL The URL for the request, can be http or https (if the current platform supports sending https)
 * @param POSTPayload If specified, the request will use the POST method, and the given string will be the payload (as UTF8)
 */
native event WebRequest(string URL, string POSTPayload);

/**
 * Kicks off a Facebook GraphAPI request (response will come via delegate)
 *
 * @param GraphRequest The request to make (like "me/friends")
 */
native event FacebookRequest(string GraphRequest);

/**
 * Call this to disconnect from Facebook. Next time authorization happens, the auth webpage
 * will be shown again
 */
native event Disconnect();


/**
 * Delegate type to call when authorization is all completed
 */
delegate OnAuthorizationComplete(bool bSucceeded);

/**
 * Adds a delegate to the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function AddAuthorizationCompleteDelegate(delegate<OnAuthorizationComplete> InDelegate)
{
	// Add this delegate to the array if not already present
	if (AuthorizationDelegates.Find(InDelegate) == INDEX_NONE)
	{
		AuthorizationDelegates.AddItem(InDelegate);
	}
}

/**
 * Removes a delegate from the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function ClearAuthorizationCompleteDelegate(delegate<OnAuthorizationComplete> InDelegate)
{
	local int RemoveIndex;

	// Remove this delegate from the array if found
	RemoveIndex = AuthorizationDelegates.Find(InDelegate);
	if (RemoveIndex != INDEX_NONE)
	{
		AuthorizationDelegates.Remove(RemoveIndex,1);
	}
}

/**
 * Delegate type to call when a generic facebook request is completed
 */
delegate OnFacebookRequestComplete(string JsonString);

/**
 * Adds a delegate to the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function AddFacebookRequestCompleteDelegate(delegate<OnFacebookRequestComplete> InDelegate)
{
	// Add this delegate to the array if not already present
	if (FacebookRequestCompleteDelegates.Find(InDelegate) == INDEX_NONE)
	{
		FacebookRequestCompleteDelegates.AddItem(InDelegate);
	}
}

/**
 * Removes a delegate from the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function ClearFacebookRequestCompleteDelegate(delegate<OnFacebookRequestComplete> InDelegate)
{
	local int RemoveIndex;

	// Remove this delegate from the array if found
	RemoveIndex = FacebookRequestCompleteDelegates.Find(InDelegate);
	if (RemoveIndex != INDEX_NONE)
	{
		FacebookRequestCompleteDelegates.Remove(RemoveIndex,1);
	}
}


/**
 * Delegate type to call when a generic Web request is completed
 */
delegate OnWebRequestComplete(string Response);

/**
 * Adds a delegate to the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function AddWebRequestCompleteDelegate(delegate<OnWebRequestComplete> InDelegate)
{
	// Add this delegate to the array if not already present
	if (WebRequestCompleteDelegates.Find(InDelegate) == INDEX_NONE)
	{
		WebRequestCompleteDelegates.AddItem(InDelegate);
	}
}

/**
 * Removes a delegate from the list of listeners
 *
 * @param InDelegate the delegate to use for notifications
 */
function ClearWebRequestCompleteDelegate(delegate<OnWebRequestComplete> InDelegate)
{
	local int RemoveIndex;

	// Remove this delegate from the array if found
	RemoveIndex = WebRequestCompleteDelegates.Find(InDelegate);
	if (RemoveIndex != INDEX_NONE)
	{
		WebRequestCompleteDelegates.Remove(RemoveIndex,1);
	}
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Class file time: må 14-2-2011 21:08:02.000 - Creation time: ti 22-3-2011 19:57:05.549 - Created with UnCodeX