C# Class VkNet.Categories.MessagesCategory

Методы для работы с сообщениями.

Show file Open project: vknet/vk Class Usage Examples

Public Methods

Method	Description
AddChatUser ( long chatId, long userId ) : bool	Добавляет в мультидиалог нового пользователя. Страница документации ВКонтакте .
CreateChat ( IEnumerable userIds, [ title ) : long	Создаёт беседу с несколькими участниками. Страница документации ВКонтакте .
Delete ( IEnumerable messageIds ) : bool>.IDictionary	Удаляет сообщения пользователя. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
Delete ( ulong messageId ) : bool	Удаляет личное сообщение пользователя с заданным идентификатором. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
DeleteChatPhoto ( ulong &messageId, ulong chatId ) : Model.Chat	Позволяет удалить фотографию мультидиалога. Страница документации ВКонтакте .
DeleteDialog ( long userId, bool isChat, long peerId = null, uint offset = null, uint count = null ) : bool	Удаляет все личные сообщения в диалоге. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
EditChat ( long chatId, [ title ) : bool	Изменяет название беседы. Страница документации ВКонтакте .
GetChat ( long chatId, ProfileFields fields = null, NameCase nameCase = null ) : Model.Chat	Gets the chat.
GetChat ( IEnumerable chatIds, ProfileFields fields = null, NameCase nameCase = null ) : ReadOnlyCollection	Возвращает информацию о беседе. Страница документации ВКонтакте .
GetChatUsers ( IEnumerable chatIds, UsersFields fields, NameCase nameCase ) : ReadOnlyCollection	Позволяет получить список пользователей мультидиалога по его id. Страница документации ВКонтакте .
GetHistoryAttachments ( MessagesGetHistoryAttachmentsParams @params, string &nextFrom ) : ReadOnlyCollection	Возвращает материалы диалога или беседы.. Страница документации ВКонтакте .
GetLastActivity ( long userId ) : LastActivity	Возвращает текущий статус и дату последней активности указанного пользователя. Страница документации ВКонтакте .
GetLongPollHistory ( MessagesGetLongPollHistoryParams @params ) : LongPollHistoryResponse	Возвращает обновления в личных сообщениях пользователя. Для ускорения работы с личными сообщениями может быть полезно кешировать уже загруженные ранее сообщения на мобильном устройстве / ПК пользователя, чтобы не получать их повторно при каждом обращении. Этот метод помогает осуществить синхронизацию локальной копии списка сообщений с актуальной версией. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
MarkAsImportant ( IEnumerable messageIds, bool important = true ) : ReadOnlyCollection	Помечает сообщения как важные либо снимает отметку. Страница документации ВКонтакте .
MarkAsRead ( IEnumerable messageIds, string peerId, long startMessageId = null ) : bool	Помечает сообщения как прочитанные. Страница документации ВКонтакте .
MessagesCategory ( VkApi vk ) : System	Методы для работы с сообщениями.
RemoveChatUser ( long chatId, long userId ) : bool	Исключает из мультидиалога пользователя, если текущий пользователь был создателем беседы либо пригласил исключаемого пользователя. Страница документации ВКонтакте .
Restore ( ulong messageId ) : bool	Восстанавливает удаленное сообщение. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
Search ( [ query, long previewLength, long offset, long count ) : VkCollection	Возвращает список найденных личных сообщений текущего пользователя по введенной строке поиска. Страница документации ВКонтакте .
Send ( MessagesSendParams @params ) : long	Посылает личное сообщение. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
SendSticker ( MessagesSendStickerParams @params ) : long	Отправляет стикер. Страница документации ВКонтакте .
SetActivity ( long userId, long peerId = null ) : bool	Изменяет статус набора текста пользователем в диалоге. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .
SetChatPhoto ( long &messageId, string file ) : long	Позволяет установить фотографию мультидиалога, загруженную с помощью метода photos.getChatUploadServer. Страница документации ВКонтакте .

Private Methods

Method	Description
Get ( MessagesGetParams @params ) : MessagesGetObject
Get ( MessageType type, int &totalCount, uint count = 20, uint offset = null, System.TimeSpan timeOffset = null, MessagesFilter filter = null, uint previewLength, long lastMessageId = null ) : ReadOnlyCollection
GetById ( ulong messageId, uint previewLength = null ) : Message
GetById ( int &totalCount, [ messageIds, uint previewLength = null ) : ReadOnlyCollection
GetById ( [ messageIds, uint previewLength = null ) : VkCollection
GetChatUsers ( long chatId, UsersFields fields ) : ReadOnlyCollection
GetChatUsers ( long chatId ) : ReadOnlyCollection
GetDialogs ( MessagesDialogsGetParams @params ) : MessagesGetObject
GetDialogs ( int &totalCount, int &unreadCount, uint count = 20, int offset = null, bool unread = false, long startMessageId = null, uint previewLength = null ) : ReadOnlyCollection
GetHistory ( MessagesGetHistoryParams @params ) : MessagesGetObject
GetHistory ( int &totalCount, bool isChat, long id, int offset = null, uint count = 20, long startMessageId = null, bool inReverse = false ) : ReadOnlyCollection
GetLongPollServer ( bool useSsl = false, bool needPts = false ) : LongPollServerResponse
MarkAsNew ( IEnumerable messageIds ) : bool
MarkAsNew ( ulong messageId ) : bool
MarkAsRead ( IEnumerable messageIds ) : bool
MarkAsRead ( long messageId ) : bool
Search ( [ query, int &totalCount, int count = null, int offset = null ) : ReadOnlyCollection
Search ( int &totalCount, [ query, long previewLength, long offset, long count ) : ReadOnlyCollection
SearchDialogs ( string query, ProfileFields fields = null, uint limit = null ) : SearchDialogsResponse
Send ( long id, bool isChat, string message, string title = "", MediaAttachment attachment = null, IEnumerable forwardMessagedIds = null, bool fromChat = false, double latitude = null, double longitude = null, long randomId = null, long captchaSid = null, string captchaKey = null ) : long

Method Details

AddChatUser() public method

Добавляет в мультидиалог нового пользователя.

Страница документации ВКонтакте .

public AddChatUser ( long chatId, long userId ) : bool
chatId	long	Идентификатор беседы. положительное число, обязательный параметр (Положительное число, обязательный параметр).
userId	long	Идентификатор пользователя, которого необходимо включить в беседу. положительное число, обязательный параметр (Положительное число, обязательный параметр).
return	bool

CreateChat() public method

Создаёт беседу с несколькими участниками.

Страница документации ВКонтакте .

public CreateChat ( IEnumerable userIds, [ title ) : long
userIds	IEnumerable	Идентификаторы пользователей, которых нужно включить в мультидиалог. список положительных чисел, разделенных запятыми, обязательный параметр (Список положительных чисел, разделенных запятыми, обязательный параметр).
title	[	Название беседы. строка (Строка).
return	long

Delete() public method

Удаляет сообщения пользователя.

Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Messages. Страница документации ВКонтакте .

messageIds;Parameter messageIds can not be null. Parameter messageIds has no elements.;messageIds Элемент с таким ключом уже существует в словаре .

public Delete ( IEnumerable messageIds ) : bool>.IDictionary
messageIds	IEnumerable	Идентификаторы удаляемых сообщений.
return	bool>.IDictionary

Delete() public method

Удаляет личное сообщение пользователя с заданным идентификатором.

Свойство задано, и объект доступен только для чтения.

public Delete ( ulong messageId ) : bool
messageId	ulong	Идентификатор удаляемого сообщения.
return	bool

DeleteChatPhoto() public method

Позволяет удалить фотографию мультидиалога.

Страница документации ВКонтакте .

public DeleteChatPhoto ( ulong &messageId, ulong chatId ) : Model.Chat
messageId	ulong	Идентификатор отправленного системного сообщения;
chatId	ulong	Идентификатор беседы. положительное число, обязательный параметр (Положительное число, обязательный параметр).
return	Model.Chat

DeleteDialog() public method

Удаляет все личные сообщения в диалоге.

public DeleteDialog ( long userId, bool isChat, long peerId = null, uint offset = null, uint count = null ) : bool
userId	long	/// Если параметр равен false, то задает идентификатор пользователя, из диалога с которым необходимо удалить свои личные сообщения. /// Если параметр равен true, то задает идентификатор беседы, из которой необходимо удалить свои личные сообщения. ///
isChat	bool	Признак удаляются ли сообщения из беседы (true) или из диалога с указанным пользователем (false).
peerId	long	Идентификатор назначения. Для групповой беседы: 2000000000 + id беседы. Для сообщества: -id сообщества.
offset	uint	Смещение, начиная с которого нужно удалить переписку (по умолчанию удаляются все сообщения, /// начиная с первого).
count	uint	Как много сообщений нужно удалить. Обратите внимание что на метод наложено ограничение, за один вызов /// нельзя удалить больше 10000 сообщений, поэтому если сообщений в переписке больше - метод нужно вызывать несколько раз.
return	bool

EditChat() public method

Изменяет название беседы.

Страница документации ВКонтакте .

public EditChat ( long chatId, [ title ) : bool
chatId	long	Идентификатор беседы. целое число, обязательный параметр (Целое число, обязательный параметр).
title	[	Новое название для беседы. строка, обязательный параметр (Строка, обязательный параметр).
return	bool

GetChat() public method

Gets the chat.

public GetChat ( long chatId, ProfileFields fields = null, NameCase nameCase = null ) : Model.Chat
chatId	long	The chat identifier.
fields	ProfileFields	The fields.
nameCase	NameCase	The name case.
return	Model.Chat

GetChat() public method

Возвращает информацию о беседе.

Страница документации ВКонтакте .

At least one chat ID must be defined;chatIds

public GetChat ( IEnumerable chatIds, ProfileFields fields = null, NameCase nameCase = null ) : ReadOnlyCollection
chatIds	IEnumerable	Список идентификаторов бесед. список целых чисел, разделенных запятыми (Список целых чисел, разделенных запятыми).
fields	ProfileFields	Список дополнительных полей профилей, которые необходимо вернуть. /// Доступные значения: nickname, screen_name, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, counters, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities список строк, разделенных через запятую (Список строк, разделенных через запятую).
nameCase	NameCase	Падеж для склонения имени и фамилии пользователя. Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom. строка (Строка).
return	ReadOnlyCollection

GetChatUsers() public method

Позволяет получить список пользователей мультидиалога по его id.

Страница документации ВКонтакте .

public GetChatUsers ( IEnumerable chatIds, UsersFields fields, NameCase nameCase ) : ReadOnlyCollection
chatIds	IEnumerable	Идентификаторы бесед. список целых чисел, разделенных запятыми (Список целых чисел, разделенных запятыми).
fields	UsersFields	Список дополнительных полей профилей, которые необходимо вернуть. /// Доступные значения: nickname, screen_name, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, counters, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities список строк, разделенных через запятую (Список строк, разделенных через запятую).
nameCase	NameCase	Падеж для склонения имени и фамилии пользователя. Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom. строка (Строка).
return	ReadOnlyCollection

GetHistoryAttachments() public method

Возвращает материалы диалога или беседы..

Страница документации ВКонтакте .

public GetHistoryAttachments ( MessagesGetHistoryAttachmentsParams @params, string &nextFrom ) : ReadOnlyCollection
@params	MessagesGetHistoryAttachmentsParams
nextFrom	string	Новое значение start_from.
return	ReadOnlyCollection

GetLastActivity() public method

Возвращает текущий статус и дату последней активности указанного пользователя.

Страница документации ВКонтакте .

public GetLastActivity ( long userId ) : LastActivity
userId	long	Идентификатор пользователя, информацию о последней активности которого требуется получить. целое число, обязательный параметр (Целое число, обязательный параметр).
return	LastActivity

GetLongPollHistory() public method

Возвращает обновления в личных сообщениях пользователя. Для ускорения работы с личными сообщениями может быть полезно кешировать уже загруженные ранее сообщения на мобильном устройстве / ПК пользователя, чтобы не получать их повторно при каждом обращении. Этот метод помогает осуществить синхронизацию локальной копии списка сообщений с актуальной версией.

public GetLongPollHistory ( MessagesGetLongPollHistoryParams @params ) : LongPollHistoryResponse
@params	MessagesGetLongPollHistoryParams
return	LongPollHistoryResponse

MarkAsImportant() public method

Помечает сообщения как важные либо снимает отметку.

Страница документации ВКонтакте .

public MarkAsImportant ( IEnumerable messageIds, bool important = true ) : ReadOnlyCollection
messageIds	IEnumerable	Список идентификаторов сообщений, которые необходимо пометить.список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
important	bool	''1'', если сообщения необходимо пометить, как важные;''0'', если необходимо снять пометку.положительное число (Положительное число).
return	ReadOnlyCollection

MarkAsRead() public method

Помечает сообщения как прочитанные.

Страница документации ВКонтакте .

public MarkAsRead ( IEnumerable messageIds, string peerId, long startMessageId = null ) : bool
messageIds	IEnumerable	Идентификаторы сообщений. список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
peerId	string	Идентификатор чата или пользователя, если это диалог. строка (Строка).
startMessageId	long	При передаче этого параметра будут помечены как прочитанные все сообщения, начиная с данного. положительное число (Положительное число).
return	bool

MessagesCategory() public method

Методы для работы с сообщениями.

public MessagesCategory ( VkApi vk ) : System
vk	VkApi	API
return	System

RemoveChatUser() public method

Исключает из мультидиалога пользователя, если текущий пользователь был создателем беседы либо пригласил исключаемого пользователя.

Страница документации ВКонтакте .

public RemoveChatUser ( long chatId, long userId ) : bool
chatId	long	Идентификатор беседы. целое число, обязательный параметр (Целое число, обязательный параметр).
userId	long	Идентификатор пользователя, которого необходимо исключить из беседы. Может быть меньше нуля в случае, если пользователь приглашён по email. обязательный параметр (Обязательный параметр).
return	bool

Restore() public method

Восстанавливает удаленное сообщение.

public Restore ( ulong messageId ) : bool
messageId	ulong	Идентификатор сообщения, которое нужно восстановить.
return	bool

Search() public method

Возвращает список найденных личных сообщений текущего пользователя по введенной строке поиска.

Страница документации ВКонтакте .

Query can not be null or empty.;query

public Search ( [ query, long previewLength, long offset, long count ) : VkCollection
query	[	Подстрока, по которой будет производиться поиск.строка, обязательный параметр (Строка, обязательный параметр).
previewLength	long	Количество символов, по которому нужно обрезать сообщение. Укажите ''0'', если Вы не хотите обрезать сообщение. (по умолчанию сообщения не обрезаются).положительное число (Положительное число).
offset	long	Смещение, необходимое для выборки определенного подмножества сообщений из списка найденных.положительное число (Положительное число).
count	long	Количество сообщений, которое необходимо получить.положительное число, по умолчанию 20, максимальное значение 100 (Положительное число, по умолчанию 20, максимальное значение 100).
return	VkCollection

Send() public method

Посылает личное сообщение.

Message can not be null.

public Send ( MessagesSendParams @params ) : long
@params	MessagesSendParams
return	long

SendSticker() public method

Отправляет стикер.

Страница документации ВКонтакте .

public SendSticker ( MessagesSendStickerParams @params ) : long
@params	MessagesSendStickerParams
return	long

SetActivity() public method

Изменяет статус набора текста пользователем в диалоге.

public SetActivity ( long userId, long peerId = null ) : bool
userId	long	Идентификатор пользователя
peerId	long	Идентификатор назначения. Для групповой беседы: 2000000000 + id беседы. Для сообщества: -id сообщества.
return	bool

SetChatPhoto() public method

Позволяет установить фотографию мультидиалога, загруженную с помощью метода photos.getChatUploadServer.

Страница документации ВКонтакте .

public SetChatPhoto ( long &messageId, string file ) : long
messageId	long	Идентификатор отправленного системного сообщения;
file	string	Содержимое поля response из ответа специального upload сервера, полученного в результате загрузки изображения на адрес, полученный методом photos.getChatUploadServer. строка, обязательный параметр (Строка, обязательный параметр).
return	long