Getting Started |
Setup |
Visual C++ Developer's Guide |
Interfaces |
IServerClient |
Overview |
IServerClient::CloseSession |
IServerClient::CreateAccount |
IServerClient::DeclineFile |
IServerClient::EnumAvailableContacts |
IServerClient::EnumContactList |
IServerClient::EnumGroupContacts |
IServerClient::EnumGroups |
IServerClient::GetAccountInformation |
IServerClient::GetAccountStatus |
IServerClient::GetAvailableContacts |
IServerClient::GetContactList |
IServerClient::GetGroupContacts |
IServerClient::GetGroups |
IServerClient::GetEventDescription |
IServerClient::GetLicenseInformation |
IServerClient::GetSDKVersion |
IServerClient::GetServerVersion |
IServerClient::GetSessionKey |
IServerClient::Initialize |
IServerClient::ModifyAccount |
IServerClient::OpenSession |
IServerClient::ReceiveFile |
IServerClient::SaveAccount |
IServerClient::SendFile |
IServerClient::SendFileRequest |
IServerClient::SendMessage |
IServerClient::SendMessageTypingEvent |
IServerClient::SendMultipleMessage |
IServerClient::SetAccountPassword |
IServerClient::SetContactList |
IServerClient::TestConnection |
IServerClient::UpdateSession |
IServerClient::ViewAccount |
Structures |
Overview |
FILE_INFO_STRUCT |
FILE_NAME |
MULTIPLE_RECIPIENT_STRUCT |
NOTIFY_FILE_STATUS_STRUCT |
NOTIFY_FORWARD_ MULTIPLE_MESSAGE_STRUCT |
NOTIFY_GROUPS_STRUCT |
TRANSFER_ACCOUNT_STRUCT |
TRANSFER_CONTACT_LIST_STRUCT |
TRANSFER_CONTACT_STRUCT |
TRANSFER_FILE_STRUCT |
TRANSFER_GROUP_STRUCT |
TRANSFER_MESSAGE_STRUCT |
TRANSFER_MESSAGE_TYPING_EVENT_STRUCT |
TRANSFER_MULTIPLE_MESSAGE_STRUCT |
TRANSFER_NOTIFY_FILE_STRUCT |
TRANSFER_NOTIFY_GROUP_STRUCT |
TRANSFER_OU_STRUCT |
TRANSFER_STATUS_STRUCT |
Notifications |
Overview |
NOTIFY_ACCOUNT_PASSWORD_RESET |
NOTIFY_CONTACT_STATUS |
NOTIFY_CONTACTS_ADDED |
NOTIFY_CONTACTS_CHANGED |
NOTIFY_CONTACTS_NEEDS_TO_REBUILD |
NOTIFY_CONTACTS_REBUILT |
NOTIFY_FILE_STATUS |
NOTIFY_FORWARD_MESSAGE |
NOTIFY_FORWARD_MULTIPLE_MESSAGE |
NOTIFY_GROUP_ADDED |
NOTIFY_GROUP_ADDED_BY_USER |
NOTIFY_GROUP_CHANGED |
NOTIFY_GROUP_CHANGED_BY_USER |
NOTIFY_GROUP_REMOVED |
NOTIFY_GROUP_REMOVED_BY_USER |
NOTIFY_MESSAGE_TYPING_EVENT |
NOTIFY_NEW_MESSAGE |
NOTIFY_NEW_TRANSFER |
NOTIFY_SESSION_CLOSED |
NOTIFY_SESSION_CLOSED_AS_EXISTING |
NOTIFY_SESSION_PINGPONG |
Available Extended Codes |
VB.NET Developer's Guide |
Interfaces |
IServerClientVB |
Overview |
IServerClientVB::CloseSession |
IServerClientVB::CreateAccount |
IServerClientVB::EnumAvailableContacts |
IServerClientVB::EnumContactList |
IServerClientVB::EnumGroupContacts |
IServerClientVB::EnumGroups |
IServerClientVB::GetAccountInformation |
IServerClientVB::GetAccountStatus |
IServerClientVB::GetAvailableContacts |
IServerClientVB::GetContactList |
IServerClientVB::GetGroupContacts |
IServerClientVB::GetGroups |
IServerClientVB::GetEventDescription |
IServerClientVB::GetLicenseInformation |
IServerClientVB::GetSDKVersion |
IServerClientVB::GetServerVersion |
IServerClientVB::GetSessionKey |
IServerClientVB::Initialize |
IServerClientVB::ModifyAccount |
IServerClientVB::OpenSession |
IServerClientVB::SaveAccount |
IServerClientVB::SendMessage |
IServerClientVB::SendMessageTypingEvent |
IServerClientVB::SendMultipleMessage |
IServerClientVB::SetAccountPassword |
IServerClientVB::SetContactList |
IServerClientVB::TestConnection |
IServerClientVB::UpdateSession |
IServerClientVB::ViewAccount |
Structures |
Overview |
VBAccountStruct |
VBContactListStruct |
VBContactStruct |
VBGroupStruct |
VBMessageStruct |
VBMessageTypingStruct |
VBMultipleMessageStruct |
VBNotifyGroupStruct |
VBOuStruct |
VBRecipientStruct |
VBStatusStruct |
Notifications |
Overview |
AccountPasswordReset |
ContactStatus |
ContactListAdded |
ContactListChanged |
ContactListNeedsToBeRebuilt |
ContactListRebuilt |
GroupAdded |
GroupChanged |
GroupRemoved |
MessageTypingEvent |
NewMessage |
SessionClosed |
SessionClosedAsExisting |
SessionPingPong |
Available Extended Codes |
MS Office (VBA) Developer's Guide |
Interfaces |
IServerClientVBA |
Overview |
IServerClientVBA::CloseSession |
IServerClientVBA::CreateAccount |
IServerClientVBA::EnumAvailableContacts |
IServerClientVBA::EnumContactList |
IServerClientVBA::EnumGroupContacts |
IServerClientVBA::EnumGroups |
IServerClientVBA::GetAccountInformation |
IServerClientVBA::GetAccountStatus |
IServerClientVBA::GetAvailableContacts |
IServerClientVBA::GetContactList |
IServerClientVBA::GetEventDescription |
IServerClientVBA::GetGroupContacts |
IServerClientVBA::GetGroups |
IServerClientVBA::GetLicenseInformation |
IServerClientVBA::GetSDKVersion |
IServerClientVBA::GetServerVersion |
IServerClientVBA::GetSessionKey |
IServerClientVBA::Initialize |
IServerClientVBA::ModifyAccount |
IServerClientVBA::OpenSession |
IServerClientVBA::SaveAccount |
IServerClientVBA::SendMessage |
IServerClientVBA::SendMessageTypingEvent |
IServerClientVBA::SendMultipleMessage |
IServerClientVBA::SetAccountPassword |
IServerClientVBA::SetContactList |
IServerClientVBA::TestConnection |
IServerClientVBA::UpdateSession |
IServerClientVBA::ViewAccount |
Types |
Overview |
AccountStruct |
ContactListStruct |
ContactStruct |
GroupStruct |
MessageStruct |
MessageTypingStruct |
MultipleMessageStruct |
NotifyGroupStruct |
OuStruct |
RecipientStruct |
StatusStruct |
Notifications |
Overview |
AccountPasswordReset |
ContactListAdded |
ContactListChanged |
ContactListNeedsToBeRebuilt |
ContactListRebuilt |
ContactStatus |
GroupAdded |
GroupChanged |
GroupRemoved |
MessageTypingEvent |
NewMessage |
SessionClosed |
SessionClosedAsExisting |
SessionPingPong |
Available Extended Codes |
About |
The IServerClient interface implements all functionality used to establish connection to the IM server, send and receive instant messages, receive lists of contacts and assigned groups from the communication server, view and modify user's account information, etc. This interface is designed primarily for Microsoft Visual C/C++ programmers because it operates standard C++ variables and data types.
Methods
Initialize | Initializes IServerClient class. Must be called prior other functions of the interface. |
OpenSession | Establishes session with the IM server. |
UpdateSession | Changes/updates presence status of the established session. |
CloseSession | Closes established session. |
GetGroups | Gets a list of assigned groups into internal buffer. |
EnumGroups | Retrieves a list of received groups after successful GetGroups function call. |
GetGroupContacts | Gets a list of users assigned to specific group. |
EnumGroupContacts | Retrieves a list of group users after successful GetGroupContacts function call. |
GetAvailableContacts | Gets a list of contacts available to current user. |
EnumAvailableContacts | Retrieves a list of received contacts after successful GetAvailableContacts function call. |
GetContactList | Gets a list of contacts saved by current user. |
EnumContactList | Retrieves a list of received contacts after successful GetContactList function call. |
SetContactList | Stores current user's Contact List. |
CreateAccount | Creates a new user account on the IM server. |
ModifyAccount | Retrieves current user account for modification. |
SaveAccount | Changes current user account information. |
ViewAccount | Gets account information for specific user. |
SetAccountPassword | Sets a new password for current user. |
SendMessage | Sends instant message to a user or group. |
SendMultipleMessage | Sends instant message to several users and/or groups. |
SendMessageTypingEvent | Sends a message typing instant notification to a remote user. |
SendFile | Sends files to single or multiple recipients. This method must be called only after successful call of SendFileRequest. |
SendFileRequest | Sends a request to the IM server prior a file transfer process to obtain a possibility to send the data and to resolve a presence status of the recipients. |
ReceiveFile | Receives incoming file data. |
DeclineFile | Declines incoming file transfer. |
GetAccountInformation | Retrieves current user's first and last names within account flags. |
GetAccountStatus | Retrieves a presence status for specific user. |
GetLicenseInformaion | Gets information about current software license on the IM server. |
GetServerVersion | Retrieves current version of the IM server. |
GetSessionKey | Retrieves current estashlished session GUID. |
GetEventDescription | Retrieves extended information on given error code. |
GetSDKVersion | Gets version of IM SDK. |
TestConnection | Checks a given address of the IM server. |