IMClient Class

IMClient component enables easy integration of instant Messaging(IM) functionality within any .NET application.

IMSDK.IMClient

public class IMClient : ComponentModel.Component;

Visual Basic

Public Class IMClient
Inherits ComponentModel.Component

Description

Remarks

The IMClient component enables Encrypted Instant Messaging .The Client component is feature-rich and flexible, It supports Custom Encrypted IM Protocol with IMServer,The encryption can be Controlled by a Secret key thus making it more secure.

Group

Classes

Members

Topics

Name	Description
IMClient Members
IMClient Enumerations
IMClient Methods
IMClient Properties
IMClient Events

Public Methods

Public Constructors

	Name	Description
	New	This is New, a member of class IMClient.

IMClient Enumerations

	Name	Description
	AuthorizationStatus
	ConnectionSpeed
	Status

IMClient Methods

	Name	Description
	BeginAddFriend	This Method Allows Users to add a friend to there contacts List
	BeginAddGroup	This Method Allows Users to add a group to there Contacts list.
	BeginFileRequestAccepted	When a Online Contacts Sends a File this method is used to Accept the File Transfer
	BeginFileRequestRejected	When a Online Contacts Sends a File this method is used to Reject the File Transfer
	BeginFriendAuthorizationAccepted	This Method Allows Users to accept incoming Friend add Invitations
	BeginFriendAuthorizationDenied	This Method Allows Users to Reject incoming friend add Invitations
	BeginFriendBlockUnBlock	This Method Allows Users To Block or Unblock a specific Contact
	BeginLogin	This Method Allows Users to login with Username and Password.
	BeginLogOut	This Method Allows Users to Logout
	BeginMoveFriend	This Method Allows Users to Move a Friend From One Group to another
	BeginRemoveFriend	This Method Allows Users to Remove the Contact
	BeginRemoveGroup	This Method Allows Users to Remove a Group
	BeginRenameGroup	This Method Allows Users to Rename a Group
	BeginSearchUsers	This Method Allows Users Search For Other users
	BeginSendFile	This Method Allows Users to Send a file to Online Contacts
	BeginSendMessage	This Method Allows Users to send a Message to Online and Offline Contacts
	BeginSetUserStatus	This Method Allows Users to Set the Status (Online,Busy etc)
	BeginSignUp	This Method Allows users to Create a new account
	BeginTypingIndication	This Method Allows Users to see wether his friend is typing a message to them or not
	FindContactListFriend	This Method Allows Users to Find IMSDK.Friends.MFriend for specific username
	GetDisplayPicture	This Method Allows Users to Get there Own Display Picture
	GetFriendUpdatedDisplayPicture	This Method Allows Users to Get Contact's Display Picture
	Listen	This Method Allows the IMClient to Start Listening
	StopListening	This Method Allows IMClient to Close the listening Port.
	UpdateDisplayPicture	This Method Allows Users Change there Display Picture and Update all Online friends with it

IMClient Properties

	Name	Description
	DefaultFileSavePath	This Property is Used to Set the default file save path
	DefaultFileTransferPort	This Property is Used to Specify Default File Transfer Port
	DisplayPicturesSavePath	This Property is Used to Save Display Pictures
	FileConnectionSpeed	This Property is Used to Specify the Connection Speed for FileTransfer
	FileEncryption	This Property is Used to Encrypt all Outgoing File Transfers
	FileEncryptionKey	This Property is Used to Set the Key for File Encryption
	MAXFriends	This Property is Used to Restrict the Number of Friends
	MAXGroups	This Property is Used to Restrict the Number of Groups
	NameofGroupWithOutAnyGroup	This Property is Used to Set Group Name for Those Friends which do not belong to any Group
	PortToListen	This Property is Used to Set the Port where the IMClient Listens for the Server
	SecretKey	This Property is Used to Encrypted all Messages and commands that are sent to the server
	ServerUrl	This Property is Used to Specify the location of IMServer

