CloudBuilder::CTribeManager Class Reference

#include <CTribeManager.h>

Public Member Functions
void	ListUsers (const char *aContainsString, int aLimit, int aSkip, CResultHandler *aHandler)
DEPRECATED void	ListUsers (CResultHandler *aHandler, const char *aContainsString, int aLimit, int aSkip)
void	ListFriends (const char *aDomain, CResultHandler *aHandler)
DEPRECATED void	ListFriends (CResultHandler *aHandler, const char *aDomain="private")
void	BlacklistFriends (const char *aDomain, CResultHandler *aHandler)
DEPRECATED void	BlacklistFriends (CResultHandler *aHandler, const char *aDomain="private")
void	ChangeRelationshipStatus (const CotCHelpers::CHJSON *aOptions, CResultHandler *aHandler)
DEPRECATED void	ChangeRelationshipStatus (CResultHandler *aHandler, const CotCHelpers::CHJSON *aOptions)
void	FriendsBestHighScore (int aCount, int aPage, const char *aMode, const char *aDomain, CResultHandler *aHandler)
DEPRECATED void	FriendsBestHighScore (CResultHandler *aHandler, int aCount, int aPage, const char *aMode, const char *aDomain="private")
void	ListNetworkFriends (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)
DEPRECATED void	ListNetworkFriends (CResultHandler *aHandler, const CotCHelpers::CHJSON *aConfiguration)
DEPRECATED void	ListNetworkFriends (CResultHandler *aHandler, const char *aNetwork, const CotCHelpers::CHJSON *aFriends)
void	FindOpponents (const CotCHelpers::CHJSON *aFilter, const char *aDomain, CResultHandler *aHandler)
DEPRECATED void	FindOpponents (CResultHandler *aHandler, const CotCHelpers::CHJSON *aFilter, const char *aDomain="private")
void	Terminate ()
eErrorCode	friendsGC (const CotCHelpers::CHJSON *friends)

Static Public Member Functions
static CTribeManager *	Instance ()

Friends
struct	singleton_holder< CTribeManager >

Detailed Description

The CTribeManager class is used to manage friends for a profile, and to allow this profile to send friendship requests to other profiles. This class manages all the notifications involved in the process.

Member Function Documentation

BlacklistFriends()

void CloudBuilder::CTribeManager::BlacklistFriends	(	const char *	aDomain,
		CResultHandler *	aHandler
	)

Method used to retrieve the application's blacklisted gamers of the currently logged in profile.

Parameters

aDomain	is the domain where you want to get blacklist friends. "private" means it's for this game only.
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: "blacklisted" : [ {"gamer_id": "5402c6c3bcf7c96fa04e625f", profile" :{}} ],

ChangeRelationshipStatus()

void CloudBuilder::CTribeManager::ChangeRelationshipStatus	(	const CotCHelpers::CHJSON *	aOptions,
		CResultHandler *	aHandler
	)

Method used to change to a friendship inside the application.

Parameters

aOptions

a json object which must contain "id" (string) : is a C string holding the gamer_id of the user to change the relation with. "status" (string) : is string with either: "add" : to be friend with "blacklist" : to blacklist the gamer "forget" : to remove any relationship "domain" (string) : the domain on which the friendship has to be modified. "osn" (json): an optional json object to specify the OS notification to be send (see the aNaotifiaction param of CUserManager::PushEvent)

aHandler

result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: "done" : 1

FindOpponents()

void CloudBuilder::CTribeManager::FindOpponents	(	const CotCHelpers::CHJSON *	aFilter,
		const char *	aDomain,
		CResultHandler *	aHandler
	)

Method used to retrieve random opponents for a match.

Parameters

aFilter	is a JSON object which describes the users' properties that should be matched to be considered for inclusion in the returned list.The syntax is the one used by MongoDB: http://docs.mongodb.org/manual/reference/operator/query/#query-selectors
aDomain	is the domain where you want to retrieve opponents. "private" means it's for this game only.
aHandler	result handler whenever the call finishes (it might also be synchronous)

FriendsBestHighScore()

void CloudBuilder::CTribeManager::FriendsBestHighScore	(	int	aCount,
		int	aPage,
		const char *	aMode,
		const char *	aDomain,
		CResultHandler *	aHandler
	)

Method used to retrieve the best High Scores for this application.

Parameters

aCount	is the number of best scores you want to retrieve, default is 10
aPage	is the number of the page to retrieve. the default is 1
aMode	is a C string holding the game mode for which you want to retrieve the best High Scores.
aDomain	is the domain where you want to retrieve leaderboards. "private" means it's for this game only.
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { <aMode>: { "maxpage" : 10, "rankOfFirst" : 1, "page" : 1, "scores" : [] }

Instance()

static CTribeManager* CloudBuilder::CTribeManager::Instance ( )

static

Use this method to obtain a reference to the CTribeManager.

Returns

the one and only instance of this manager

ListFriends()

void CloudBuilder::CTribeManager::ListFriends	(	const char *	aDomain,
		CResultHandler *	aHandler
	)

Method used to retrieve the application's friends of the currently logged in profile.

Parameters

aDomain	is the domain where you want to get friends. "private" means it's for this game only.
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: "friends" : [ {"gamer_id": "5402c6c3bcf7c96fa04e625f", profile" :{}} ],

ListNetworkFriends()

void CloudBuilder::CTribeManager::ListNetworkFriends	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method used to retrieve all the friends in an external network, for the currently logged in profile.

Parameters

aConfiguration	is a JSON object which must contain "network" : string, name of network in ("facebookId", "googleplusId", "gamecenter") "friends" : each key is a friend ID for the network and contains data that will be returning after matching. (for game center this param is ignored) i.e. : { "100199910": { "name" : "roland"}, "10015675710": { "name" : "mike"}} "automatching" : boolean (optionnal)
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

gives an indication if the request was correctly sent or not. enNoErr is sent if the request was sent.

ListUsers()

void CloudBuilder::CTribeManager::ListUsers	(	const char *	aContainsString,
		int	aLimit,
		int	aSkip,
		CResultHandler *	aHandler
	)

Method used to check/retreive users from Clan of the Cloud community.

Parameters

aContainsString	is a C string which is a pseudo, an email or displayName
aLimit	is the number of results you want to retrieve, default is 10
aSkip	is the number of results to skip before returning users. the default is 0
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: "count" : 50, "results" : [{ "_id" : "xxxx", "profile" : {} }] } where count is the maximum possible anwsers

Terminate()

void CloudBuilder::CTribeManager::Terminate

(

)

You need to call this in CClan::Terminate().

---

The documentation for this class was generated from the following file:

• E:/XtraLife/GitHub/XtraLife/cloudbuilder/CloudBuilder/Headers/CTribeManager.h