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


MsgCommunicator

Brief Memo
Top  Previous  Next


How to start.
Compile Client and Server demos. Run Server on one machine and distribute Client to all users' computers.

Networking.
TCP/IP network of any configuration, UDP protocol. If you need something special, please contact support@aidaim.com.
Do not forget to allow local/remote ports in firewalls.

Connecting.
- Registered user. Set UserID then call Connect or set Connected to True.
- New user. Call Connect then prepare UserInfo (you must set UserName at least) and register new user.
Connection settings can be tuned in ConnectionParams before connecting.
You can add connecting depended specific actions by setting BeforeConnect and/or AfterConnect event handlers.

Messaging.
- Methods:
   procedure SendMessage(ToUserID: Cardinal; const Text: String); overload;
   procedure SendMessage(ToUserID: Cardinal; Buffer: PChar; Size: Integer); overload;
   procedure SendMessage(ToUserID: Cardinal; Stream: TStream); overload;
- Events:
   OnReceiveTextMessage
   OnReceiveBinaryMessage
   OnReceiveStreamMessage

User details and users database.
- Methods:
   RegisterNewUser - Registers new user at server
   UpdateMyUserInfo - Changes user details
   IsUserExisting - Determines if user is already registered at server
   GetUserInfo - Determines if user with specified UserID exists in the server database and gets its details

Working with contact list.
- Methods:
AddUserToMyContacts - Adds new user to contact list of the client (i.e. current user specified by UserID property)  
   RemoveUserFromMyContacts - Removes user from contact list of this client
   GetMyContactsList - Gets full list of contacts for this client from all servers it is connected to
- Events:
   OnUserOnLine - Occurs when user presented in your contact list sets connection to the server
   OnUserOffLine - Occurs when user presented in your contact list disconnects from the server

Custom commands.
To send commands, call SendCommand.
To receive custom commands, set OnReceiveCommand event handler.

Disconnect.
- Methods:
   Disconnect
   DisconnectAll
- Events:
   BeforeDisconnect
   AfterDisconnect
   OnServerShutdown

Writing server application.
See TMsgServer.


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