MsgCommunicator: Delphi Instant Messaging (IM) SDK
for easy creation of custom messenger system


TMsgClient.GetContacts
TMsgClient
Top 

Gets a list of contacts of this client from the server.

function GetContacts: Integer;

Description
Call GetContacts to obtain a contact list from the server you connected to. GetContacts sends command to the server, waits for an answer, then updates local contacts list of this client and returns MSG_COMMAND_OK if this operation executed successfully, otherwise it returns one of the following error codes:

Name
Value
MSG_Error_GetContacts_NotConnected   
MSG_Error_GetContacts_SendCommandFailed   
MSG_Error_GetContacts_ReceiveResultFailed   
MSG_Error_GetContacts_InvalidParams   
MSG_Error_GetContacts_InvalidServerReply   
MSG_Error_GetContacts_Failed   
MSG_Error_GetContacts_UserDoesNotExist
MSG_Error_GetContacts_NotLogged
60040   
60041   
60042   
60043   
60044   
60045   
60046
60107


Here you can see the full list of the Return Codes and Error Codes of Client Methods.

GetContacts is implicitly called when you connect to the server with existing UserID and when you register new user, so there is no need to re-read it.

To learn details of a user from contact list, read Contacts property.

To get a number of existing contacts, read ContactCount property.

If you need to get the name of the contact according to contact settings, call GetContactDisplayName.


© AidAim Software MsgCommunicator: Delphi Messenger Sdk Instant Messaging Sdk Im Sd