C# Class ApiCore.Messages.MessagesFactory

Inheritance: ApiCore.BaseFactory
Afficher le fichier Open project: nolka/vkdotnet Class Usage Examples

Méthodes publiques

Свойство Type Description
HistoryMessagesCount int
IncomingMessagesCount int
OutgoingMessagesCount int

Méthodes publiques

Méthode Description
Delete ( int msg_id ) : bool

Delete personal message
Get ( MessageType type, MessageFilter filter, int offset, int count, int previewLen, int timeOffset ) : List

Gets the personal messages list
GetDialogs ( int offset, int count, int previewLen ) : List

Gets the dialogs
GetHistory ( int userId, int offset, int count ) : List

Gets the messages history
MarkAsNew ( string msg_ids ) : bool

Mark messages as UNREAD
MarkAsRead ( string msg_ids ) : bool

Mark messages as READ
MessagesFactory ( ApiCore.ApiManager manager ) : System
Restore ( int msg_id ) : bool

Restore deleted personal message
Search ( string query, int offset, int count ) : List

Search the messages by query mask
Send ( int userId, string message, string title, SendMessageType type ) : int

Send personal message

Private Methods

Méthode Description
buildMessagesList ( XmlDocument x, MessageType type ) : List

Method Details

Delete() public méthode

Delete personal message
public Delete ( int msg_id ) : bool
msg_id int message id to delete
Résultat bool

Get() public méthode

Gets the personal messages list
public Get ( MessageType type, MessageFilter filter, int offset, int count, int previewLen, int timeOffset ) : List
type MessageType type of messages: inbox or outbox
filter MessageFilter message filter. null allowed
offset int offset. null allowed
count int count messages to be returned. null allowed
previewLen int messages preview len. null allowed
timeOffset int messages time offset. null allowed
Résultat List

GetDialogs() public méthode

Gets the dialogs
public GetDialogs ( int offset, int count, int previewLen ) : List
offset int offset. null allowed
count int count messages to be returned. null allowed
previewLen int messages preview len. null allowed
Résultat List

GetHistory() public méthode

Gets the messages history
public GetHistory ( int userId, int offset, int count ) : List
userId int from user
offset int offset. null allowed
count int count messages to be returned. null allowed
Résultat List

MarkAsNew() public méthode

Mark messages as UNREAD
public MarkAsNew ( string msg_ids ) : bool
msg_ids string comma separated messages ids
Résultat bool

MarkAsRead() public méthode

Mark messages as READ
public MarkAsRead ( string msg_ids ) : bool
msg_ids string comma separated messages ids
Résultat bool

MessagesFactory() public méthode

public MessagesFactory ( ApiCore.ApiManager manager ) : System
manager ApiCore.ApiManager
Résultat System

Restore() public méthode

Restore deleted personal message
public Restore ( int msg_id ) : bool
msg_id int message id to restore
Résultat bool

Search() public méthode

Search the messages by query mask
public Search ( string query, int offset, int count ) : List
query string pattern to search
offset int offset. null allowed
count int count messages to be returned. null allowed
Résultat List

Send() public méthode

Send personal message
public Send ( int userId, string message, string title, SendMessageType type ) : int
userId int to user
message string message body
title string message title. null allowed
type SendMessageType message type. null allowed
Résultat int

Property Details

HistoryMessagesCount public_oe property

public int HistoryMessagesCount
Résultat int

IncomingMessagesCount public_oe property

public int IncomingMessagesCount
Résultat int

OutgoingMessagesCount public_oe property

public int OutgoingMessagesCount
Résultat int