IMClient Events

	Name	Description
	OnCustomCommandReceived	This Event Shows the Custom data which was Sent by the IM Server
	OnDisplayPictureUpdated	This Event Fires when IMSDK.IMClient.UpdateDisplayPicture completes
	OnError	When an exception occurs in IMClient
	OnFilePortOpened	This Event Fires when Port is Opened for File Transfer
	OnFileReceiveCancelled	When File is canceled by the Receiving IMClient
	OnFileReceiveDisconnected	When Listening Port is Closed and IMClient gets Disconnected from the Sending IMClient
	OnFileReceiveFiledata	When File is Receiving,number of Bytes received are reurtrned
	OnFileReceiveFileTransferComplete	When File Transfer Completes
	OnFileRequestRejected	When Sub IMSDK.IMClient.BeginFileRequestRejected is called then this event is fired on File sending IMClient
	OnFileSendCancelled	When File is canceled by the Sending IMClient
	OnFileSendComplete	When File Transfer Completes
	OnFileSendDisconnected	When Listening Port is Closed and IMClient gets Disconnected from the Receiving IMClient
	OnFileSendTransferring	When File is sending,number of Bytes sent are reurtrned
	OnFriendAMIBlocked	When a Logged in User Blocks there Contact. That contact is notified via this event that it is blocked
	OnFriendAMIUnBlocked	When a Logged in User Blocks there Contact. That contact is notified via this event that it is blocked
	OnFriendAskingPrimssion	When Some user Wants to Add this User as a Friend in there list
	OnFriendAuthorized	When IMSDK.IMClient.BeginAddFriend request is accepted by the IMClient
	OnFriendBlocked	When Logged in User Blocks a contact
	OnFriendDisplayPictureUpdated	When Display Picture of a Contact is Updated
	OnFriendNotAuthorized	When IMSDK.IMClient.BeginAddFriend request is rejected by the IMClient
	OnFriendOffline	When a Contact Goes offline
	OnFriendOnline	When a Contact comes Online
	OnFriendRemoved	When Logged In user is Being removed By its Contact
	OnFriendRemovedCompleted	when Friend is removed From the logged in user's Contacts list
	OnFriendsListUpdated	When Ever any Property of Contacts is Updated this event is fired
	OnFriendStatusChanged	when IMSDK.IMClient.Status of the Friend is changed
	OnFriendUnBlocked	When Logged in User Unblock's a contact
	OnGroupAdded	when IMSDK.IMClient.BeginAddGroup completes
	OnGroupRemoved	when IMSDK.IMClient.BeginRemoveGroup completes
	OnListening	When IMClient Starts Listening by opening a port
	OnLoggedin	When username and password is valid and user is logged in
	OnLoggedOut	When Logged in user is Logged out
	OnMessageDelivered	When Message is Successfully sent to the Online IMClient by the server
	OnMessageNotSent	When Message is Not Successfully sent to the Online IMClient by the server
	OnMessageReceived	When Message is Successfully received
	OnMoveFriendCompleted	When IMSDK.IMClient.BeginMoveFriend Completes
	OnNewFriendAdded	when IMSDK.IMClient.BeginAddFriend Completes
	OnNewFriendAlreadyAdded	when IMSDK.IMClient.BeginAddFriend does not completes because the friend is already added
	OnNewFriendDoesNotExsist	When Friend being added [ IMSDK.IMClient.BeginAddFriend ] does not exist on the server
	OnNoGroupFoundToRemove	When a invalid Group ID is Sepcifed
	OnOfflineMessageQueued	This Event is Fired When a Message is queued as a offline message
	OnOfflineMessageReceived	This Event Shows all or any Offline messages for the logged in user
	OnOnlineFriendRemoved	When Logged In user is Being removed By its Contact and Contact is Online
	OnReceiveFileRequest	When a Online Contact Wants to send a file then this event is fired
	OnRenameGroupCompleted	When IMSDK.IMClient.BeginRenameGroup Completes
	OnSearchUsersCompleted	When IMSDK.IMClient.BeginSearchUsers Completes
	OnSignupComplete	when IMSDK.IMClient.BeginSignUp completes
	OnTotalNumberOfFriendsExceeds	When value set by property IMSDK.IMClient.MAXFriends exceeds
	OnTotalNumberOfGroupsExceeds	When value set by property IMSDK.IMClient.MAXGroups exceeds
	OnTypingIndication	Signals that Friend is typing a message
	OnUserBlockByAdmin	This Event is raised only when user is blocked by the IM Server
	OnUsernameAlreadyExsist	On new registration [ IMSDK.IMClient.BeginSignUp ] this event is fired if the username is already taken
	OnUsernameOrPasswordInvalid	On Login [ IMSDK.IMClient.BeginLogin ] if username or password is invalid then this event is fired
	OnUserStatusChanged	When sub IMSDK.IMClient.BeginSetUserStatus Completes