| 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 |
Specifies or retrieves information on a single instant message.
typedef struct _TRANSFER_MESSAGE_STRUCT { char lpszMessageKey[UNIQUE_KEY_LENGTH + 1]; BYTE iType; DWORD dwMessageFlags; char lpszSenderName[ACCOUNT_LENGTH + 1]; char lpszSenderFirstName[64 + 1]; char lpszSenderLastName[64 + 1]; char lpszRecipientName[ACCOUNT_LENGTH + 1]; char lpszTypeName[64 + 1]; BYTE lpszMessageText[MESSAGE_LENGTH + 1]; char lpszTextFont[32]; INT iTextSize; DWORD dwTextStyle; DWORD dwTextColor; char lpszOriginalDate[32]; } TRANSFER_MESSAGE_STRUCT;
Members
- lpszMessageKey
- Contains a unique message key. This member is filled if IServerClient::SendMessage method returns a success result or when new incoming message is received via NOTIFY_NEW_MESSAGE notification that is sent in the form of
WM_NOTIFY_SERVERmessage. This value can be used to identify each instant message in the application.- iType
- Specifies a type of the instant message. This member can be one of the following values:
MESSAGE_TYPE_USER- This instant message is personal message.
MESSAGE_TYPE_GROUP- This instant message is a group message.
MESSAGE_TYPE_NEWS- This instant message is a new message. Messages with such type can be only incoming message from the IM server.
- dwMessageFlags
- Array of bitwise flags that specify parameters of the message. This member can be one or more of the following values:
MESSAGE_FLAG_URGENT- Indicates high priority (urgent) message.
MESSAGE_FLAG_OFFLINE- Indicates that the message has been forwarded the IM server and was stored as offline. This flag can be set only for incoming messages.
MESSAGE_FLAG_CONFIRMATION- Indicates that the message requires recipient's confirmation.
- lpszSenderName
- Contains the sender's account name. For outgoing messages this member must contain current user's account name.
- lpszSenderFirstName
- Contains the sender's first name. This member is valid only for incoming personal and group messages.
- lpszSenderLastName
- Contains the sender's last name. This member is valid only for incoming personal and group messages.
- lpszRecipientName
- Contains the recipient's account name. This member is valid only for personal messages.
- lpszTypeName
- Contains group or news name. This member is valid only for group and news messages.
- lpszMessageText
- Contains a text of the instant message.
- lpszTextFont
- Contains a font family to display the text message. Set this member to
TEXT_FONT_FAMILY_DEFAULTto use default 'Arial'.- iTextSize
- Contains a font size to display the text message. Set this member to
TEXT_FONT_SIZE_DEFAULTto use default '-13' font size.- dwTextStyle
- Contains a style of the message font. This member can be one or more of the following bitwise flags:
TEXT_FONT_STYLE_BOLD- Indicates bold font.
TEXT_FONT_STYLE_ITALIC- Indicates italic font.
- dwTextColor
- Contains a font color to display the text message. Set this member to
TEXT_FONT_COLOR_DEFAULTto use default 'RGB(0, 0, 0)' font color.- lpszOriginalDate
- Contains original date when the message was initially sent. The date is stored in the "MM/dd/YYYY 00:00:00" format where MM — month, dd — day and YYYY indicates year. This member is valid only for incoming messages when the dwMessageFlags has the
MESSAGE_FLAG_OFFLINEflag.