VBMessageStruct structure

---

Specifies or retrieves information on a single instant message.

Public Structure VBMessageStruct
    Dim MessageKey As String
    Dim Type As Byte
    Dim MessageFlags As UInteger
    Dim SenderName As String
    Dim SenderFirstName As String
    Dim SenderLastName As String
    Dim RecipientName As String
    Dim TypeName As String
    Dim MessageText As String
    Dim TextFont As String
    Dim TextSize As Integer
    Dim TextStyle As UInteger
    Dim TextColor As UInteger
    Dim OriginalDate As String
End Structure

Members

MessageKey

Contains a unique message key. This member is filled if IServerClientVB::SendMessage method returns a success result or when new incoming message is received via NewMessage notification that is sent in the form of VBNotification.NOTIFY_SERVER_MESSAGE message. This value can be used to identify each instant message in the application.

Type

Specifies a type of the instant message. This member can be one of the following values:

VBMessageType.User

This instant message is personal message.

VBMessageType.Group

This instant message is a group message.

VBMessageType.News

This instant message is a new message. Messages with such type can be only incoming message from the IM server.

MessageFlags

Array of bitwise flags that specify parameters of the message. This member can include one or more of the following values:

VBMessageFlag.Urgent

Indicates high priority (urgent) message.

VBMessageFlag.AsOffline

Indicates that the message has been forwarded the IM server and was stored as offline. This flag can be set only for incoming messages.

VBMessageFlag.Confirmation

Indicates that the message requires recipient's confirmation.

SenderName

Contains the sender's account name. For outgoing messages this member must contain current user's account name.

SenderFirstName

Contains the sender's first name. This member is valid only for incoming personal and group messages.

SenderLastName

Contains the sender's last name. This member is valid only for incoming personal and group messages.

RecipientName

Contains the recipient's account name. This member is valid only for personal messages.

TypeName

Contains group or news name. This member is valid only for group and news messages.

MessageText

Contains a text of the instant message.

TextFont

Contains a font family to display the text message. Set this member to empty string ("" or String.Empty) for outgoing messages if you want to use Arial font by default. Otherwise specify any other font name present in the system. For example, Tahoma, Verdana, Times New Roman and others.

TextSize

Contains a font size to display the text message. Set this member to VBMessageFont.DefaultSize to use default (-13) font size.

TextStyle

Contains a style of the message font. This member can inclulde one or more of the following bitwise flags:

VBMessageFont.StyleBold

Indicates bold font.

VBMessageFont.StyleItalic

Indicates italic font.

TextColor

Contains a font color to display the text message. Set this member to VBMessageFont.DefaultColor to use default black font color (RGB(0, 0, 0) or 0 value).

OriginalDate

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 MessageFlags has the VBMessageFlag.AsOffline flag.