C# Класс ApiCore.Messages.MessagesFactory

Наследование: ApiCore.BaseFactory
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
HistoryMessagesCount int
IncomingMessagesCount int
OutgoingMessagesCount int

Открытые методы

Метод Описание
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

Приватные методы

Метод Описание
buildMessagesList ( XmlDocument x, MessageType type ) : List

Описание методов

Delete() публичный Метод

Delete personal message
public Delete ( int msg_id ) : bool
msg_id int message id to delete
Результат bool

Get() публичный Метод

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
Результат List

GetDialogs() публичный Метод

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
Результат List

GetHistory() публичный Метод

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
Результат List

MarkAsNew() публичный Метод

Mark messages as UNREAD
public MarkAsNew ( string msg_ids ) : bool
msg_ids string comma separated messages ids
Результат bool

MarkAsRead() публичный Метод

Mark messages as READ
public MarkAsRead ( string msg_ids ) : bool
msg_ids string comma separated messages ids
Результат bool

MessagesFactory() публичный Метод

public MessagesFactory ( ApiCore.ApiManager manager ) : System
manager ApiCore.ApiManager
Результат System

Restore() публичный Метод

Restore deleted personal message
public Restore ( int msg_id ) : bool
msg_id int message id to restore
Результат bool

Search() публичный Метод

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
Результат List

Send() публичный Метод

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
Результат int

Описание свойств

HistoryMessagesCount публичное свойство

public int HistoryMessagesCount
Результат int

IncomingMessagesCount публичное свойство

public int IncomingMessagesCount
Результат int

OutgoingMessagesCount публичное свойство

public int OutgoingMessagesCount
Результат int