123
This commit is contained in:
romkazvo
@@ -0,0 +1,886 @@
|
||||
<HTML>
|
||||
|
||||
<HEAD>
|
||||
<TITLE>Ubi.com GameService SDK</TITLE>
|
||||
<LINK href="./gs-sdk-doc.css" rel="stylesheet" type="text/css">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
||||
<h1>Functions<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group2.html">Friends Service</a>]</small>
|
||||
</h1>Messages sent to the game service.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a0">Friends_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status-messages handling relating to the friend service. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a1">FriendsSend_Connect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is deprecated. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a2">FriendsSend_Disconnect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the friends service. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a3">FriendsSend_Login</a> (GSint lStatus=0, GSint lMood=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Log into the friends service. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a4">FriendsSend_AddFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new friend. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a5">FriendsSend_DelFriend</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a friend from friend list. </em> <a href="#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a6">FriendsSend_FriendList</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all friends in friend list. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds someone to the player's ignore-list. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes someone to the player's ignore-list. </em> <a href="#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ignore-list of the player. </em> <a href="#a9"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a10">FriendsSend_PagePlayer</a> (const GSchar *szUsername, const GSchar *szMessage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a page to a friend. </em> <a href="#a10"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a11">FriendsSend_PeerPlayer</a> (const GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send data to a friend. </em> <a href="#a11"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a12">FriendsSend_StatusChange</a> (GSint iStatus, GSint iMood)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the player status. </em> <a href="#a12"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a13">FriendsSend_ChangeFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change friend properties. </em> <a href="#a13"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a14">FriendsSend_SearchPlayer</a> (const GSchar *szUsername, const GSchar *szSurName, const GSchar *szFirstName, const GSchar *szCountry, const GSchar *szEmail, GSint iSex, const GSchar *szGame)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for a player. </em> <a href="#a14"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a15">FriendsSend_GetPlayerScores</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get player score. </em> <a href="#a15"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send friend-related messages to the server <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::Friends_Engine" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool Friends_Engine </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiMaxPostingDelay</em> = 500, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiMaxsOperationalDelay</em> = 800</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>Updates the connection between the client and the server, and handles the delivery of queued up messages and reception of messages relating to the friend service. This function should be called regularly to ensure that the application will run smoothly.</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>The connection is ok and function call was a success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>There has been a problem with the communication of messages between the client and the server</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>uiMaxPostingDelay</em> </td><td>The maximum time to be spent inside the engine to read incomming messages and posting them to the message queue. (Milliseconds) </td></tr>
|
||||
<tr><td valign=top><em>uiMaxsOperationalDelay</em> </td><td>The maximum time to be spent inside the engine to decode message in the queue and calling appropriate callback. (Milliseconds) </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::FriendsSend_AddFriend" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_AddFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGroup</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iOptions</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to add a new friend to the player's friend list. These friends are stored on the server so you don't have to be stored locally.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for the new friend<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Successfully added new friend </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure when added new friend</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the player that will be added </td></tr>
|
||||
<tr><td valign=top><em>szGroup</em> </td><td>The group to which the player will be added. This is just a string so that is saved for the friend. You can have any number of groups. </td></tr>
|
||||
<tr><td valign=top><em>iOptions</em> </td><td>Friend options. See define.h </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a13" doxytag="GSClientLibrary.h::FriendsSend_ChangeFriend" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_ChangeFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGroup</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iOptions</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to change friend properties like options or the group he is in.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> will have the updated info.</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>username of the friend </td></tr>
|
||||
<tr><td valign=top><em>szGroup</em> </td><td>New group of the player </td></tr>
|
||||
<tr><td valign=top><em>iOptions</em> </td><td>Friend options </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::FriendsSend_Connect" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_Connect </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>You don't need to call this function anymore to connect to the friends service. See <a class="el" href="group__group2__1.html#a3">FriendsSend_Login()</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Successfully connected to the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to connect to the friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::FriendsSend_DelFriend" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_DelFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szUsername</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to remove a friend from the player's friend list</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Successfully removed friend </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure when removing friend</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>username of the friend we want to remove </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::FriendsSend_Disconnect" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_Disconnect </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to disconnect from the friends service</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Successfully disconnect from the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to disconnect from the friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::FriendsSend_FriendList" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_FriendList </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to get the list of friends that are in our friend list. This normally doesn't have to be called because the server pushes the <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> callbacks to the client. If client for some reason forgets the list of friends they have this function can called to force an <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for all their friends.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for every friend</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a15" doxytag="GSClientLibrary.h::FriendsSend_GetPlayerScores" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_GetPlayerScores </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szUsername</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>DEPRECATED: This function has been replaced by the Ladder Query Service</dd></dl>
|
||||
<dl compact><dt><b>Callback:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>Username of the player we want to get the score from. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::FriendsSend_IgnorePlayer" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSRESULT FriendsSend_IgnorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szPlayer</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function adds a ubi.com username to the player's ignore-list. When someone is on a player's ignore-list, it cannot send pages or peer-messages to the player ignoring it. The ignore-list is stored remotely on the servers.</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player to ignore (case-insensitive)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADARG</em> </td><td>The szPlayer argument is NULL or empty </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::FriendsSend_ListIgnoredPlayers" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSRESULT FriendsSend_ListIgnoredPlayers </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function gets the remotely stored ignore-list of a player</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers<br></a> <a class="el" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::FriendsSend_Login" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_Login </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSint </td>
|
||||
<td class="mdname" nowrap> <em>lStatus</em> = 0, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>lMood</em> = 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to log into the friends service. See define.h for the list of statuses.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for all your friends<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Successfully logged into the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to log into the friends service</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>lStatus</em> </td><td>Status of the player (default at 0) </td></tr>
|
||||
<tr><td valign=top><em>lMood</em> </td><td>Mood of the player (default at 0) </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::FriendsSend_PagePlayer" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_PagePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szMessage</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to send a page to a player. If the player isn't online the message will be saved and sent to them the next time they login to the friends service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a> telling you if the message was sent. <a class="el" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a> is sent to the other player</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the recipient player </td></tr>
|
||||
<tr><td valign=top><em>szMessage</em> </td><td>The actual message </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::FriendsSend_PeerPlayer" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_PeerPlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSvoid * </td>
|
||||
<td class="mdname" nowrap> <em>p_Buffer</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiLength</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to send binary data to a friend. You can only send peer messages to players that are have the same client version as you. </dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer<br></a> <a class="el" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a> is sent to the other player<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>Username of the recipient player of the data. </td></tr>
|
||||
<tr><td valign=top><em>p_Buffer</em> </td><td>Data buffer. </td></tr>
|
||||
<tr><td valign=top><em>uiLength</em> </td><td>Lenght of the buffer. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a14" doxytag="GSClientLibrary.h::FriendsSend_SearchPlayer" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_SearchPlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szSurName</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szFirstName</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szCountry</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szEmail</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iSex</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to search a player in the database. Any of the arguments can be left blank, the server will return a list of matching player that as the search pattern.</dd></dl>
|
||||
<dl compact><dt><b>Callback:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>username of the player </td></tr>
|
||||
<tr><td valign=top><em>szSurName</em> </td><td>Player last name </td></tr>
|
||||
<tr><td valign=top><em>szFirstName</em> </td><td>Player first name </td></tr>
|
||||
<tr><td valign=top><em>szCountry</em> </td><td>Player's country </td></tr>
|
||||
<tr><td valign=top><em>szEmail</em> </td><td>Player's email </td></tr>
|
||||
<tr><td valign=top><em>iSex</em> </td><td>Player's gender </td></tr>
|
||||
<tr><td valign=top><em>szGame</em> </td><td>Player's favorite game </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a12" doxytag="GSClientLibrary.h::FriendsSend_StatusChange" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSbool FriendsSend_StatusChange </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSint </td>
|
||||
<td class="mdname" nowrap> <em>iStatus</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iMood</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to set a new status and mood for the current player.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> is sent to anyone who has the player as friend.</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>iStatus</em> </td><td>New status of the player </td></tr>
|
||||
<tr><td valign=top><em>iMood</em> </td><td>New mood of the player </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::FriendsSend_UnignorePlayer" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> GSRESULT FriendsSend_UnignorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szPlayer</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This function removes a ubi.com username to the player's ignore-list.</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player to remove from the ignore-list (case-insensitive)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADARG</em> </td><td>The szPlayer argument is NULL or empty </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>
|
||||
<p align="right">
|
||||
<i>Ubi.com GameService SDK - ©UbiSoft Entertainment 2002 </i><br>
|
||||
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user